Skip to content

Tcl Script: Frequently Used Parameters - Syntax#

FullModuleName#

Scope: For addressing specific operator instances (= modules) in a design.

Syntax: <HierLevelPath>/<ModuleName>

  • HierLevelPath you use to define the path to a specific hierarchical level in the design. Use forward slashes.
  • ModuleName you use for specifying the name of the module. The name of the module is the individual name you give to a module, not the name of the operator the module is instantiated from.

Example: Process1/cam

If you address modules within a hierarchical box, don’t forget to state the name of the process the hierarchical box is located in.

Example: Process0/HierchBox1/module6

FullElementName#

Scope: For addressing specific elements (modules (i.e., operator instances), hierarchical boxes, simulation sources, simulation probes, and comment boxes) in a design.

Syntax: <HierLevelPath>/<ElementName>

  • HierLevelPath you use to define the path to a specific hierarchical level in the design. Use forward slashes.
  • ElementName you use for specifying the name of the element. ElementName is the individual name you give to an element instance.

Example: Process1/cam1

If you address elements within a hierarchical box, don’t forget to state the name of the process the hierarchical box is located in.

Example: Process0/HierchBox1/module6

HierLevelPath#

Scope: HierLevelPath you use to define the path to a specific hierarchical level in the design. Use forward slashes.

Example: Process1/HierBox_xy/

If you address elements within a hierarchical box, don’t forget to state the name of the process the hierarchical box is located in.

Example: Process0/HierchBox1/

ParameterName#

In Parametername, specify the name of the parameter as it displayed in the VisualApplets GUI.

MultiportBaseName#

Scope: MultiportBaseName you use to specify the kind of port you want to address on a module. You retrieve information about the base name of a port instance in the VisualApplets GUI:

  • The MultiportBaseName is displayed in the dialog that appears when instantiating an operator that has a varying number of ports. The MultiportBaseName is the short name of the multiport name and is displayed in parantheses in the GUI:

Parameter MultiportBaseName

The MultiportBaseName here is I.

You also find the MultiportBaseName in the mouseover information to a port:

Parameter MultiportBaseName as Mouseover

MultiportBaseName here is I (followed by the index identifying the individual instances of the multiport on the module).

PortName#

Scope: PortName you use to identify an individual port you want to address on a module. You retrieve information about the PortName via mouseover in the VisualApplets GUI:

PortName as Mouseover

PortNames here are I, PI, Tick, Reset, and O.

PortName can also stand for the port name of a multiport. If PortName stands for the port name of a multiport, it has the following syntax: <MultiportBaseName>:Number

If a multiport is instantiated on a module multiple times, an index number is added to the MultiportBaseName.

Example:

Parameter PortName

MultiportBaseName here is I (followed by the index identifying the individual instances of the multiport on the module).

Port names of inner hierarchical box nodes: Inner hierarchical box nodes (inner nodes for connecting HierarchicalBox ports) are identified via the prefixes INBOUND# or OUTBOUND#.

Example:

The two inbound nodes of the hierarchical box in the figure below need to be addressed by INBOUND#I000 and INBOUND#I001.

Parameter PortName Addressed by INBOUND#I000 and INBOUND#I001

HierNodeName#

Scope: HierNodeName you use to identify a specific inner hierarchical box node you want to address within a hierarchical box.

Syntax:

INBOUND#<Portname>

OUTBOUND#<Portname>

Example:

The two inbound nodes of the hierarchical box in the figure below need to be addressed by INBOUND#I000 and INBOUND#I001.

Parameter HierNodeName

FullSimModuleName#

Scope: FullSimModuleName you use to identify an individual simulation module. It refers to simulation source and simulation probe modules.

The syntax is identical to FullElementName: <HierLevelPath>/<ElementName>

FullSimSourceName#

Scope: FullSimSourceName you use to identify an individual simulation source module.

Syntax: <HierLevelPath>/<ElementName>

The syntax is identical to FullElementName.

FullSimProbeName#

Scope: FullSimProbeName you use to identify an individual simulation probe module.

Syntax: <HierLevelPath>/<ElementName>

The syntax is identical to FullElementName.

FileName#

Scope: Specify in FileName the path to the file and the file name itself. Use forward slashes for indicating pathes. Don’t forget to add the file name extension to the file name.

  • File extension “.va” indicates that your design is saved in the standard VisualApplets design format. All contents of the design are saved.
  • File extension “.tcl” indicates that a TCL script is exported. Some contents of the design cannot be exported.
Back to top