o_tool

Simulation tool object

?name s_name

Name of the simulator option you want to change.

?prompt t_prompt

Optional argument that specifies the prompt (on the UI form) for the given option.

Default Value: s_name

?type s_type

Type of the option.

Valid Values: string, integer, float, toggle, cyclic, radio, Boolean, list, radioToggle, listBox, fileName (string type for file names only), label (for the label on the form), frame (for a graphic frame around a field), separator (for the separator line on the form), button (for a button on the form), scale (for a slider field on the form)

Default Value: string

?choices l_choices

List of choices if s_type is cyclic, radio, radioToggle or listBox, or the list of switches if s_type is toggle. This argument is valid only if s_type is cyclic, toggle , radio , radioToggle , or listBox.

?itemsPerRows x_itemsPerRow

Numbers of choices per row for radio, cyclic, toggle, and radioToggle fields.

Default Value: Total number of choices specified in l_choices

?value g_value

Default value of the option.

?min g_min

Specifies the minimum value of an integer, float, or scale option.

Default Value: nil, which means -infinity

?max g_max

Specifies the maximum value of an integer, float, or scale option.

Default Value: nil , which means +infinity

?allowExpr s_allowExpr

Specifies whether g_value can contain expressions.

Valid Values: t (value can contain expressions), nil (value cannot contain expressions)

Default Value: nil

?row x_row

Row in the form where the field appears. This argument is valid only for ’twoD type forms.

?column x_column

Column in the form where the field appears. The fields are created according to their required widths and are not meant to align with fields in other rows of the form. This argument is valid only for ’twoD type forms.

?width x_width

Specifies the width of the field in relation to other fields on the form. Numbers that you enter for this argument are relative values whose values are determined by the amount of space available. For example, assume there are three fields for a row that is 400 pixels wide. If the first two fields have an x_width of 1, and the last field has an x_width of 2, then the widths for the fields are as follows: 100, 100, and 200 pixels. This argument is valid only for ’twoD type forms.

Default Value: 1

?coordinates l_coordinates

List specifying the coordinates for the field on the UI form. (The format is the same as for the corresponding hi field.) This argument is valid only for ’custom type forms.

?displayOrder x_displayOrder

Position (from the top) of the option in the form. Use x_displayOrder to reposition your options in an inherited form. By default, the options appear in the order defined; therefore, inherited options appear first.

The value of x_displayOrder must be an integer that specifies the position you want relative to the top of the form. If more than one option has the same display order integer, the last option found (yours) takes precedence. The remaining options shift down on the form. This argument is valid only for 'oneD type forms.

Valid Values: Any integer

?labelText t_labelText

Optional label displayed with frame type fields.

Default Value: nil

?private s_private

Optional argument that declares an option as private, which means the option is not visible to the user. Private options are not part of the UI and their values are not saved when a user saves the environment. You might use this argument for values that are constant for all users of the software. Valid Values: t (option does not appear in the UI), nil (option appears in the UI)

Default Value: nil

?display s_display

Specifies an expression that determines whether the field is to be displayed on the UI form. This expression is evaluated when the form is first displayed and whenever a callback is executed on any field in the form.

Default Value: t

?editable s_editable

Specifies an expression that determines whether the field is to be editable on the UI form. This expression is evaluated when the form is first displayed and whenever a callback is executed on any field in the form.

Default Value: t

?appCB s_appCB

Specifies a callback function that is executed when the value of the option is changed.

Callback parameter list: (o_session )

?callback t_callback

Specifies a callback function that is executed when a field is changed on the form while the form is displayed. (You can use this function to do error checking on the value entered by the designer.)

?formApplyCB s_formApplyCB

Specifies a callback function that is executed when the designer clicks on Apply or OK on the form containing the associated field.

Callback parameter list: (o_session r_form r_field )

?changeCB st_changeCB

Specifies a callback function that is executed when the value of a listBox type field is changed on the form.

?doubleClickCB st_doubleClickCB

Specifies a callback function that is executed when a designer double clicks on a listBox type field.

?numRows x_numRows

Number of rows shown on the form for a listBox type field.

?multipleSelect s_multipleSelect

Boolean flag that specifies whether multiple items can be selected from the listBox type field.

Valid Values: t (multiple items can be selected), nil (only one item can be selected at a time)

?invalidateFunc s_invalidateFunc

Specifies a function that is executed when the value of the option is changed. This function invalidates a step in the flowchart.

Callback parameter list: (o_session )

?genericName s_genericName

Specifies the name of the generic variable that the option represents. This argument applies to temperature options only.

Valid Values: temperature specifies that the option represents the temperature for the simulator, nominalTemp specifies that the option represents the nominal temperature for the simulator

?sendMethod s_sendMethod

Specifies how simulator options are sent to Cadence SPICE. (Use this argument only if your simulator is in the SPICE Socket.)

Valid Values:

• set: Specifies options known by Cadence SPICE (for example, tempdc and dcoppt).
• ptprop: Specifies numbers.
• psprop: Specifies strings.

Default Value: ptprop

o_envVar

Returns the changed simulator option object.

nil

Returns an error message and nil if unsuccessful.