|
g_cdfDataId
|
The database object that represents the CDF description for the component.
|
|
?name t_name
|
The name of the parameter.
|
|
?type t_type
|
The data type of the parameter.
|
|
?defValue g_defValue
|
The default value of the parameter.
|
|
?units t_units
|
The unit suffix and scale factor to use when displaying the parameter value.
|
|
?parseAsNumber t_parseAsNumber
|
|
|
Specifies whether the parameter can be evaluated to a floating-point number. Use this attribute only for string type parameters that contain numeric data.
If t_parseAsNumber is yes, string is converted to a floating-point number, which is then converted the most efficient notation for execution, and then reconverts the floating-point number into a string.
If t_parseAsNumber is no (the default value) or don't use, the system does no conversion. Use this setting if the parameter to be defined is a literal that contains numeric characters, such as the name of a file or a model.
t_parseAsNumber must be used when the value of t_parseAsCEL is yes.
|
|
?choices l_choices
|
The space- or comma-separated list of selections for a cyclic or radio data type. This attribute does not apply to other types of parameters.
The choices depend on the following two cases:
-
If each choice is a single word, you can separate the choices with spaces.
-
If any choice is a group of words, you must separate each choice with a comma (,). (When using commas, do not leave extra spaces between choices because these spaces become part of the choice value.)
A typical entry in the form field can be
choice 1,choice 2,choice 3
Notice that there is no space between the number 1 and the comma, or between the comma and the c in choice.
|
|
?prompt t_prompt
|
The name for the CDF parameter that is displayed on the Add Instance or the Edit Object Properties form.
|
|
?use t_use
|
Determines if the parameter is to be used. You can enter Cadence SKILL language expression that evaluates to t or nil in this field to determine if this parameter is applicable. When the field evaluates to nil, the system never displays the parameter. When it evaluates to non-nil (the default), then based on the value of t_display, the system displays the parameter.
|
|
?display t_display
|
Determines if this parameter is displayed in forms that display CDF parameters, such as the Edit Object Properties form or the Add Instance form. You must enter t, nil, or a SKILL expression that evaluates to t or nil in this field to determine if this parameter is to be displayed. If the field evaluates to non-nil (the default), the parameter is displayed. If the field evaluates to nil, the parameter is not displayed.
|
|
?editable t_editable
|
Determines if this parameter can be edited in forms that display CDF parameters, such as the Edit Object Properties form or the Add Instance form. In this field, you can enter a SKILL expression that evaluates to t or nil in this field to determine if the parameter is editable. If the field evaluates to non-nil (the default), the parameter is editable. If the field evaluates to nil, the parameter is not editable. (If not editable, the parameter is grayed so that you can see the value but you cannot edit it.) This field is valid only for string, int, and float data types.
|
|
?dontSave t_dontSave
|
Determines if the parameter value is to be saved on the instance. This attribute is for programming use only. Typically, you should set this field to nil and not use it. If the field evaluates to nil (the default), the parameter value is saved as a property on the instance. If the field evaluates to non-nil, the parameter value is not saved as a property on the instance.
|
|
?callback t_callback
|
Specifies a SKILL routine to be executed whenever the value of the parameter changes. The value of this optional field must be a string. The entered value can be an entire function to be executed or a call to a function that is defined elsewhere. If you do not enter anything in this field, the system assumes that there is no callback.
The CDF parameter callback is primarily a GUI-based callback. GUI-based callbacks occur when you modify the values in the parameter form fields. A GUI-based callback is active when the CDF parameters are displayed in the Add Instance form or the Edit Object Properties form if you use the Create Instance or Edit Properties commands.
|
|
?storeDefault t_storeDefault
|
|
|
Specifies whether to store the default value of a parameter as a parameter attribute on the instance. All tools based on the Cadence Virtuoso Analog Design software use the CDF description to find default values if there is no property on an instance.
If set to no or don't use, the default value that you set for a parameter is not preserved. In this case, if you modify the default value of a parameter, the change is reflected in all the existing instances and new instances of the component.
When the default value of the CDF parameter changes, all the instances including the ones already instantiated are updated with the new default value of the CDF parameter. To see the change in an open window, you must choose View – Redraw.
If set to yes, a parameter attribute that stores the default value of the parameter is added on the instance. Later if the default value for the parameter is modified, the instances that are already instantiated retain the old default value of the parameter. Only new instantiations have the new default value of the parameter.
One disadvantage of setting this attribute to yes is that if the default value of a parameter changes, the existing instances that use the default value do not automatically change to the new default value. That is, they retain the old default value.
Default value: no
|
|
?parseAsCEL t_parseAsCEL
|
|
|
Specifies whether the parameter is processed as a CDF Expression Language (CEL) expression. Use this attribute only for string type parameters.
If t_parseAsCEL is yes, the parameter is processed as a CEL expression. (Expressions such as iPar(x) or pPar(x), indicating inheritance from an instance parameter or a parent parameter, are processed as CEL expressions.)
If t_parseAsCEL is no (the default), the parameter is not processed as a CEL expression.
|
|
?description t_description
|
|
|
Lets you specify a tooltip or description for each parameter. The text specified as description will be displayed on the Edit Object Properties and, Create Instance form, and the Property Editor assistant.
|
