Operator Library: Parameters
Operator FloatVariable generates a software variable.
Availability | |
---|---|
To use the FloatVariable operator, you need either an Expert license, a Parameter Module license, or the VisualApplets 4 license. |
You can define a target within the design hierarchy where the variable 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 operator itself is located in. In parameter DisplayName you set up the name for the target parameter. If DisplayHierarchy and DisplayName are both set, the parameter defined by DisplayName will be 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 operator itself is located in).
The operator has no inputs and outputs, as it doesn't interfere with the data flow structure of the design.
A general introduction into library Parameters you find in Library Parameters.
Status | |
---|---|
Type | static read (although the GUI displays write) parameter |
Default | none |
Range | OK or error message |
Displays the error status. If 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. 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 parameter at another point in the design (in addition to the 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 parameter DisplayName. If you defined a new parameter DisplayName, but leave parameter DisplayHierarchy empty: The new parameter is added to the hierarchical box that contains the operator instance. (Keep in mind this is not possible if the operator instance is located on the highest (process) level.)
|
Value | |
---|---|
Type | static, dynamic, write, read parameter |
Default | 0 |
Range | double |
Map parameter for access from and to the variable. This parameter mirrors all properties of the variable. |
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. |
RangeFrom | |
---|---|
Type | static write parameter |
Default | 0.1 |
Range | |
Definition of smallest valid value. You can also enter a formula here. |
RangeTo | |
---|---|
Type | static write parameter |
Default | 1.0 |
Range | |
Definition of biggest valid value. You can also enter a formula here. |
RangeIncrement | |
---|---|
Type | static write parameter |
Default | 0.1 |
Range | |
Definition of intervall between valid values (definition of stepsize). You can also enter a formula here. |
Activate | |
---|---|
Type | dynamic write parameter |
Default | No |
Range | {No,Yes} |
Yes = Access to and from the variable (via map parameter Value) is activated. No = Access to and from the variable is de-activated and parameter Status is disabled. Parameters DisplayName and DisplayHierarchy have no effect. |