Skip to main content
View as Markdown

IRule interface

The IRule interface represents the one of the rules attached to a parameter within the PCB Layout directive (as a Parameter Set object with a small flag symbol) on a net aware object on a schematic object. A parameter set object can be placed on the schematic sheet by the Place » Directives » PCB Layout menu item.

public interface IRule : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Remarks​

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

Methods​

MethodReturnsDescription
DM_AttributesstringThe method denotes the attributes of the IRule interface.
DM_DescriptionstringThe method denotes the description of this IRule interface.
DM_MaxViaHoleintThe method denotes the max Via Hole rule property of a Routing Via style PCB Rule.
DM_MaxViaWidthintThe method denotes the max Via width rule property of a Routing Via style PCB Rule.
DM_MaxWidthintThe method denotes the Maximum Width rule property of a PCB rule.
DM_MinViaHoleintThe method denotes the min Via Hole rule property of a Routing Via style PCB Rule.
DM_MinViaWidthintThe method denotes the min Via width rule property of a Routing Via style PCB Rule.
DM_MinWidthintThe method denotes the Minimum Width rule property of a PCB Rule.
DM_PreferedWidthintThe method denotes the preferred Width rule property of a PCB Rule.
DM_PriorityintThe method denotes the priority of the PCB Design Rule.
DM_RoutingLayersintThe method denotes the indexed routing layer rule property (Top layer, Mid1-Mid30, Bottom Layer) of a Routing Layers PCB rule.
DM_RuleKindintThe method denotes the type of PCB Rule.
DM_RuleNamestringThe method denotes the name of this IRule interface representing a PCB rule.
DM_Scope1ExpressionstringThe method denotes the first scope expression string.
DM_Scope2ExpressionstringThe method denotes the second scope expression string.
DM_TopologyintThe method Denotes the topology (Shortest, Horizontal, Vertical, Daisy-Simple, Daisy-MidDriven, Daisy-Balanced and Daisy-StarBurst) rule property of a Routing Topology PCB Rule.
DM_UniqueIdstringEach rule has a Unique ID assigned so that when Schematic and PCB documents are synchronized, the ECO knows which rules to update or apply to/from.
DM_ViaHoleintDenotes the Via Hole rule property of a Routing Via style PCB Rule.
DM_ViaStyleintThis method denotes the via style rule property of a Routing Via style PCB Rule.
DM_ViaWidthintThe method denotes the Via width rule property of a Routing Via style PCB Rule.

DM_Attributes​

The method denotes the attributes of the IRule interface.

string DM_Attributes();

Returns: string

DM_Description​

The method denotes the description of this IRule interface.

string DM_Description();

Returns: string

DM_MaxViaHole​

The method denotes the max Via Hole rule property of a Routing Via style PCB Rule.

int DM_MaxViaHole();

Returns: int

DM_MaxViaWidth​

The method denotes the max Via width rule property of a Routing Via style PCB Rule.

int DM_MaxViaWidth();

Returns: int

DM_MaxWidth​

The method denotes the Maximum Width rule property of a PCB rule.

int DM_MaxWidth();

Returns: int

DM_MinViaHole​

The method denotes the min Via Hole rule property of a Routing Via style PCB Rule.

int DM_MinViaHole();

Returns: int

DM_MinViaWidth​

The method denotes the min Via width rule property of a Routing Via style PCB Rule.

int DM_MinViaWidth();

Returns: int

DM_MinWidth​

The method denotes the Minimum Width rule property of a PCB Rule.

int DM_MinWidth();

Returns: int

DM_PreferedWidth​

The method denotes the preferred Width rule property of a PCB Rule.

int DM_PreferedWidth();

Returns: int

DM_Priority​

The method denotes the priority of the PCB Design Rule. The priority value of 1 denotes the highest priority.

int DM_Priority();

Returns: int

DM_RoutingLayers​

The method denotes the indexed routing layer rule property (Top layer, Mid1-Mid30, Bottom Layer) of a Routing Layers PCB rule.

int DM_RoutingLayers(int argIndexLayer);
ParameterTypePassing
argIndexLayerintvalue

Returns: int

DM_RuleKind​

The method denotes the type of PCB Rule.

int DM_RuleKind();

Returns: int

DM_RuleName​

The method denotes the name of this IRule interface representing a PCB rule.

string DM_RuleName();

Returns: string

DM_Scope1Expression​

The method denotes the first scope expression string. The scope of Design rules are determined by the defined boundary or objects.

string DM_Scope1Expression();

Returns: string

DM_Scope2Expression​

The method denotes the second scope expression string. The scope of Design rules are determined by the defined boundary or objects.

string DM_Scope2Expression();

Returns: string

DM_Topology​

The method Denotes the topology (Shortest, Horizontal, Vertical, Daisy-Simple, Daisy-MidDriven, Daisy-Balanced and Daisy-StarBurst) rule property of a Routing Topology PCB Rule.

int DM_Topology();

Returns: int

DM_UniqueId​

Each rule has a Unique ID assigned so that when Schematic and PCB documents are synchronized, the ECO knows which rules to update or apply to/from.

string DM_UniqueId();

Returns: string

DM_ViaHole​

Denotes the Via Hole rule property of a Routing Via style PCB Rule.

int DM_ViaHole();

Returns: int

DM_ViaStyle​

This method denotes the via style rule property of a Routing Via style PCB Rule.

int DM_ViaStyle();

Returns: int

DM_ViaWidth​

The method denotes the Via width rule property of a Routing Via style PCB Rule.

int DM_ViaWidth();

Returns: int

Inherited members​

Returned by​

IDocument.DM_Rules