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.
Availability | |
---|---|
To use the FloatParamSelector operator, you need either an Expert license, a Parameter Module license, or the VisualApplets 4 license. |
The referenced parameters must be of type VA_DOUBLE. The map parameter mirrors all properties of the currently selected referenced parameter.
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 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.
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.
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. 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.
|
Select | |
---|---|
Type | static, dynamic, write parameter |
Default | 0 |
Range | Depends on number of referenced parameters |
Selector for switching between the referenced parameters. |
Value | |
---|---|
Type | static, dynamic, write, read parameter |
Default | 0 |
Range | double |
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.
|
Activate | |
---|---|
Type | dynamic write parameter |
Default | No |
Range | {No, Yes} |
Yes = Access to and from referenced parameter (via map parameter Value) is activated. No = Access to and from referenced parameter is de-activated and the parameter Status is disabled. The parameters DisplayName and DisplayHierarchy have no effect. |
The use of operator FloatParamSelector is shown in the following examples:
-
Examples - Demonstration of how to use the parameter translation operators IntParamSelector and FloatParamSelector.