Attribute Checks

Created: May 08, 2023 | Updated: May 08, 2023 | Applies to versions: 23, 24 and 25

Now reading version 24. For the latest, read: Attribute Checks for version 25

The Attribute Checks PCB query functions shown in the Query Helper dialog

This reference page details the query language keywords from the Attribute Checks category available in PCB and PCB library documents in Altium Designer. For help on a specific query keyword, use the following collapsible sections or highlight (or click inside) any given keyword - in the Query Helper, or a Filter panel - and press F1 to access its section right away.

BigColumnCount

Summary

Returns component objects whose count of "big" columns of pads complies with the Query. In this context, each "big" column of pads contains at least four pads.

Syntax

BigColumnCount : Number

Example Usage

BigColumnCount = 8
Returns all components that have exactly 8 'big' columns of pads.

BigColumnCount Between 6 And 10
Returns all component objects that have between 6 and 10 'big' columns of pads.

BigColumnCount <= 4
Returns all objects except component objects that have more than 4 'big' columns of pads.

Note

The associated child objects of the complying component objects are also returned.

BigRowCount

Summary

Returns component objects whose count of "big" rows of pads complies with the Query. In this context, each "big" row of pads contains at least four pads.

Syntax

BigRowCount : Number

Example Usage

BigRowCount = 8
Returns all components that have exactly 8 'big' rows of pads.

BigRowCount Between 6 And 10
Returns all component objects that have between 6 and 10 'big' rows of pads.

BigRowCount <= 4
Returns all objects except component objects that have more than 4 'big' rows of pads.

Note

The associated child objects of the complying component objects are also returned.

ColumnCount

Summary

Returns component objects whose number of columns of pads complies with the Query.

Syntax

ColumnCount : Number

Example Usage

ColumnCount = 8
Returns all components that have exactly 8 columns of pads.

ColumnCount Between 6 And 10
Returns all components that have between 6 and 10 columns of pads (inclusive).

ColumnCount < 4
Returns all objects except components that have 4 columns of pads, or more.

Note

The associated child objects of the complying component objects are also returned.

CompCenterOfPadsX

Summary

Returns component objects when the X-Coordinate of the centroid of their pads complies with the Query.

Syntax

CompCenterOfPadsX : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterOfPadsX = 1200
Returns all component objects when the X-Coordinate of the centroid of their pads is equal to 1200mil.

CompCenterOfPadsX >= 1500
Returns all component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 1500mil.

CompCenterOfPadsX Between 1000 And 1400
Returns all component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterOfPadsX < 800
Returns all objects except component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 800mil.

Note

The associated child objects of the complying component objects are also returned.

CompCenterOfPadsY

Summary

Returns component objects when the Y-Coordinate of the centroid of their pads complies with the Query.

Syntax

CompCenterOfPadsY : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterOfPadsY = 1200
Returns all component objects when the Y-Coordinate of the centroid of their pads is equal to 1200mil.

CompCenterOfPadsY >= 1500
Returns all component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 1500mil.

CompCenterOfPadsY Between 1000 And 1400
Returns all component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterOfPadsY < 800
Returns all objects except component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 800mil.

Note

The associated child objects of the complying component objects are also returned.

CompCenterX

Summary

Returns component objects when the X-Coordinate of the centroid of all of their child objects complies with the Query.

Syntax

CompCenterX : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterX = 1200
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is equal to 1200mil.

CompCenterX >= 1500
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1500mil.

CompCenterX Between 1000 And 1400
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterX < 800
Returns all objects except component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 800mil.

Note

The associated child objects of the complying component objects are also returned.

CompCenterY

Summary

Returns component objects when the Y-Coordinate of the centroid of all of their child objects complies with the Query.

Syntax

CompCenterY : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterY = 1200
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is equal to 1200mil.

CompCenterY >= 1500
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1500mil.

CompCenterY Between 1000 And 1400
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterY < 800
Returns all objects except component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 800mil.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount

Summary

Returns component objects whose number of pads complies with the Query.

Syntax

CompPinCount : Number

Example Usage

CompPinCount = 10
Returns all component objects whose number of pads is equal to 10.

CompPinCount Between 20 And 30
Returns all component objects whose number of pads is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount <= 8
Returns all objects except component objects whose number of pads is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount_Bottom

Summary

Returns component objects whose number of pads on the Bottom Layer complies with the Query.

Syntax

CompPinCount_Bottom : Number

Example Usage

CompPinCount_Bottom = 10
Returns all component objects whose number of pads on the Bottom Layer is equal to 10.

CompPinCount_Bottom Between 20 And 30
Returns all component objects whose number of pads on the Bottom Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Bottom <= 8
Returns all objects except component objects whose number of pads on the Bottom Layer is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount_Internal

Summary

Returns component objects whose number of pads on the internal signal layers (Signal Layer 1-30) complies with the Query.

Syntax

CompPinCount_Internal : Number

Example Usage

CompPinCount_Internal = 10
Returns all component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is equal to 10.

CompPinCount_Internal Between 20 And 30
Returns all component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Internal <= 8
Returns all objects except component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount_Surface

Summary

Returns component objects whose number of pads on the Top and Bottom signal layers complies with the Query.

Syntax

CompPinCount_Surface : Number

Example Usage

CompPinCount_Surface = 10
Returns all component objects whose number of pads on the Top and Bottom signal layers is equal to 10.

CompPinCount_Surface Between 20 And 30
Returns all component objects whose number of pads on the Top and Bottom signal layers is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Surface <= 8
Returns all objects except component objects whose number of pads on the Top and Bottom signal layers is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount_ThruHole

Summary

Returns component objects whose number of pads on the Multi-Layer complies with the Query.

Syntax

CompPinCount_ThruHole : Number

Example Usage

CompPinCount_ThruHole = 10
Returns all component objects whose number of pads on the Multi-Layer is equal to 10.

CompPinCount_ThruHole Between 20 And 30
Returns all component objects whose number of pads on the Multi-Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_ThruHole <= 8
Returns all objects except component objects whose number of pads on the Multi-Layer is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

CompPinCount_Top

Summary

Returns component objects whose number of pads on the Top Layer complies with the Query.

Syntax

CompPinCount_Top : Number

Example Usage

CompPinCount_Top = 10
Returns all component objects whose number of pads on the Top Layer is equal to 10.

