Working with a Parameter Set Object on a Schematic Sheet in Altium Designer

Parent page: Schematic Objects

A Parameter Set

Summary

A parameter set is a design directive, allowing design specifications to be associated to a net-type object within a schematic design. For example, use a parameter set to attach PCB layout information to a net, or to declare two nets to be members of a differential pair. It is the presence of specifically named parameters in the parameter set that the software uses to determine which design directive you are placing.

Availability

Parameter sets are available for placement in the schematic editor only. Both default (empty) and pre-defined (PCB Layout, Net Class, Differential Pair, Stimulus and Test Vector Index) parameter set directives are available. The only difference between an empty parameter set and a pre-defined parameter set is that the pre-defined parameter sets include a parameter, as described below.

Access the corresponding commands from the main Place menu as follows:

•	Place » Directives » Parameter Set		Does not include any parameters
•	Place » Directives » Differential Pair		Includes the parameter named DifferentialPair, the software recognizes this and displays the object as a differential pair directive
•	Place » Directives » PCB Layout		Includes the parameter named Rule, which must be configured to the required PCB design rule
•	Place » Directives » Net Class		Includes the parameter named ClassName, which must have its value set to the required PCB Net Class
•	Place » Directives » Stimulus		Includes the parameter named Stimulus, with a value of Stimulus
•	Place » Directives » Test Vector Index		Includes the parameter named Column, with a value of TestVectorIndex

Placement

A parameter set can be used to attach parameters to a:

• net,
• bus,
• signal harness, or a
• blanket object.

After launching the command, the cursor will change to a cross-hair and you will enter design directive placement mode. Placement is made by performing the following actions:

1. Position the cursor over a wire or other net object and click or press Enter to place.
2. Continue placing further directives or right-click or press Esc to exit placement mode.

Additional actions that can be performed during placement – while the parameter set is still floating on the cursor are:

• Press the Tab key to access an associated properties dialog from where properties for the parameter set can be changed on-the-fly.
• Press the Alt key to constrain the direction of movement to the horizontal or vertical axis, depending on the initial direction of movement.
• Press the Spacebar to rotate the parameter set counter-clockwise or Shift+Spacebar for clockwise rotation. Rotation is in increments of 90°.
• Press the X or Y keys while in placement mode to flip the parameter set along the X-axis or Y-axis.

Graphical Editing

This method of editing allows you to select a placed parameter set directive directly in the workspace and change its location or orientation graphically.

When a parameter set directive is selected in the workspace, a dashed box will appear around the directive. The box encloses the area occupied by the directive only. For each visibility-enabled member parameter of the set, a dashed line will be visible, connecting the text field of the parameter to the body of the directive, which affirms association:

Click anywhere inside the dashed box and drag to reposition the parameter set as required. While dragging, the parameter set can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).

The parameter set's text fields (which can be graphically edited independently of the parent directive) can only be adjusted with respect to size by changing the size of the font (accessed through the relevant Parameter Properties dialog). As such, editing handles are not available when any of these objects are selected.

Click anywhere inside the dashed box and drag to reposition the text object as required. While dragging, the text object can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).

If the Enable In-Place Editing option is enabled on the Schematic - General page of the Preferences dialog (Tools » Schematic Preferences), you will be able to edit the value for a parameter directly in the workspace (with the exception of parameters that have been added as rules). Select the text object and then click once to invoke the feature. Type the new value as required and then click away from the text object or press Enter to effect the change.

Non-Graphical Editing

Via an Associated Properties Dialog

Dialog page: Parameters

This method of editing uses the Parameters dialog to modify the properties of a parameter set.

The Parameters dialog

The Parameters dialog can be accessed prior to entering placement mode, from the Schematic - Default Primitives page of the Preferences dialog (Tools » Schematic Preferences). This allows you to change the default properties for the parameter set, which will be applied when placing subsequent parameter set directives.

During placement, the Parameters dialog can be accessed by pressing the Tab key.

After placement, the Parameters dialog can be accessed in one of the following ways:

