SynaptiCAD Tutorials

(TD) 3.2 Parameter Display Strings

(TD) 3.2 Parameter Display Strings

Previous topic Next topic  

(TD) 3.2 Parameter Display Strings

Previous topic Next topic  

A Delay, Setup, Hold, or Sample parameter can display any of its attributes like name, times, distances,  margin, comment string or any combination of attributes. A parameter's display is controlled by the the Display Label and Custom String boxes in the Parameter Properties dialog. Even though all parameters have these features, usually Setups and Holds are used for diagram annotation and distance measurements, because these parameters monitor state information instead of forcing edges like delay parameters. In this section, we will edit the three parameters in the diagram and write some custom strings.

Display anything using a Parameter Custom Strings

A parameter label can be made to show more than one attribute or to show a custom string of characters and attributes using the Custom string in the Parameter Properties dialog.

Double click on D0 delay parameter to open the Parameter Properties dialog.

Select Custom from the Display Label drop-down list box. This will cause the string in the Custom edit box to be displayed as the parameter's label. The default custom string is a little messy to look at, however it contains all of the control codes so you don't have to remember them. When you want to make a custom label just edit the default string.

D0_custom_default

Compare the default Custom string to the label that is displayed in the diagram. The default custom string should be:

%n v= %mv,%Mv f=%mf,%Mf m=%mm,%Mm d=%md,%Md %c 

Notice the codes that start with a % character followed by one or two letters are replaced in the label and all other text is just shown. The control codes are: name (%n), value (%mv, %Mv), formula (%mf, %Mf), margin (%mm, %Mm), distance (%md, %Md), and comment (%c). The lower case m means minimum, and the upper case M means maximum. The example parameter D0 is a delay, so the margin control codes %mm and %Mm are blank. Also since there is no "comment" for D0 it is also blank.

Next, make the parameter label display only the parameter name and min and max values. Edit the contents of the custom string so that the string reads:

%n value = %mv,%Mv

Press the Apply button and D0’s label will show. (LEAVE THE DIALOG OPEN).

D0_custom

Display Margin times using a Setup or Hold:

There are also several default display labels that you can quickly use to display an attribute.

Double-click on the setup label S0 to open the Parameter Properties dialog. Arrange the dialog so that you can see the S0 in the diagram window and the dialog at the same time.

Use the Display Label drop-down list box to select the min/max Margin display. Notice that the label for the parameter now displays [9,], the min/max margin, instead of the name S0. This display will change if the setup’s edges are moved. The max is blank because there is no maximum setup time specified in the parameter.

S0_margin

If you do not want to display the maximum then you can create your own custom string. Here the code %mm will be replaced by the minimum margin time and all other text will be output as typed. (LEAVE THE DIALOG OPEN).

S0_margin_custom

Display Distance measurements using a Setup or Hold:

Click the Next button to display the setup S1 in the Parameter Properties dialog. We will just use S1 to display the distance between two edges, so we have not bothered to define min and max values for it.

Check Outward Arrows so that the parameter’s arrows display the type of arrows that are usually used for distance measurements.

Select the Distance from the Display Label drop-down list box. The label now shows the minimum and maximum distances between the transitions.

This can also be achieved using a Custom string <%dm, %dM> as shown in the previous example.

Press Ok to close the dialog.

S1_distance

diagram2-DisplayAndDocumentation-DelayDisplay

Miscellaneous Parameter Information:

The default display for all parameters can be set using the Options > Drawing Preferences dialog box. Also individual instances or all instances of a parameter are configured depending on where the Parameter Properties dialog is opened. To edit an individual instance, double click on a parameter in the Diagram window. To configure all instances of a parameter, double click on a parameter row in the Parameter window.