Operator IntFieldVariable

Operator Library: Parameters

The IntFieldVariable operator generates a software variable field.

[Important] Availability

To use the IntFieldVariable 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. With the DisplayName parameter, 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, because it doesn't interfere with the data flow structure of the design.

For a general introduction into the Parameters library, see 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 error message

Displays the error status. If the Activate parameter 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 with the DisplayName parameter.

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 defined a new DisplayName parameter, but leave the DisplayHierarchy parameter empty: The new parameter is added to the hierarchical box that contains the operator instance. This is not possible if the operator instance is located on the highest (process) level.

[Note] Syntax for Setting up Path to 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 DisplayHierarchy parameter.

The syntax is as follows:

<Path> is the relative path from the process level to the level of the design where the <Hierarchical Box> is located which will get the new parameter. Thus, the DisplayHierarchy parameter 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

Size
Type static, dynamic, write, read parameter
Default 0
Range Unsigned integer (31 bit)

With this parameter you can define the number of field entries.

ColumnCount
Type static write, read parameter
Default 0
Range [1,256]

With this parameter you can define the number of columns for entering field values in the module properties dialog.

Index
Type dynamic write parameter
Default 0
Range UInt

With this parameter you can set the field index here.

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

With this parameter you can set or read the field entry addressed by the Index parameter.

Field
Type static,dynamic, write, read parameter
Default none
Range array

This field parameter defines the content of the variable field.

Unit
Type static write parameter
Default -
Range Latin-1

Enter here the unit for the Value parameter.

Description
Type static write parameter
Default -
Range any text

Enter here the description for the Value parameter.

RangeFrom
Type static write parameter
Default 0
Range

With this parameter you can define the smallest valid value. You can also enter a formula here.

RangeTo
Type static write parameter
Default 255
Range

With this parameter you can define the biggest valid value. You can also enter a formula here.

RangeIncrement
Type static write parameter
Default 1
Range

With this parameter you can define the interval between valid values (definition of step size). You can also enter a formula here.

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

Yes = Access to and from the variable is activated via the Value map parameter.

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

  Prev     Level Up     Next  
Content Top Home