Skip to content

Python Script: Frequently Used Parameters - Syntax#

full_module_name#

Scope: Use full_module_name to address 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/BoxName1/module6

parameter_name#

In parameter_name, specify the name of the parameter as it's displayed in the VisualApplets GUI.

port#

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

port as Mouseover

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

Whenever a function expects a position in the design window, a Python tuple (x, y) is used.

Port names of inner hierarchical box nodes: Inner hierarchical box nodes (inner nodes for connecting BoxName 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 port Addressed by klzzwxh:0019 and klzzwxh:0020

mult#

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

  • mult specifies what is displayed in the VisualApplets GUI when instantiating an operator that has a varying number of ports. mult is the short name of the multiport name and is displayed in parantheses in the GUI:

Parameter mult

mult here is I.

You also find the value of mult in the mouseover information to a port:

Parameter klzzwxh:0027 as Mouseover

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

Scope: Use link to identify the link to a connected module port.

Syntax: To identify a link, use the tuple (<FullModuleName>, <PortName>)

full_module_name has the following syntax: <HierLevelPath>/<ModuleName>.

full_sim_module_name#

Scope: Use full_sim_module_name to identify an individual simulation module. It refers to simulation source and simulation probe modules.

full_sim_module_name has the following syntax: <HierLevelPath>/<SimModuleName>

file_name#

Scope: Use file_name to specify the path to the file and the file name itself. Use forward slashes for indicating paths. Don't forget to add the file name extension to the file name.

  • File extensions .va and .vad indicate that your design is saved in the standard VisualApplets design format. All contents of the design are saved.