Operator IntParamSelector

Operator Library: Parameters

This operator generates a map parameter in the parameter Value. You can switch this map parameter between several module parameters located anywhere in the design via the parameter Select. To specify path and name of the referenced parameters, add a list separated by semicolon in the parameter References.

[Important] Availability

To use the IntParamSelector operator, you need either an Expert license, a Parameter Module license, or the VisualApplets 4 license.

The referenced parameters can be of one of the three following types:

  • VA_SINT: signed integer like the parameter Value in the operator CONST.

  • VA_UINT: unsigned integer like the parameter ScaleFactor in the operator SCALE.

  • VA_ENUM: enumeration like the parameter mode in the operator SetSignalStatus.

The map parameter itself is always of type Int64. The map parameter mirrors all properties of the currently selected referenced parameter.

If you want to reference an unsigned parameter that uses the full 64 bit, a re-interpretation of the value according to type Int64 is necessary.

You can define a target within the design hierarchy where the selected parameter will be visible and accessible. The target is defined by two parameters: DisplayHierarchy and DisplayName. In DisplayHierarchy you address a hierarchical box within the same process the reference operator itself is located in. In parameter DisplayName you set up the name for the target parameter. This means:

  • If DisplayHierarchy and DisplayName are both set, the parameter defined by DisplayName is available in the hierarchical box addressed by DisplayHierarchy.
  • If DisplayName is empty, no parameter is created.
  • If DisplayName is set, but DisplayHierarchy is empty, the parameter defined by DisplayName is added to the parent hierarchy (i.e. the hierarchical box the reference operator itself is located in).

This allows you to make the selected parameter available on any hierarchical level of the design you want. For example, you can make the parameters of modules within a protected hierarchical box available for parametrization directly under the properties of the protected hierarchical box itself.

Mapped parameters can be referenced themselves. Thus, you can reference either the content of the parameter Value in a reference operator, or reference the parameter you have defined in the parameters DisplayName and DisplayHierarchy. This is especially important when protected hierarchical boxes are built up out of other protected hierarchical boxes.

[Note] All connected parameters update at once

If one of the connected parameters is changed (i.e. the selected parameter, the map parameter Value, or the display target parameter), the value is changed in all other connected parameters, too.

The operator has no inputs and outputs, as it doesn't interfere with the data flow structure of the design.

You find a general introduction into the library Parameters in Library Parameters.

I/O Properties

Property Value
Operator Type None, since there are no inputs or outputs

Supported Link Format

None

Parameters

Status
Type static read (although the GUI displays write) parameter
Default None
Range OK or an error message occurs

Displays the error status. If the parameter Activate is set to Yes, the other module parameters are checked. This parameter displays the result of this check, i.e., either OK or an error message occurs.

This parameter is not part of the final applet.

DisplayName
Type static write parameter
Default None
Range Any string

If you want to grant access from and to the referenced parameter defined in the parameter Reference at another point in the design in addition to the reference operator instance itself, you need to define a new parameter. Specify here the name of this new parameter. If this field is empty, no new parameter is created.

DisplayHierarchy
Type static write parameter
Default None
Range Any string

Specify here the hierarchical box to which you want to attach the new map parameter you defined in the parameter DisplayName.

For this parameter, you can use the autocompletion functionality and syntax highlighting. To use autocompletion, click into the Parameter Values field of this parameter in the Module Properties dialog, and press the TAB key of your keyboard. More detailed instructions for the autocompletion functionality are available at 'Autocompletion and Syntax Highlighting for Translator and Reference Operators'.

If you define a new parameter DisplayName, but leave the parameter DisplayHierarchy empty, the new parameter is added to the hierarchical box that contains the reference operator instance. If the reference operator instance is located on the highest process level, this is not possible.

[Note] Syntax for setting up the path to the display target

If you want the new parameter to show up in another place of the design, you need to specify the path to the hierarchical box that is to contain the new parameter in the parameter DisplayHierarchy.

The syntax is as follows:

<Path> is the relative path from process level to the hierarchical level of the design where the <Hierarchical Box> is located that is to receive the new parameter. Thus, the parameter DisplayHierarchy can only address hierarchical boxes within the same process. Use a slash as separator between different hierarchical levels.

<HierarchicalBox> is the name of the hierarchical box that is to receive the new map parameter.

Example: Level0/Level1

Select
Type static, dynamic, write parameter
Default 0
Range Depends on the number of referenced parameters

Selector for switching between the referenced parameters.

Value
Type static, dynamic, write, read parameter
Default 0
Range Signed integer (64 bit), unsigned integer (64 bit)

Map parameter for access from and to the selected parameter. This parameter has the same properties as the currently selected referenced parameter.

Unit
Type static write parameter
Default -
Range Latin-1

Enter here the unit for the parameter Value.

Description
Type static write parameter
Default -
Range Any text

Enter here the description for the parameter Value.

References
Type static write parameter
Default None
Range String defining the referenced parameters in a list separated by semicolon: relative path to module, module name, and parameter name.

Here, you define the position of the referenced parameters within the design.

[Note] Syntax for referencing

For this parameter, you can use the autocompletion functionality and syntax highlighting. To use autocompletion, click into the Parameter Values field of this parameter in the Module Properties dialog, and press the TAB key of your keyboard. More detailed instructions for the autocompletion functionality are available at 'Autocompletion and Syntax Highlighting for Translator and Reference Operators'.

The syntax for an item in the string list is as follows:

<Path> is the relative path to the hierarchical level where the referenced module <Module> is located. Use a slash as separator between different hierarchical levels. Define the path as relative path from the hierarchical level the reference operator instance is located in.

<Module> is the name of the module (i.e. an operator instance or a hierarchical box) that contains the referenced parameter.

<ParamName> is the name of the referenced parameter.

If <Path> starts with a slash, the path is interpreted as absolute path starting from design level (e.g., /Process0/UUT/SetParam.Value).

You can also use ../ to go up a level. However, take care you don't use this option when designing freely replicable or relocatable modules.

Activate
Type dynamic write parameter
Default No
Range {No, Yes}

Yes = Access to and from the referenced parameter (via the map parameter Value) is activated.

No = Access to and from the referenced parameter is de-activated and the parameter Status is disabled. The parameters DisplayName and DisplayHierarchy have no effect.

Examples of Use

The use of operator IntParamSelector is shown in the following examples:

  • 'Parameter Selection'

    Examples - Demonstration of how to use the parameter translation operators IntParamSelector and FloatParamSelector.

  Prev     Level Up     Next  
Content Top Home