CompPinCount_Top Between 20 And 30
Returns all component objects whose number of pads on the Top Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Top <= 8
Returns all objects except component objects whose number of pads on the Top Layer is greater than 8.

Note

The associated child objects of the complying component objects are also returned.

HasViolations

Summary

Returns objects whose violation state is True. This occurs when a violation of one or more design rules has been detected that involves the object concerned.

Syntax

HasViolations : Boolean/Boolean_String

Example Usage

HasViolations HasViolations = True HasViolations = 'True'
Returns all objects that are currently in violation of defined design rules.

Not HasViolations HasViolations = False HasViolations = 'False'
Returns all objects except objects that are currently in violation of defined design rules.

Summary

Returns the object(s) specified by the Query.

Syntax

Id = ObjectIdentifying_String

ObjectIdentifying_String must be one of the strings that is listed within the various PCB Object Lists of the Query Helper dialog, and it needs to be preceded and followed by single quote characters ('). Which strings are actually listed depends on the objects that currently exist on the PCB/PCBLIB document being edited. The following object lists are presented:

Channel Classes
Coordinates
Components
Component Classes
Differential Pair
Differential Pair Classes
Dimensions
From-To
From-To Classes
Layer Classes
Net Classes
Nets
Pad Classes
Pads
Polygon Classes
Polygons
Rules
Text
Violations

Although a string is listed for each of these objects, these strings do not necessarily identify one particular object. As one example, the string provided for each design rule object consists of the characters 'Rule0mil,0mil', so specifying that string will result in all of the Rule objects being returned.

Example Usage

Id = 'GND'
Returns the Net object whose Net property is GND.

Id = 'C3-1'
Returns the pad object(s) whose full Name property is C3-1.

Id = 'Text[3510mil,3800mil]'
Returns the text object(s) whose point is at 3510mil,3800mil.

Id = 'D3'
Returns the component object(s) whose Designator property is D3.

Id = 'Dimension[4800mil,3800mil]'
Returns the dimension object(s) whose insertion point is at 4800mil,3800mil.

Id = 'Coordinate[3500mil,3800mil]'
Returns the coordinate object(s) whose insertion point is at 3500mil,3800mil.

Id = 'My Top Side Layers'
Returns the (layer) class object whose Name property is My Top Side Layers.

Id = 'Rule[0mil,0mil]'
Returns all of the design rule objects (as these all have the same identifying string assigned to them).

Id = 'GND (ZZ4-2 : ZZ3-2)'
Returns the from-to object whose Net property is GND, From Pad property is ZZ4-2, and To Pad property is ZZ3-2.

Id = 'Violation[0mil,0mil]'
Returns all of the violation objects (as these all have the same identifying string assigned to them).

InAnyComponent

Summary

Use this keyword to quickly return all components and their child primitives.

Syntax

InAnyComponent : Boolean/Boolean_String

Example Usage

InAnyComponent InAnyComponent = True InAnyComponent = 'True'
Returns all component objects and their associated primitives.

Not InAnyComponent InAnyComponent = False InAnyComponent = 'False'
Returns all objects except component objects and their associated primitives.

InAnyDifferentialPair

Summary

Use this keyword to quickly return all differential pair objects and their associated primitives.

Syntax

InAnyDifferentialPair : Boolean/Boolean_String

Example Usage

InAnyDifferentialPair InAnyDifferentialPair = True InAnyDifferentialPair = 'True'
Returns all differential pair objects and their associated primitives.

Not InAnyDifferentialPair InAnyDifferentialPair = False InAnyDifferentialPair = 'False'
Returns all objects except differential pair objects and their associated primitives.

InAnyNet

Summary

Use this keyword to quickly return all nets and their associated primitives (i.e. design objects that have a Net property).

Syntax

InAnyNet : Boolean/Boolean_String

Example Usage

InAnyNet InAnyNet = True InAnyNet = 'True'
Returns all nets and their associated primitives.

Not InAnyNet InAnyNet = False InAnyNet = 'False'
Returns all objects except nets and their associated primitives.

InAnyxSignal

Summary

Use this keyword to quickly return all objects associated with all xSignals defined for the design.

Syntax

InAnyxSignal : Boolean/Boolean_String

Example Usage

InAnyxSignal InAnyxSignal = True InAnyxSignal = 'True'
Returns all objects associated with all xSignals defined for the design.

Not InAnyxSignal InAnyxSignal = False InAnyxSignal = 'False'
Returns all objects except objects associated with xSignals defined for the design.

InBGA

Summary

Returns child objects of components that are of a BGA nature. Such a component contains at least 10 rows of pads and at least 10 columns of pads, the (absolute) difference between the number of rows of pads and the number of columns of pads is less than 6. The total pad count is at least half of the product of the number of rows of pads and the number of columns of pads, and all of the pads are of a surface-mount nature.

Syntax

InBGA : Boolean/Boolean_String

Example Usage

InBGA InBGA = True InBGA = 'True'
Returns all associated child primitives of BGA components.

Not InBGA InBGA = False InBGA = 'False'
Returns all objects except the associated child primitives of BGA components.

Note

The parent component objects are not returned by this Query.

InDIP

Summary

Returns child objects of components that are of a DIP nature. At least one (and typically all) of the pads of such a component are of a through-hole nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

InDIP : Boolean/Boolean_String

Example Usage

InDIP InDIP = True InDIP = 'True'
Returns all associated child primitives of DIP components.

Not InDIP InDIP = False InDIP = 'False'
Returns all objects except the associated child primitives of DIP components.

Note

The parent component objects are not returned by this Query.

InEdgeConnector

Summary

Returns child objects of components that are of an Edge Connector nature. All of the pads of such a component are of a surface-mount nature, and these are located on both sides of the PCB. All of the pads reside in either the same row or the same column, the number of pads on either side of the PCB is less than three times the number of pads on the opposite side of the PCB, and the total number of pads is at least 4.

Syntax

InEdgeConnector : Boolean/Boolean_String

Example Usage

InEdgeConnector InEdgeConnector = True InEdgeConnector = 'True'
Returns all associated child primitives of Edge Connector components.

Not InEdgeConnector InEdgeConnector = False InEdgeConnector = 'False'
Returns all objects except the associated child primitives of Edge Connector components.

Note

The parent component objects are not returned by this Query.

InLCC

Summary

Returns child objects of components that are of a Surface Mount LCC nature. Such a component contains 2 rows of pads (which each contain at least 4 pads), and 2 columns of pads (which each contain at least 4 pads), and all of the pads are of a surface-mount nature.

Syntax

InLCC : Boolean/Boolean_String

Example Usage

InLCC InLCC = True InLCC = 'True'
Returns all associated child primitives of LCC components.

Not InLCC InLCC = False InLCC = 'False'
Returns all objects except the associated child primitives of LCC components.

Note

The parent component objects are not returned by this Query.

InPGA

Summary

Returns child objects of components that are of a PGA nature. Such a component contains at least 6 rows of pads and at least 6 columns of pads. The (absolute) difference between the number of rows of pads and the number of columns of pads, is less than 6. The total pad count is at least half of the product of the number of rows of pads and the number of columns of pads, and at least one (and typically all) of the pads are of a through-hole nature.

Syntax

InPGA : Boolean/Boolean_String

Example Usage

InPGA InPGA = True InPGA = 'True'
Returns all associated child primitives of PGA components.

Not InPGA InPGA = False InPGA = 'False'
Returns all objects except the associated child primitives of PGA components.

Note

The parent component objects are not returned by this Query.

InPoly

Summary

Use this keyword to quickly return all polygon pours and their child primitives.

Syntax

InPoly : Boolean/Boolean_String

Example Usage

InPoly InPoly = True InPoly = 'True'
Returns all polygon pours and their child primitives.

Not InPoly InPoly = False InPoly = 'False'
Returns all objects except polygon pours and their child primitives.

Note

This function is an alias for the InPolygon function.
Only polygon pours placed on signal layers are returned.

InPolygon

Summary

Use this keyword to quickly return all polygon pours and their child primitives.

Syntax

InPolygon : Boolean/Boolean_String

Example Usage

InPolygon InPolygon = True InPolygon = 'True'
Returns all polygon pours and their child primitives.

Not InPolygon InPolygon = False InPolygon = 'False'
Returns all objects except polygon pours and their child primitives.

Note

This function is an alias for the InPoly function.
Only polygon pours placed on signal layers are returned.

InSIP

Summary

Returns child objects of components that are of a SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, at least one (and typically all) of these pads are of a through-hole nature.

Syntax

InSIP : Boolean/Boolean_String

Example Usage

InSIP InSIP = True InSIP = 'True'
Returns all associated child primitives of SIP components.

Not InSIP InSIP = False InSIP = 'False'
Returns all objects except the associated child primitives of SIP components.

Note

The parent component objects are not returned by this Query.

InSMSIP

Summary

Returns child objects of components that are of a Surface Mount SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, all of these pads are of a surface-mount nature.

Syntax

InSMSIP : Boolean/Boolean_String

Example Usage

InSMSIP InSMSIP = True InSMSIP = 'True'
Returns all associated child primitives of SMSIP components.

Not InSMSIP InSMSIP = False InSMSIP = 'False'
Returns all objects except the associated child primitives of SMSIP components.

Note

The parent component objects are not returned by this Query.

InSMTComponent

Summary

Returns child objects of components that are of an SMT nature. All of the pads of such a component are of a surface-mount nature.

Syntax

InSMTComponent : Boolean/Boolean_String

Example Usage

InSMTComponent InSMTComponent = True InSMTComponent = 'True'
Returns all associated child primitives of SMT components.

Not InSMTComponent InSMTComponent = False InSMTComponent = 'False'
Returns all objects except the associated child primitives of SMT components.

Note

The parent component objects are not returned by this Query.

InSOIC

Summary

Returns child objects of components that are of a Surface Mount DIP (SOIC) nature. All of the pads of such a component are of a surface-mount nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

InSOIC : Boolean/Boolean_String

Example Usage

InSOIC InSOIC = True InSOIC = 'True'
Returns all associated child primitives of SOIC components.

Not InSOIC InSOIC = False InSOIC = 'False'
Returns all objects except the associated child primitives of SOIC components.

Note

The parent component objects are not returned by this Query.

InThruComponent

Summary

Returns child objects of components that are of a Thru-Hole nature. At least one (and typically all) of the pads of such a component are of a through-hole nature.

Syntax

InThruComponent : Boolean/Boolean_String

Example Usage

InThruComponent InThruComponent = True InThruComponent = 'True'
Returns all associated child primitives of Thru-Hole components.

Not InThruComponent InThruComponent = False InThruComponent = 'False'
Returns all objects except the associated child primitives of Thru-Hole components.

Note

The parent component objects are not returned by this Query.

IsBGA

Summary

Returns components that are of a BGA nature. Such a component contains at least 10 rows of pads and at least 10 columns of pads, the (absolute) difference between the number of rows of pads and the number of columns of pads is less than 6. The total pad count is at least half of the product of the number of rows of pads and the number of columns of pads, and all of the pads are of a surface-mount nature.

Syntax

IsBGA : Boolean/Boolean_String

Example Usage

IsBGA IsBGA = True IsBGA = 'True'
Returns all BGA components.

Not IsBGA IsBGA = False IsBGA = 'False'
Returns all objects except BGA components.

Note

The associated child primitive objects are not returned by this Query.

IsChamferedRectanglePad

Summary

Returns all pad objects with a chamfered rectangle pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is a chamfered rectangular shape.

Syntax

IsChamferedRectanglePad : Boolean/Boolean_String

Example Usage

IsChamferedRectanglePad IsChamferedRectanglePad = True IsChamferedRectanglePad = 'True'
Returns all pad objects with a chamfered rectangle pad shape.

Not IsChamferedRectanglePad IsChamferedRectanglePad = False IsChamferedRectanglePad = 'False'
Returns all objects except pad objects with a chamfered rectangle pad shape.

IsChamferedRectangularPadOnLayer

Summary

Returns all pad objects with a chamfered rectangular pad shape on the specified layer.

Syntax

IsChamferedRectangularPadOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsChamferedRectangularPadOnLayer('Top Layer') IsChamferedRectangularPadOnLayer('Top Layer') = True IsChamferedRectangularPadOnLayer('Top Layer') = 'True'
Returns all pad objects with a chamfered rectangular pad shape on the Top Layer.

Not IsChamferedRectangularPadOnLayer('Bottom Layer') IsChamferedRectangularPadOnLayer('Bottom Layer') = False IsChamferedRectangularPadOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a chamfered rectangular pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsComponentPrimitive

Summary

Returns all child primitive objects associated with components in the design.

Syntax

IsComponentPrimitive : Boolean/Boolean_String

Example Usage

IsComponentPrimitive IsComponentPrimitive = True IsComponentPrimitive = 'True'
Returns all child primitives of component objects.

Not IsComponentPrimitive IsComponentPrimitive = False IsComponentPrimitive = 'False'
Returns all objects except child primitives of component objects.

IsComponentSelected

Summary

Returns all child primitive objects associated with currently selected components in the design.

Syntax

IsComponentSelected : Boolean/Boolean_String

Example Usage

IsComponentSelected IsComponentSelected = True IsComponentSelected = 'True'
Returns all child primitives of currently selected component objects.

Not IsComponentSelected IsComponentSelected = False IsComponentSelected = 'False'
Returns all objects except child primitives of currently selected component objects.

IsCustomPadShapeOnLayer

Summary

Returns all pad objects with a custom pad shape on the specified layer.

Syntax

IsCustomPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsCustomPadShapeOnLayer('Top Layer') IsCustomPadShapeOnLayer('Top Layer') = True IsCustomPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a custom pad shape on the Top Layer.

Not IsCustomPadShapeOnLayer('Bottom Layer') IsCustomPadShapeOnLayer('Bottom Layer') = False IsCustomPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a custom pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsCustomShapePad

Summary

Returns all pad objects with a custom pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is custom.

Syntax

IsCustomShapePad : Boolean/Boolean_String

Example Usage

IsCustomShapePad IsCustomShapePad = True IsCustomShapePad = 'True'
Returns all pad objects with a custom pad shape.

Not IsCustomShapePad IsCustomShapePad = False IsCustomShapePad = 'False'
Returns all objects except pad objects with a custom pad shape.

IsDIP

Summary

Returns components that are of a DIP nature. At least one (and typically all) of the pads of such a component are of a through-hole nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

IsDIP : Boolean/Boolean_String

Example Usage

IsDIP IsDIP = True IsDIP = 'True'
Returns all DIP components.

Not IsDIP IsDIP = False IsDIP = 'False'
Returns all objects except DIP components.

Note

The associated child primitive objects are not returned by this Query.

IsEdgeConnector

Summary

Returns components that are of an Edge Connector nature. All of the pads of such a component are of a surface-mount nature, and these are located on both sides of the PCB. All of the pads reside in either the same row or the same column, the number of pads on either side of the PCB is less than three times the number of pads on the opposite side of the PCB, and the total number of pads is at least 4.

Syntax

IsEdgeConnector : Boolean/Boolean_String

Example Usage

IsEdgeConnector IsEdgeConnector = True IsEdgeConnector = 'True'
Returns all Edge Connector components.

Not IsEdgeConnector IsEdgeConnector = False IsEdgeConnector = 'False'
Returns all objects except Edge Connector components.

Note

The associated child primitive objects are not returned by this Query.

IsElectrical

Summary

Returns all net objects whose Net property is not set to No Net.

Syntax

IsElectrical : Boolean/Boolean_String

Example Usage

IsElectrical IsElectrical = True IsElectrical = 'True'
Returns all net objects whose Net property is not set to No Net.

Not IsElectrical IsElectrical = False IsElectrical = 'False'
Returns all objects except net objects whose Net property is not set to No Net.

IsFree

Summary

Returns all free design objects. An object is free if it is not a component (or its associated primitives and 3D body(ies)), or if it is not a net object. In addition, a net object is considered to be free if its Net property is set to No Net.

Syntax

IsFree : Boolean/Boolean_String

Example Usage

IsFree IsFree = True IsFree = 'True'
Returns all free design objects.

Not IsFree IsFree = False IsFree = 'False'
Returns all objects except free design objects.

IsGraphicalComponent

Summary

Returns component objects whose Component Type property is Graphical. These components do not have electrical properties, are not synchronized (you must manually place them in both editors), and are not included in the BOM. An example is a company logo.

Syntax

IsGraphicalComponent : Boolean/Boolean_String

Example Usage

IsGraphicalComponent IsGraphicalComponent = True IsGraphicalComponent = 'True'
Returns all component objects whose Component Type property is set to Graphical.

Not IsGraphicalComponent IsGraphicalComponent = False IsGraphicalComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Graphical.

Note

The associated child primitive objects are not returned by this Query.

IsHorizontal

Summary

Returns horizontal tracks, i.e. those tracks whose Y1 and Y2 properties are identical.

Syntax

IsHorizontal : Boolean/Boolean_String

Example Usage

IsHorizontal IsHorizontal = True IsHorizontal = 'True'
Returns all horizontal tracks.

Not IsHorizontal IsHorizontal = False IsHorizontal = 'False'
Returns all objects except horizontal tracks.

IsJumperComponent

Summary

Returns component objects whose Component Type property is Jumper. These components are used to include wire links in a PCB design, for example on a single-sided PCB that cannot be fully routed on one layer. For this component type the component footprint and pins are synchronized between the schematic and PCB but the net assignments are not, and the component is included in the BOM. As well as selecting this option at the component level, both of the pads in the component must have their JumperID set to the same non-zero value. Jumper-type components do not need to be wired on the schematic, they only need to be included on the schematic if they are required in the BOM. If they are not required in the BOM they can be placed directly in the PCB, where the Component Type is set, the JumperIDs are set, and the Nets manually assigned for the pads.

Syntax

IsJumperComponent : Boolean/Boolean_String

Example Usage

IsJumperComponent IsJumperComponent = True IsJumperComponent = 'True'
Returns all component objects whose Component Type property is set to Jumper.

Not IsJumperComponent IsJumperComponent = False IsJumperComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Jumper.

Note

The associated child primitive objects are not returned by this Query.

IsKeepOut

Summary

Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Syntax

IsKeepOut : Boolean/Boolean_String

Example Usage

IsKeepOut IsKeepOut = True IsKeepOut = 'True'
Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Not IsKeepOut IsKeepOut = False IsKeepOut = 'False'
Returns all objects except Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

IsLCC

Summary

Returns components that are of a Surface Mount LCC nature. Such a component contains 2 rows of pads (which each contain at least 4 pads), and 2 columns of pads (which each contain at least 4 pads), and all of the pads are of a surface-mount nature.

Syntax

IsLCC : Boolean/Boolean_String

Example Usage

IsLCC IsLCC = True IsLCC = 'True'
Returns all LCC components.

Not IsLCC IsLCC = False IsLCC = 'False'
Returns all objects except LCC components.

Note

The associated child primitive objects are not returned by this Query.

IsLinkedToAnyPadViaLibrary

Summary

Returns pad and via objects that are linked to any Pad Via Library (*.PvLib), that is, those whose Library property makes reference to such a library.

Syntax

IsLinkedToAnyPadViaLibrary : Boolean/Boolean_String

Example Usage

IsLinkedToAnyPadViaLibrary IsLinkedToAnyPadViaLibrary = True IsLinkedToAnyPadViaLibrary = 'True'
Returns all pad and via objects that are linked to any Pad Via Library.

Not IsLinkedToAnyPadViaLibrary IsLinkedToAnyPadViaLibrary = False IsLinkedToAnyPadViaLibrary = 'False'
Returns all objects except pad and via objects that are linked to any Pad Via Library.

IsLinkedToPadViaLibrary

Summary

Returns pad and via objects that are linked to the Pad Via Library (*.PvLib) specified as part of the Query, that is, those whose Library property makes reference to such a library.

Syntax

IsLinkedToPadViaLibrary(PadViaLibraryName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = True IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'True'
Returns all pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Not IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = False IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'False'
Returns all objects except pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Note

The single quote characters (') at the start and end of the PadViaLibraryName string are mandatory.

IsLinkedToPadViaTemplate

Summary

Returns pad or via objects that are using the Pad or Via template specified as part of the Query, that is, those whose Template property makes reference to such a template.

Syntax

IsLinkedToPadViaTemplate(TemplateName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaTemplate('c152hn127') IsLinkedToPadViaTemplate('c152hn127') = True IsLinkedToPadViaTemplate('c152hn127') = 'True'
Returns all pad objects that use the pad template c152hn127.

Not IsLinkedToPadViaTemplate('v127h71') IsLinkedToPadViaTemplate('v127h71') = False IsLinkedToPadViaTemplate('v127h71') = 'False'
Returns all objects except via objects that use the via template v127h71.

Note

The single quote characters (') at the start and end of the TemplateName string are mandatory.

IsMechanicalComponent

Summary

Returns component objects whose Component Type property is Mechanical. These components do not have electrical properties, are not synchronized (you must manually place them in both editors), and are included in the BOM. An example is a heatsink.

Syntax

IsMechanicalComponent : Boolean/Boolean_String

Example Usage

IsMechanicalComponent IsMechanicalComponent = True IsMechanicalComponent = 'True'
Returns all component objects whose Component Type property is set to Mechanical.

Not IsMechanicalComponent IsMechanicalComponent = False IsMechanicalComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Mechanical.

Note

The associated child primitive objects are not returned by this Query.

IsNetSelected

Summary

Returns net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

To first select a particular net (or nets), apply a filter with Query IsNet, then select those nets required in the List panel.

Syntax

IsNetSelected : Boolean/Boolean_String

Example Usage

IsNetSelected IsNetSelected = True IsNetSelected = 'True'
Returns all net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

Not IsNetSelected IsNetSelected = False IsNetSelected = 'False'
Returns all objects except net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

Note

The selected Net objects are not returned, nor are the child primitives of any polygon pour objects which are returned.

IsNetTieComponent

Summary

Returns component objects whose Component Type property is either Net Tie, or Net Tie (In BOM). These components are used to short two or more different nets together. They are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match). Net Tie (In BOM) type components are included in the BOM, while Net Tie type components are not. They differ from a Standard component in that connectivity created by copper within the footprint is not checked - it is this copper that allows the nets to be shorted.

Syntax

IsNetTieComponent : Boolean/Boolean_String

Example Usage

IsNetTieComponent IsNetTieComponent = True IsNetTieComponent = 'True'
Returns all component objects whose Component Type property is set to either Net Tie, or Net Tie (In BOM).

Not IsNetTieComponent IsNetTieComponent = False IsNetTieComponent = 'False'
Returns all objects except component objects whose Component Type property is set to either Net Tie, or Net Tie (In BOM).

Note

The associated child primitive objects are not returned by this Query.

IsNoBOMComponent

Summary

Returns component objects whose Component Type property is Standard (No BOM). These components possess standard electrical properties, are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match), and are not included in the BOM. An example is a testpoint component, that you wish to exclude from the BOM.

Syntax

IsNoBOMComponent : Boolean/Boolean_String

Example Usage

IsNoBOMComponent IsNoBOMComponent = True IsNoBOMComponent = 'True'
Returns all component objects whose Component Type property is set to Standard (No BOM).

Not IsNoBOMComponent IsNoBOMComponent = False IsNoBOMComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Standard (No BOM).

Note

The associated child primitive objects are not returned by this Query.

IsOblique

Summary

Returns tracks of a diagonal nature (+/- 45 Degree angles), i.e. those tracks for which the absolute value of the difference between their Y1 and Y2 properties is equal to the absolute value of the difference between their X1 and X2 properties.

Syntax

IsOblique : Boolean/Boolean_String

Example Usage

IsOblique IsOblique = True IsOblique = 'True'
Returns all +/-45 Degree tracks.

Not IsOblique IsOblique = False IsOblique = 'False'
Returns all objects except +/-45 Degree tracks.

IsObliqueNegative

Summary

Returns -45 Degree angled tracks, i.e. those tracks for which the difference between their Y1 and Y2 properties is opposite in sign to, but otherwise equal to, the difference between their X1 and X2 properties.

Syntax

IsObliqueNegative : Boolean/Boolean_String

Example Usage

IsObliqueNegative IsObliqueNegative = True IsObliqueNegative = 'True'
Returns all -45 Degree tracks.

Not IsObliqueNegative IsObliqueNegative = False IsObliqueNegative = 'False'
Returns all objects except -45 Degree tracks.

IsObliquePositive

Summary

Returns +45 Degree angled tracks, i.e. those tracks for which the difference between their Y1 and Y2 properties is equal (including in sign) to the difference between their X1 and X2 properties.

Syntax

IsObliquePositive : Boolean/Boolean_String

Example Usage

IsObliquePositive IsObliquePositive = True IsObliquePositive = 'True'
Returns all +45 Degree tracks.

Not IsObliquePositive IsObliquePositive = False IsObliquePositive = 'False'
Returns all objects except +45 Degree tracks.

IsOctagonalPad

Summary

Returns all pad objects with an octagonal pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is octagonal.

Syntax

IsOctagonalPad : Boolean/Boolean_String

Example Usage

IsOctagonalPad IsOctagonalPad = True IsOctagonalPad = 'True'
Returns all pad objects with an octagonal pad shape.

Not IsOctagonalPad IsOctagonalPad = False IsOctagonalPad = 'False'
Returns all objects except pad objects with an octagonal pad shape.

IsOctagonalPadShapeOnLayer

Summary

Returns all pad objects with an octagonal pad shape on the specified layer.

Syntax

IsOctagonalPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsOctagonalPadShapeOnLayer('Top Layer') IsOctagonalPadShapeOnLayer('Top Layer') = True IsOctagonalPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with an octagonal pad shape on the Top Layer.

Not IsOctagonalPadShapeOnLayer('Bottom Layer') IsOctagonalPadShapeOnLayer('Bottom Layer') = False IsOctagonalPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with an octagonal pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsOvalPad

Summary

Returns all pad objects with an oval pad shape. An oval pad shape is formed from a Round pad shape, when the X-Size and Y-Size properties are set to be non-equal.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is oval.

Syntax

IsOvalPad : Boolean/Boolean_String

Example Usage

IsOvalPad IsOvalPad = True IsOvalPad = 'True'
Returns all pad objects with an oval pad shape.

Not IsOvalPad IsOvalPad = False IsOvalPad = 'False'
Returns all objects except pad objects with an oval pad shape.

IsOvalPadShapeOnLayer

Summary

Returns all pad objects with an oval pad shape on the specified layer. An oval pad shape is formed from a Round pad shape when the X-Size and Y-Size properties are set to be non-equal.

Syntax

IsOvalPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsOvalPadShapeOnLayer('Top Layer') IsOvalPadShapeOnLayer('Top Layer') = True IsOvalPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with an oval pad shape on the Top Layer.

Not IsOvalPadShapeOnLayer('Bottom Layer') IsOvalPadShapeOnLayer('Bottom Layer') = False IsOvalPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with an oval pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsPGA

Summary

Returns components that are of a PGA nature. Such a component contains at least 6 rows of pads and at least 6 columns of pads. The (absolute) difference between the number of rows of pads and the number of columns of pads, is less than 6. The total pad count is at least half of the product of the number of rows of pads and the number of columns of pads, and at least one (and typically all) of the pads are of a through-hole nature.

Syntax

IsPGA : Boolean/Boolean_String

Example Usage

IsPGA IsPGA = True IsPGA = 'True'
Returns all PGA components.

Not IsPGA IsPGA = False IsPGA = 'False'
Returns all objects except PGA components.

Note

The associated child primitive objects are not returned by this Query.

IsRectangularPad

Summary

Returns all pad objects with a rectangular pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is rectangular.

Syntax

IsRectangularPad : Boolean/Boolean_String

Example Usage

IsRectangularPad IsRectangularPad = True IsRectangularPad = 'True'
Returns all pad objects with a rectangular pad shape.

Not IsRectangularPad IsRectangularPad = False IsRectangularPad = 'False'
Returns all objects except pad objects with a rectangular pad shape.

IsRectangularPadShapeOnLayer

Summary

Returns all pad objects with a rectangular pad shape on the specified layer.

Syntax

IsRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsRectangularPadShapeOnLayer('Top Layer') IsRectangularPadShapeOnLayer('Top Layer') = True IsRectangularPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a rectangular pad shape on the Top Layer.

Not IsRectangularPadShapeOnLayer('Bottom Layer') IsRectangularPadShapeOnLayer('Bottom Layer') = False IsRectangularPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a rectangular pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsRoundedRectangularPad

Summary

Returns all pad objects with a rounded rectangular pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is rounded rectangular.

Syntax

IsRoundedRectangularPad : Boolean/Boolean_String

Example Usage

IsRoundedRectangularPad IsRoundedRectangularPad = True IsRoundedRectangularPad = 'True'
Returns all pad objects with a rounded rectangular pad shape.

Not IsRoundedRectangularPad IsRoundedRectangularPad = False IsRoundedRectangularPad = 'False'
Returns all objects except pad objects with a rounded rectangular pad shape.

IsRoundedRectangularPadShapeOnLayer

Summary

Returns all pad objects with a rounded rectangular pad shape on the specified layer.

Syntax

IsRoundedRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsRoundedRectangularPadShapeOnLayer('Top Layer') IsRoundedRectangularPadShapeOnLayer('Top Layer') = True IsRoundedRectangularPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a rounded rectangular pad shape on the Top Layer.

Not IsRoundedRectangularPadShapeOnLayer('Bottom Layer') IsRoundedRectangularPadShapeOnLayer('Bottom Layer') = False IsRoundedRectangularPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a rounded rectangular pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsRoundPad

Summary

Returns all pad objects with a round pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is round.

In addition to being Round in shape, the X-Size and Y-Size properties must be set to be equal, otherwise, the result will be an oval pad shape.

Syntax

IsRoundPad : Boolean/Boolean_String

Example Usage

IsRoundPad IsRoundPad = True IsRoundPad = 'True'
Returns all pad objects with a round pad shape.

Not IsRoundPad IsRoundPad = False IsRoundPad = 'False'
Returns all objects except pad objects with a round pad shape.

IsRoundPadShapeOnLayer

Summary

Returns all pad objects with a round pad shape on the specified layer.

In addition to being Round in shape, the X-Size and Y-Size properties must be set to be equal, otherwise, the result will be an oval pad shape.

Syntax

IsRoundPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsRoundPadShapeOnLayer('Top Layer') IsRoundPadShapeOnLayer('Top Layer') = True IsRoundPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a round pad shape on the Top Layer.

Not IsRoundPadShapeOnLayer('Bottom Layer') IsRoundPadShapeOnLayer('Bottom Layer') = False IsRoundPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a round pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsSelected

Summary

Returns all objects that are currently selected in the design workspace.

Syntax

IsSelected : Boolean/Boolean_String

Example Usage

IsSelected IsSelected = True IsSelected = 'True'
Returns all objects that are currently selected in the design workspace.

Not IsSelected IsSelected = False IsSelected = 'False'
Returns all objects except objects that are currently selected in the design workspace.

IsSIP

Summary

Returns components that are of a SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, at least one (and typically all) of these pads are of a through-hole nature.

Syntax

IsSIP : Boolean/Boolean_String

Example Usage

IsSIP IsSIP = True IsSIP = 'True'
Returns all SIP components.

Not IsSIP IsSIP = False IsSIP = 'False'
Returns all objects except SIP components.

Note

The associated child primitive objects are not returned by this Query.

IsSMSIP

Summary

Returns components that are of a Surface Mount SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, all of these pads are of a surface-mount nature.

Syntax

IsSMSIP : Boolean/Boolean_String

Example Usage

IsSMSIP IsSMSIP = True IsSMSIP = 'True'
Returns all SMSIP components.

Not IsSMSIP IsSMSIP = False IsSMSIP = 'False'
Returns all objects except SMSIP components.

Note

The associated child primitive objects are not returned by this Query.

IsSMTComponent

Summary

Returns components that are of an SMT nature. All of the pads of such a component are of a surface-mount nature.

Syntax

IsSMTComponent : Boolean/Boolean_String

Example Usage

IsSMTComponent IsSMTComponent = True IsSMTComponent = 'True'
Returns all SMT components.

Not IsSMTComponent IsSMTComponent = False IsSMTComponent = 'False'
Returns all objects except SMT components.

Note

The associated child primitive objects are not returned by this Query.

IsSMTPin

Summary

Returns all pad objects that are Surface Mount in nature, that is, those whose Hole Size property is set to 0.

Surface mount pads are located on signal layers, and not the Multi-Layer.

Syntax

IsSMTPin : Boolean/Boolean_String

Example Usage

IsSMTPin IsSMTPin = True IsSMTPin = 'True'
Returns all surface mount pads.

Not IsSMTPin IsSMTPin = False IsSMTPin = 'False'
Returns all objects except surface mount pads.

IsSOIC

Summary

Returns components that are of a Surface Mount DIP (SOIC) nature. All of the pads of such a component are of a surface-mount nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

IsSOIC : Boolean/Boolean_String

Example Usage

IsSOIC IsSOIC = True IsSOIC = 'True'
Returns all SOIC components.

Not IsSOIC IsSOIC = False IsSOIC = 'False'
Returns all objects except SOIC components.

Note

The associated child primitive objects are not returned by this Query.

IsSquarePad

Summary

Returns all pad objects with a square pad shape. A square pad shape is formed from a Rounded Rectangle pad shape, when the X-Size and Y-Size properties are set to be equal

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is square.

Syntax

IsSquarePad : Boolean/Boolean_String

Example Usage

IsSquarePad IsSquarePad = True IsSquarePad = 'True'
Returns all pad objects with a square pad shape.

Not IsSquarePad IsSquarePad = False IsSquarePad = 'False'
Returns all objects except pad objects with a square pad shape.

IsSquarePadShapeOnLayer

Summary

Returns all pad objects with a square pad shape on the specified layer. A square pad shape is formed from a Rounded Rectangle pad shape when the X-Size and Y-Size properties are set to be equal.

Syntax

IsSquarePadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

IsSquarePadShapeOnLayer('Top Layer') IsSquarePadShapeOnLayer('Top Layer') = True IsSquarePadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a square pad shape on the Top Layer.

Not IsSquarePadShapeOnLayer('Bottom Layer') IsSquarePadShapeOnLayer('Bottom Layer') = False IsSquarePadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a square pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

IsStandardComponent

Summary

Returns component objects whose Component Type property is Standard. These components possess standard electrical properties, are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match), and are included in the BOM. An example is a standard electrical component, such as a resistor.

Syntax

IsStandardComponent : Boolean/Boolean_String

Example Usage

IsStandardComponent IsStandardComponent = True IsStandardComponent = 'True'
Returns all component objects whose Component Type property is set to Standard.

Not IsStandardComponent IsStandardComponent = False IsStandardComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Standard.

Note

The associated child primitive objects are not returned by this Query.

IsSubnetJumper

Summary

Returns all subnet jumper objects.

Syntax

IsSubnetJumper : Boolean/Boolean_String

Example Usage

IsSubnetJumper IsSubnetJumper = True IsSubnetJumper = 'True'
Returns all subnet jumper objects.

Not IsSubnetJumper IsSubnetJumper = False IsSubnetJumper = 'False'
Returns all objects except subnet jumper objects.

IsThruComponent

Summary

Returns components that are of a Thru-Hole nature. At least one (and typically all) of the pads of such a component are of a through-hole nature.

Syntax

IsThruComponent : Boolean/Boolean_String

Example Usage

IsThruComponent IsThruComponent = True IsThruComponent = 'True'
Returns all Thru-Hole components.

Not IsThruComponent IsThruComponent = False IsThruComponent = 'False'
Returns all objects except Thru-Hole components.

Note

The associated child primitive objects are not returned by this Query.

IsThruPin

Summary

Returns all pad objects that are Thru-Hole in nature, that is, those whose Hole Size property is set to a value other than 0.

Thru-Hole pads are located on the Multi-Layer.

Syntax

IsThruPin : Boolean/Boolean_String

Example Usage

IsThruPin IsThruPin = True IsThruPin = 'True'
Returns all Thru-Hole pads.

Not IsThruPin IsThruPin = False IsThruPin = 'False'
Returns all objects except Thru-Hole pads.

IsUserRouted

Summary

Returns all design objects placed manually by the user.

Syntax

IsUserRouted : Boolean/Boolean_String

Example Usage

IsUserRouted IsUserRouted = True IsUserRouted = 'True'
Returns all design objects placed manually by the user. All objects placed as a result of an Autorouting process are not returned.

Not IsUserRouted IsUserRouted = False IsUserRouted = 'False'
Returns all objects except design objects placed manually by the user.

IsVertical

Summary

Returns vertical tracks, i.e. those tracks whose X1 and X2 properties are identical.

Syntax

IsVertical : Boolean/Boolean_String

Example Usage

IsVertical IsVertical = True IsVertical = 'True'
Returns all vertical tracks.

Not IsVertical IsVertical = False IsVertical = 'False'
Returns all objects except vertical tracks.

IsWire

Summary

Returns all arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

Syntax

IsWire : Boolean/Boolean_String

Example Usage

IsWire IsWire = True IsWire = 'True'
Returns all arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

Not IsWire IsWire = False IsWire = 'False'
Returns all objects except arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

ManHat

Summary

Returns tracks whose Manhattan Length complies with the Query.
The Manhattan Length of a track is determined by adding the absolute value of the difference between its X1 and X2 properties, to the absolute value of the difference between its Y1 and Y2 properties. The terminology is derived from Manhattan Island, in New York City, where the streets are laid out in a rectangular pattern.

Syntax

ManHat : Number

The entered length is always in units of mils, irrespective of the measurement unit chosen for the board (1 mil = 0.001 inch).

Example Usage

ManHat = 300
Returns all tracks whose Manhattan Length is equal to 300mil.

ManHat >= 500
Returns all tracks whose Manhattan Length is greater than, or equal to, 500mil.

ManHat > 400
Returns all tracks whose Manhattan Length is greater than 400mil.

ManHat Between 30 And 40
Returns all tracks whose Manhattan Length is greater than, or equal to, 30mil and less than, or equal to, 40mil.

ManHat <> 500
Returns all tracks whose Manhattan Length is is not equal to 500mil.

NetLength

Summary

Returns Net objects where the total length of arcs and tracks in those nets complies with the Query.

The length of each track is the (Pythagorean) distance between its end points, and is equal to SQRT(SQR(X1 - X2) + SQR(Y1 - Y2)), where X1, Y1 are the coordinates of one end of the track, and X2, Y2 are the coordinates of its other end. The length of each arc is the product of its Radius and the difference between its End Angle and Start Angle when that difference is measured in units of radians (180 degrees = pi radians).

Syntax

NetLength : Number

The entered length is always in units of mils, irrespective of the measurement unit chosen for the board (1 mil = 0.001 inch).

Example Usage

NetLength = 30000
Returns all Net objects where the total length of arcs and tracks in those nets is equal to 30000mil.

NetLength >= 15000
Returns all Net objects where the total length of arcs and tracks in those nets is greater than or equal to 15000mil.

NetLength <> 5500
Returns all Net objects where the total length of arcs and tracks in those nets is not equal to 5500mil.

Note

The associated child objects of the complying Net objects are also returned.

NetPinCount

Summary

Returns Net objects where the total number of pads in those nets complies with the Query.

Syntax

NetPinCount : Number

Example Usage

NetPinCount Between 12 And 30
Returns all Net objects where the total number of pads in those nets is greater than or equal to 12 and less than or equal to 30.

NetPinCount > 10
Returns all Net objects where the total number of pads in those nets is greater than 10.

Note

The associated child objects of the complying Net objects are also returned.

NetViaCount

Summary

Returns Net objects where the total number of vias in those nets complies with the Query.

Syntax

NetViaCount : Number

Example Usage

NetViaCount Between 8 And 20
Returns all Net objects where the total number of vias in those nets is greater than or equal to 8 and less than or equal to 20.

NetViaCount < 6
Returns all Net objects where the total number of vias in those nets is less than 6.

Note

The associated child objects of the complying Net objects are also returned.

RowCount

Summary

Returns component objects whose number of rows of pads complies with the Query.

Syntax

RowCount : Number

Example Usage

RowCount = 8
Returns all components that have exactly 8 rows of pads.

RowCount Between 6 And 10
Returns all components that have between 6 and 10 rows of pads (inclusive).

RowCount < 4
Returns all objects except components that have 4 rows of pads, or more.

Note

The associated child objects of the complying component objects are also returned.

TraceCopperHeight

Summary

Returns all arc, fill, and track objects, on signal layers whose copper thickness complies with the Query.

The Copper Thickness for a signal layer is defined within the Layer Stack Manager (Design » Layer Stack Manager).

Arc, fill, and track objects on the Multi-Layer are not returned. Because different signal layers can have different Copper Thickness properties, a Copper Thickness property for the Multi-Layer is not always meaningful.

Syntax

TraceCopperHeight : Number

The entered thickness is always in units of mils, regardless of the measurement unit chosen for the board (1 mil = 0.001 inch).

Example Usage

TraceCopperHeight = 1.4
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 1.4mil.

TraceCopperHeight Between 1.1 And 1.5
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.1mil, and less than, or equal to, 1.5mil.

TraceCopperHeight >= 1.2
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.2mil.

TraceCopperHeight < 1.3
Returns all objects except arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.3mil.

TraceCopperHeight = 2.8 || (IsArc Or IsFill Or IsTrack && OnMultiLayer)
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 2.8mil, and all arc, fill and track objects on the Multi-Layer.

Note

This function is an alias for the TraceHeight function.

TraceHeight

Summary

Returns all arc, fill, and track objects, on signal layers whose copper thickness complies with the Query.

The Copper Thickness for a signal layer is defined within the Layer Stack Manager (Design » Layer Stack Manager).

Syntax

TraceHeight : Number

The entered thickness is always in units of mils regardless of the measurement unit chosen for the board (1 mil = 0.001 inch).

Example Usage

TraceHeight = 1.4
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 1.4mil.

TraceHeight Between 1.1 And 1.5
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.1mil, and less than, or equal to, 1.5mil.

TraceHeight >= 1.2
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.2mil.

TraceHeight < 1.3
Returns all objects except arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.3mil.

TraceHeight = 2.8 || (IsArc Or IsFill Or IsTrack && OnMultiLayer)
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 2.8mil, and all arc, fill and track objects on the Multi-Layer.

Note

This function is an alias for the TraceCopperHeight function.

TraceLength

Summary

Returns arc and track objects on signal layers, whose length complies with the Query.

The length of each track is the (Pythagorean) distance between its endpoints and is equal to SQRT(SQR(X1 - X2) + SQR(Y1 - Y2)), where X1, Y1 are the coordinates of one end of the track, and X2, Y2 are the coordinates of its other end. The length of each arc is the product of its Radius and the difference between its End Angle and Start Angle, when that difference is measured in units of radians. (180 degrees = pi radians.)

Syntax

TraceLength : Number

The entered length is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch). To target an object using metric measurements, use the AsMM query keyword, for example, AsMM(Width) < 1.5 or, AsMM(Width) Between 1 And 1.2. Learn more about AsMM.

Example Usage

TraceLength Between 400 And 1800
Returns all arc and track objects that have a length between 400mil and 1800mil (inclusive).

TraceLength > 300
Returns all arc and track objects that have a length that is greater than 300mil.

IsTrack AND OnTopLayer AND (AsMM(TraceLength) < 1)
Returns all track objects that are on the Top Layer and have a length less than 1mm.

Note - due to an issue in the software, to correctly detect a TraceLength using the AsMM keyword or the AsMils keyword, the board units must be set to imperial before running the query.

Printer-friendly version

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.