Operator ResourceReference

Operator Library: Parameters

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

This operator generates a 1:1 map parameter (in the parameter ResourceIndex) out of a device resource mapping for a module located anywhere in the design. You specify the referenced module in the parameter Reference and the device resource type in the parameter ResourceName.

[Important] Availability

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

The referenced resource mapping is represented as an integer value.

You can define a target within the design hierarchy where the referenced resource mapping 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 rerence 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 parameter for the resource mapping available on any hierarchical level of the design you want. For example, you can make the resource mapping of modules within a protected hierarchical box available for parametrization directly under the properties of the protected hierarchical box itself.

Mapped resource parameters can be referenced themselves. Thus, you can reference either the content of the parameter ResourceIndex 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 (the referenced resource mapping, the map parameter ResourceIndex, or the display reference 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.

For further details, refer to the general description of the 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 parameter Activate is set to Yes, the other operator settings 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 defined a new parameter DisplayName, but leave 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

ResourceIndex
Type static, dynamic, write, read parameter
Default 0
Range Depends on the index range of the connected device resource

Map parameter for access from and to the referenced device resource mapping value.

ResourceName
Type static, dynamic, write parameter
Default 0
Range Any string

Define the device resource type which shall be accessed. The name is the same as provided in the device resources dialog.

Reference
Type static write parameter
Default None
Range Any string defining the referenced module: relative path to module

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

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'.

Description
Type static write parameter
Default None
Range Any string

Here, you define a description of the generated reference parameter.

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

Yes = Access to and from the referenced device resource mapping (via the map parameter ResourceIndex) is activated.

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

Examples of Use

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

  Prev     Level Up     Next  
Content Top Home