relxAddReliabilityOption
relxAddReliabilityOption (
t_toolName
[ ?name t_name ]
[ ?value t_value ]
[ ?type t_type ]
[ ?mode t_mode ]
[ ?enabled g_enabled ]
[ ?prompt t_prompt ]
[ ?display g_display ]
[ ?choices l_choices ]
[ ?callback g_callback ]
[ ?formApplyCB g_formApplyCB ]
[ ?page t_page ]
[ ?coordinates l_coordinates ]
[ ?private g_private ]
)
=> t_relVar / nil
Description
Adds a variable to the specified Reliability tool.
Arguments
|
t_toolName
|
Name of the Reliability tool to which you want to add the variable.
|
|
?name t_name
|
Name of the variable to be added.
|
|
?value t_value
|
Value of the variable according to the type of the variable.
|
|
?type t_type
|
Type of the variable to be added.
Default value: string.
Possible values: radio, Boolean, separator, label, cyclic, string, toggle, or button.
|
|
?mode t_mode
|
Specifies the file in which the specified variable is to be added.
Possible values: existingFile or anyFile.
|
|
?enabled g_enabled
|
Enables or disables the variable. When set to t, the variable is enabled, When set to nil, the variable is disabled and becomes inactive in the form.
|
|
?prompt t_prompt
|
Description to be displayed on the form.
|
|
?display g_display
|
Controls the display of variable on the form. If this argument is set to nil, the variable is not displayed on the form.
|
|
?choices t_choices
|
List of choices, if the variable has multiple choices of values.
|
|
?callback g_callback
|
Calls the callback function when the value of the variable is changed.
|
|
?formApplyCB g_formApplyCB
|
|
|
Calls the formApplyCB function set when a button, such as OK, Apply, and so on, is clicked.
|
|
?page t_page
|
If the form includes multiple pages, specify the page where the variable is to be added.
|
|
?coordinates l_coordinates
|
|
|
Specifies the coordinates on the Reliability form where the variable is to be added. The coordinates are specified as: list(x:y width:height labelWidth).
|
|
?private g_private
|
Boolean that indicates whether the variable is private and not to be included in netlist. If set to t, the variable is not included in the netlist. The default value of this argument is nil, which means that the variable is netlisted by default.
|
Value Returned
|
t_relVar
|
For the specified analog tool, the function returns the variable object.
|
|
nil
|
For any other tool, return value is nil.
|
Examples
In the example given below, the function adds a variable, test2, of type radio on the Reliability form with the following argument values:
relxAddReliabilityOption (
tool
?name 'test2
?type 'radio
?prompt "Test2 Mode"
?display 'FuncGetDisplay(hiGetCurrentForm())
?choices list( "mode1" "mode2" )
?enabled 'FuncEnable( hiGetCurrentForm() )
?callback "TestModeCB()"
?formApplyCB 'TestModeAppCB
?value "mode1"
?page"Basic"
?coordinates list( xOrig:yCoor+delta fieldWidth:delta labelWidth )
?private nil
)
Return to top
