Parameters Context Menu - Sequence File Window

Parameters Context Menu

To access the context menu, right-click the Parameters item on the Variables pane. The items in the context menu vary depending on whether you right-click a parameter or parameter subproperty.

The Parameters context menu can contain the following items:

  • Insert Parameter —A submenu from which you select the data type for the parameter you want to insert. If you want to insert a parameter with a custom data type , you must create a named data type. You can create a named data type in the Types window. After you create the named data type, it appears in the Type submenu of the Insert Parameter submenu. If you insert an array, the Array Bounds dialog box launches.
  • Cut —Removes the selected parameter or subproperty and places it on the clipboard.
  • Copy —Copies the selected parameter or subproperty to the clipboard.
  • Paste —Inserts the parameter or subproperty from the clipboard.
  • Delete —Deletes the parameter.
  • Copy Value —Copies the value of the selected property to the clipboard.
  • Rename —Displays a control for renaming the selected parameter or subproperty.
  • Pass By Reference —The parameter is a reference to the argument the calling sequence passes to the parameter. Passing a parameter by reference allows the subsequence to change the actual value of the argument in the calling sequence. When you disable this option for a parameter, TestStand copies the argument value the calling sequence passes as the parameter. This prevents the subsequence from changing the value of the argument in the calling sequence. Copying a large object or array you pass as a parameter can degrade performance. Enable this option when you want to return a value from a subsequence to the calling sequence or to reduce the time it takes to pass a large object or array to a subsequence. Disable the option when you want to guarantee that any changes a subsequence makes to a parameter do not affect the argument in the calling sequence.
    Note Do not pass a parameter by reference to a subsequence you call in a separate thread unless you want the new thread to see changes you make to the variable in the calling sequence after the sequence call returns.
  • Check Type —TestStand verifies that the data type and representation of the argument you pass as a parameter is compatible with the data type and representation of the parameter. For example, TestStand reports a run-time error when you set this option for a String parameter and then pass a numeric value instead. Although type checking is usually a fast operation, you can disable this option when you want to avoid any possible overhead. You can also disable this option when you want to pass arguments with different types or representations in the same parameter field for calls. To pass arguments in this way, specify Container as the data type for the parameter and disable the Check Type option. You can use the PropertyExists expression function to determine whether the argument a calling sequence passes to the container parameter contains a particular subproperty.
  • Advanced —Launches a submenu that contains the following options:
    • Edit Flags —Launches the Edit Flags dialog box, in which you can modify the flags for the parameter or subproperty.
    • Edit Attributes —Launches the Attributes dialog box, in which you can create and edit attributes for the parameter or subproperty.
  • Numeric Format —Launches the Numeric Format dialog box, in which you can specify the format TestStand uses to display the value of a numeric property. This control is available only for numeric properties and numeric array properties.
  • Representation —The numeric data type standard to use for a number variable or parameter.
    • Double-Precision 64-bit Floating Point (default) —Specifies double-precision, 64-bit floating-point representation.
    • Signed 64-bit Integer —Specifies signed 64-bit integer representation.
    • Unsigned 64-bit Integer —Specifies unsigned 64-bit integer representation.
  • View —Lists the available panes or windows for a sequence file. These commands are available only when a Sequence File window is active.
    • Steps —Displays the Steps pane where you edit the steps in the Setup, Main, and Cleanup step groups for the sequence file.
    • Sequences —Displays the Sequences pane where you edit the sequences in the sequence file.
    • Variables —Displays the Variables pane where you edit the locals, parameters, and file globals for the sequence file and station globals.
    • Types —Displays the Types window where you can edit step types, custom data types, and built-in data types. The TestStand Sequence Editor selects the active sequence file in the Type Palettes window.

See Also

Array Bounds dialog box

Attributes dialog box

Edit Flags dialog box

Numeric Format dialog box

Sequences Pane

Steps Pane

Types Window

Variables Pane