• Double-click on the placed parameter set directive.
• Place the cursor over the parameter set, right-click then choose Properties from the context menu.
• Click Edit » Change from the main menus then click once over the placed parameter set directive.

The parameter set directive's member parameters can be added, edited or removed using the Parameters dialog. The properties of a parameter are viewed or modified using the Parameter Properties dialog.

The Parameter Properties dialog

When a parameter is added as a rule, the parameter name (Rule) is locked and cannot be changed.

The parameters of a parameter set directive can be edited independently of the parent set directive. The Parameter Properties dialog can be accessed in one of the following ways:

• Double-click on the parameter object.
• Place the cursor over the parameter object, right-click then choose Properties from the context menu.
• Click Edit » Change from the main menus then click once over the parameter object.

Via an Inspector Panel

Panel pages: SCH Inspector, SCH Filter

An Inspector panel enables the user to interrogate and edit the properties of one or more design objects in the active document. Used in conjunction with appropriate filtering - by using the applicable Filter panel or the Find Similar Objects dialog - the panel can be used to make changes to multiple objects of the same kind, from one convenient location.

Via a List Panel

Panel pages: SCH List, SCH Filter

A List panel allows the user to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the applicable Filter panel or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing the designer to target and edit multiple design objects with greater accuracy and efficiency.

Example

Multiple parameters can be added to the same parameter set object. In the image below, the Differential Pair directive was placed to touch the edge of the blanket. It was then edited to include a ClassName parameter and a Rule parameter. When the design is synchronized with the PCB, these additional elements will be created:

• eight PCB differential pairs
• a PCB net class called ROCKET_IO_LINES, with the 16 nets that are under the blanket, in it
• a Differential Pair Routing design rule, with a scope of InNetClass(' ROCKET_IO_LINES ')

By using a blanket, only one Differential Pair directive is required. As well as defining the differential pairs, it also specifies a Net Class and a Differential Pair Routing rule.
These nets will become members of that Net Class, and that Net Class will be used to scope the Differential Pair Routing rule.

Notes

1. When placing a default parameter set directive, there will be no existing parameters.
2. A PCB Layout directive allows you to assign PCB layout information to a net in the schematic. When a PCB is created from the schematic, the information in the PCB layout directive is used to create relevant PCB design rules. The information specified by a PCB Layout directive is applied only to the net(s) to which it is connected.
3. Net Class directives enable you to create user-defined net classes on the schematic. When a PCB is created from the schematic, the information in a Net Class directive is used to create the corresponding Net Class on the PCB. To make a net a member of a net class, attach a Net Class directive to the relevant wire or bus and set the directive's ClassName parameter to the name of the desired class. The Generate Net Classes option (for User-Defined Classes) must be enabled on the Class Generation tab of the Project Options dialog to use this feature.
4. If a Net Class directive has been defined for a net, then any PCB design rules that are also created by that parameter set object will have a rule scope of Net Class, when the design is transferred to the PCB editor.
5. A Differential Pair directive allows you to define a differential pair object on the schematic. Attach a directive of this type to both the positive and negative nets of the intended pair, or cover the pair with a blanket object to target multiple nets with a single directive. The nets themselves must be named with the suffixes of _P and _N. Both parameter set objects will contain a single parameter entry with Name being DifferentialPair and Value being True. Each pair of directives (one for the positive net and one for the negative net) of this type will yield a differential pair object when transferred to the PCB during the synchronization process. Each of these differential pair objects will be added to the default Differential Pair class of All Differential Pairs. The name of a generated differential pair object will be the root name for the net pair on the schematic. For example, directives added to RX0_N and RX0_P on the schematic will generate a differential pair object on the PCB with the name RX0. You can rename differential pair objects on the PCB side only.
6. A Stimulus directive is used to identify a node or net to be stimulated when a digital simulation is run. This directive is used only during netlist generation and holds no significance for any schematic processes.
7. Test vector directives are used to identify a node with a simulation test vector. The test vectors are referred to by a column number, which indicates the column of the test vector file to use when the simulation is run. This directive is used only during netlist generation and holds no significance for any schematic processes.