Transmitting Variables within a Subcircuit

Create a simple circuit by adding these elements and connecting them:

Number to add	Library	Element

Number to add	Library	Element
1	Control Sources	Constant, integer
2	Control Sources	Constant, float
1	Control Nonlinear And Delay	Selector

Then add these parts to the schematic:

Put them in a subcircuit (see Create a subcircuit).

Right-click the subcircuit and click Open Parameter Form:

In this Window, enter the values to transmit to the subcircuit.

Click Execute Script, and check the box next to these in the Variables to transmit tab:

Due to the use of JavaScript in this mask, there are eight reserved variables which cannot be used. See below.

These variables have fixed values:

Variable	Value
E	Euler’s number
PI	PI
SQRT2	Square root of 2
SQRT1_2	Square root of ½
LN2	Natural logarithm of 2
LN10	Natural logarithm of 10
LOG2E	Base 2 logarithm of E
LOG10E	Base 10 logarithm of E

Select the value(s) to transmit to the subcircuit:

Linking Variables to a Subcircuit Component

The next step is to link the variable(s) set to the subcircuit components.

First, display the subcircuit.
To do so, use the Hotkey shortcut: CTRL+SHIFT+I or Right-click the subcircuit, click Subcircuit Info… and click the Open button.
To set a value click on the textbox and enter “=” + name of the variable.

Do the same with both of the Constant, float

Element	Value

Element	Value
Const1 (Constant, integer)	=selector
Const2 (Constant, float)	=float1
Const3 (Constant, float)	=float2

You can now edit values underneath the mask without opening every mask.

Rules

The Rules tab allows you to define other variables. While the Initial values are meant to be directly changed at the top level, and the variables defined in rules are designed to be calculated based on the initial values. They can then be transmitted within the subcircuit in the same way.

For example:

Initial Value: "radius=4"
Rules: "surface=PI*radius*radius"
Execute script
Variable to transmit will offer both radius and surface

The final script is the concatenation of both the Initial Values and Script, the 2 sections are split for clarity when defining the variables.

A good practice is to hide the variables generated by the Rules section if a Custom View was generated for the subcircuit.

Options

The Options section helps to choose display options for the subcircuit.

Custom View: After clicking the Generate button on the right, an xml file will be generated designing a default layout for the form. The next time the subcircuit form is opened, the new layout will be displayed, which can then be manually customized.
- The xml file can be found in the _hyp folder of the model, under the /view subfolder.
Category: This field will be used in the netlist to sort within the subcircuits.
Read-only: When checked, this option prevents the edition from the UI of the components inside the subcircuit. Therefore, if you enter the subcircuit above after checking this option, the constant fields cannot be edited anymore. This funnels all editions of the content of the subcircuit into the mask defined for the subcircuit.
Single block: With this option, elements within the subcircuit will not be part of the netlist, effectively helping to hide a component in a subcircuit.

When generating a form for a subcircuit, we can always get back to the subcircuit configuration using the button left of the sensor form.