Schematic Membership Checks Query Language Keywords in Altium Designer

Summary

For numeric properties of objects (e.g. length, width, radius, etc), this keyword is used to convert the current value - measured in the default design space units - into metric units - cm - where 1cm = 0.01meter, which is then tested against the value entered in the expression.

Syntax

AsCM(Keyword : Number) : Number

Example Usage

IsArc And (AsCM(Radius) = 0.56)
Returns all arc objects that have a Radius property which is 0.56cm.

IsPort And (AsCM(Width) Between 1.27 And 2.79)
Returns all port objects that have a Width property that is greater than or equal to 1.27cm and less than or equal to 2.79cm.

Summary

For numeric properties of objects (e.g., length, width, radius, etc.), this keyword is used to convert the current value - measured in the default design space units - into imperial units - DXP Defaults (DXPs) - where 1DXP = 10mils, which is then tested against the value entered in the expression.

Syntax

AsDXPs(Keyword : Number) : Number

Example Usage

IsArc And (AsDXPs(Radius) = 21.91)
Returns all arc objects that have a Radius property which is 21.91DXPs.

IsPort And (AsDXPs(Width) Between 50 And 150)
Returns all port objects that have a Width property that is greater than, or equal to, 50DXPs, and less than, or equal to, 150DXPs.

Summary

For numeric properties of objects (e.g., length, width, radius, etc.), this keyword is used to convert the current value - measured in the default design space units - into inches, which is then tested against the value entered in the expression.

Syntax

AsInches(Keyword : Number) : Number

Example Usage

IsArc And (AsInches(Radius) = 0.219)
Returns all arc objects that have a Radius property which is 0.219in.

IsPort And (AsInches(Height) Between 0.254 And 0.294)
Returns all port objects that have a Height property that is greater than, or equal to, 0.254in, and less than, or equal to, 0.294in.

Summary

For numeric properties of objects (e.g., length, width, radius, etc.), this keyword is used to convert the current value - measured in the default design space units - into meters, which is then tested against the value entered in the expression.

Syntax

AsMetres(Keyword : Number) : Number

Example Usage

IsArc And (AsMetres(Radius) = 0.01)
Returns all arc objects that have a Radius property which is 0.01m.

IsPort And (AsMetres(Width) Between 0.01 And 0.02)
Returns all port objects that have a Width property that is greater than, or equal to, 0.01m, and less than, or equal to, 0.02m.

Summary

For numeric properties of objects (e.g., length, width, radius, etc.), this keyword is used to convert the current value - measured in the default design space units - into imperial units - mil - where 1mil = 0.001inch, which is then tested against the value entered in the expression.

Syntax

AsMils(Keyword : Number) : Number

Example Usage

IsArc And (AsMils(Radius) = 250)
Returns all arc objects that have a Radius property which is 250mil.

IsPort And (AsMils(Height) Between 100 And 120)
Returns all port objects that have a Height property that is greater than, or equal to, 100mil, and less than, or equal to, 120mil.

Summary

For numeric properties of objects (e.g., length, width, radius, etc.), this keyword is used to convert the current value - measured in the default design space units - into metric units - mm - where 1mm = 0.001meter, which is then tested against the value entered in the expression.

Syntax

AsMM(Keyword : Number) : Number

Example Usage

IsArc And (AsMM(Radius) = 6.29)
Returns all arc objects that have a Radius property which is 6.29mm.

IsPort And (AsMM(Height) Between 2.54 And 2.64)
Returns all port objects that have a Height property that is greater than, or equal to 2.54mm and less than, or equal to, 2.64mm.

Summary

Returns each part object that is linked to (or references) a footprint model whose properties comply with the Query.

Syntax

HasFootprint(ModelName : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The ModelName string specifies the Name property of the linked footprint model.

The CurrentModelOnly parameter specifies whether or not the linked footprint model has to be the Current Footprint for each part. When this is False, the linked footprint model does not have to be the Current Footprint (but it still can be); when this is True, the linked footprint model does have to be the Current Footprint.

Example Usage

HasFootprint('SOIC14',False)
HasFootprint('SOIC14',False) = True
HasFootprint('SOIC14',False) = 'True'
Returns all part objects that are linked to a Footprint Model whose Name property is SOIC14; that Model does not have to be each part's Current Footprint (but it can be).

HasFootprint('DIP14',True)
HasFootprint('DIP14',True) = True
HasFootprint('DIP14',True) = 'True'
Returns all part objects that are linked to a Footprint Model whose Name property is DIP14; that Model must be the Current Footprint for the part.

Summary

Returns each part object that is linked to (or references) a domain model whose properties comply with the Query.

Syntax

HasModel(ModelType : String,ModelName : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The ModelType string specifies the Type property of a linked model and must be one of the strings from the following list:

• 'PCBLIB' - use this string to target a linked model whose Type property is Footprint.
• 'IBIS' - use this string to target a linked model whose Type property is Ibis Model.
• 'SI' - use this string to target a linked model whose Type property is Signal Integrity.
• 'SIM' - use this string to target a linked model whose Type property is Simulation.
• 'FPGA'- use this string to target a linked model whole Type property is FPGA.

The ModelName string specifies the Name property of a linked Model.

The CurrentModelOnly parameter specifies whether or not the linked model has to be a Current Model of each part. When this is False, the linked model does not have to be a Current Model (but it still can be); when this is True, the linked model does have to be a Current Model.

Example Usage

HasModel('PCBLIB','SOIC14',False)
HasModel('PCBLIB','SOIC14',False) = True
HasModel('PCBLIB','SOIC14',False) = 'True'
Returns all part objects that are linked to a Footprint Model whose Name property is SOIC14; that Model does not have to be each part's Current Footprint Model (but it can be).

HasModel('PCBLIB','DIP14',True)
HasModel('PCBLIB','DIP14',True) = True
HasModel('PCBLIB','DIP14',True) = 'True'
Returns all part objects that are linked to a Footprint Model whose Name property is DIP14; that Model must be the Current Footprint Model for the part.

HasModel('SI','RES1',False)
HasModel('SI','RES1',False) = True
HasModel('SI','RES1',False) = 'True'
Returns all part objects that are linked to a Signal Integrity Model whose Name property is RES1; that Model does not have to be each Part's Current Signal Integrity Model (but it can be).

HasModel('SIM','RESISTOR',True)
HasModel('SIM','RESISTOR',True) = True
HasModel('SIM','RESISTOR',True) = 'True'
Returns all part objects that are linked to a Simulation Model whose Name property is RESISTOR; that Model must be the Current Simulation Model for the part.

Summary

Returns each part object that is linked to (or references) a domain model, containing a parameter object whose Parameter Name and Value properties comply with the Query.

Syntax

HasModelParameter(Parameter Name : String,Value : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The CurrentModelOnly parameter specifies whether or not the linked model (which contains a compliant parameter) has to be a Current Model of each part. When this is False, the linked model does not have to be a Current Model (but it still can be); when this is True, the linked model does have to be a Current Model.

Example Usage

HasModelParameter('Inductance A','1mH',False)
HasModelParameter('Inductance A','1mH',False) = True
HasModelParameter('Inductance A','1mH',False) = 'True'
Returns all part objects that are linked to a model that contains a parameter object whose Parameter Name property is Inductance A, and whose Value property is 1mH. That model does not have to be a Current Model of each Part (but it can be).

HasModelParameter('Coupling Factor','0.999',True)
HasModelParameter('Coupling Factor','0.999',True) = True
HasModelParameter('Coupling Factor','0.999',True) = 'True'
Returns all part objects that are linked to a model that contains a parameter object whose Parameter Name property is Coupling Factor, and whose Value property is 0.999. That model must be a Current Model of the Part.

Summary

Returns all parameter set, part, pin, port, probe, and sheet symbol objects containing a parameter object whose Parameter Name and Value properties comply with the Query.

Syntax

HasParameter(Parameter Name : String,Value : String) : Boolean/Boolean_String

Example Usage

HasParameter('Comment','1K')
HasParameter('Comment','1K') = True
HasParameter('Comment','1K') = 'True'
Returns all parameter set, part, pin, port, probe, and sheet symbol objects that contain a parameter object whose Parameter Name property is Comment, and whose Value property is 1K.

Summary

Returns all part objects containing a pin object whose Pin Designator and Name properties comply with the Query.

Syntax

HasPin(Pin Designator : String,Name : String) : Boolean/Boolean_String

Example Usage

HasPin('7','GND')
HasPin('7','GND') = True
HasPin('7','GND') = 'True'
Returns all child objects of all part objects that contain a pin object whose Pin Designator property is 7, and whose Name property is GND.

Summary

Returns all sheet symbol objects containing a sheet entry whose Name property complies with the Query.

Syntax

HasSheetEntry(Sheet Entry Name : String) : Boolean/Boolean_String

Example Usage

HasSheetEntry('CLK')
HasSheetEntry('CLK') = True
HasSheetEntry('CLK') = 'True'
Returns all sheet symbol objects that contain a sheet entry object whose Name property is CLK.

Summary

Returns the part objects whose Component Designator property complies with the Query.

Syntax

InComponent(Component Designator 1 : String,Component Designator 2 : String,...,Component Designator n : String) : Boolean/Boolean_String

Example Usage

InComponent('U1')
InComponent('U1') = True
InComponent('U1') = 'True'
Returns the part objects whose Component Designator property is U1.

InComponent('U1','J1','R1')
InComponent('U1','J1','R1') = True
InComponent('U1','J1','R1') = 'True'
Returns the part objects whose Component Designator property is U1, or J1, or R1.

Notes

• The child objects of the returned part objects are not returned.

• This keyword is an alias for the InPart keyword.

Summary

Returns the part objects whose Component Designator property complies with the Query.

Syntax

InPart(Component Designator 1 : String,Component Designator 2 : String,...,Component Designator n : String) : Boolean/Boolean_String

Example Usage

InPart('U1')
InPart('U1') = True
InPart('U1') = 'True'
Returns the part objects whose Component Designator property is U1.

InPart('U1','J1','R1')
InPart('U1','J1','R1') = True
InPart('U1','J1','R1') = 'True'
Returns the part objects whose Component Designator property is U1, or J1, or R1.

Notes

• The child objects of the returned part objects are not returned.

• This keyword is an alias for the InComponent keyword.

Summary

Returns the sheet symbol object whose Sheet Name property complies with the Query.

Syntax

InSheetSymbol(Sheet Name : String) : Boolean/Boolean_String

Example Usage

InSheetSymbol('Accelerometer')
InSheetSymbol('Accelerometer') = True
InSheetSymbol('Accelerometer') = 'True'
Returns the sheet symbol object whose Sheet Name property is Accelerometer.

Note

The child objects of the returned sheet symbol object are not returned.

Summary

Returns all child objects of each harness connector, port, and sheet symbol object whose Fill Color property complies with the Query.

Syntax

Object_AreaColor(Parent) : Numeric_String
Object_AreaColor(Parent) : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Object_AreaColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Fill Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Fill Color Div 65536
• Green = Fill Color Div 256 Mod 256
• Red = Fill Color Mod 256

Example Usage

Object_AreaColor(Parent) = '0'
Object_AreaColor(Parent) <> '' && Object_AreaColor(Parent) = 0
Returns all child objects of each parent object whose Fill Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Object_AreaColor(Parent) = '16711680'
Object_AreaColor(Parent) > '' && Object_AreaColor(Parent) = 16711680
Returns all child objects of each parent object whose Fill Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Object_AreaColor(Parent) <> '16777215'
Returns all objects except child objects of each parent object whose Fill Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

Object_AreaColor(Parent) > '' && Object_AreaColor(Parent) Div 65536 >= 96 && Object_AreaColor(Parent) Div 256 Mod 256 Between 64 And 192 && Object_AreaColor(Parent) Mod 256 <= 128
Returns all child objects of each parent object – except parts – whose Fill Color property is such that the Blue component has a value that is greater than or equal to 96, the Green component has a value that is greater than or equal to 64 and less than or equal to 192, and the Red component has a value that is less than or equal to 128.

Object_ObjectKind(Parent) = 'Port' && Object_AreaColor(Parent) Div 65536 <= 192
Returns all child objects of port objects whose Fill Color property's Blue component has a value that is less than or equal to 192.

Object_ObjectKind(Parent) = 'Sheet Symbol' && Object_AreaColor(Parent) Mod 256 Between 64 And 192
Returns all child objects of sheet symbol objects whose Fill Color property's Red component has a value that is greater than or equal to 64 and less than or equal to 192.

Summary

Returns all child objects of each port object whose Arrow Style property complies with the Query.

Syntax

Object_ArrowStyle(Parent) = PortArrowStyle_String
Object_ArrowStyle(Parent) <> PortArrowStyle_String

PortArrowStyle_String must be one of the strings from the following list:

• 'Bottom'
• 'Left'
• 'Left & Right'
• 'None (Horizontal)'
• 'None (Vertical)'
• 'Right'
• 'Top'
• 'Top & Bottom'

Example Usage

Object_ArrowStyle(Parent) = 'Left'
Returns all child objects of all port objects whose Arrow Style property is Left.

Object_ArrowStyle(Parent) <> 'Bottom'
Returns all objects except child objects of port objects whose Arrow Style property is Bottom.

Object_ArrowStyle(Parent) <> '' && Object_ArrowStyle(Parent) <> 'Right'
Object_ArrowStyle(Parent) > '' && Object_ArrowStyle(Parent) <> 'Right'
Object_ObjectKind(Parent) = 'Port' && Object_ArrowStyle(Parent) <> 'Right'
Returns all child objects of all port objects, except those port objects whose Arrow Style property is Right.

Summary

Returns all child objects of each harness connector, parameter set, pin, port, and sheet symbol objects whose Color property complies with the Query.

Syntax

Object_Color(Parent) : Numeric_String
Object_Color(Parent) : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Object_Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Color Div 65536
• Green = Color Div 256 Mod 256
• Red = Color Mod 256

Example Usage

Object_Color(Parent) = '0'
Object_Color(Parent) <> '' && Object_Color(Parent) = 0
Returns all child objects of each parent object whose Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Object_Color(Parent) = '16711680'
Object_Color(Parent) > '' && Object_Color(Parent) = 16711680
Returns all child objects of each parent object whose Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Object_Color(Parent) <> '16777215'
Returns all objects except child objects of each parent object whose Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

Object_ObjectKind(Parent) <> 'Part' && Object_Color(Parent) <> 16777215
Returns all child objects of each parent object – except parts – whose Color property is 16777215.

Object_Color(Parent) > '' && Object_Color(Parent) Div 65536 >= 96 && Object_Color(Parent) Div 256 Mod 256 Between 64 And 192 && Object_Color(Parent) Mod 256 <= 128
Returns all child objects of each parent object – except parts – whose Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

Object_ObjectKind(Parent) = 'Parameter Set' && Object_Color(Parent) Div 65536 <= 192
Returns all child objects of parameter set objects whose Color property's Blue component has a value that is less than or equal to 192.

Object_ObjectKind(Parent) = 'Port' && Object_Color(Parent) Mod 256 Between 64 And 192
Returns all child objects of port objects whose Color property's Red component has a value that is greater than or equal to 64 and less than or equal to 192.

Summary

Returns all child objects of all part objects whose Part Comment property complies with the Query.

Syntax

Object_Comment(Parent) : String

Example Usage

Object_Comment(Parent) = '1488'
Returns all child objects of all part objects whose Part Comment property is 1488.

Summary

Returns all child objects of all part objects whose Component Type property complies with the Query.

Syntax

Object_ComponentType(Parent) = ComponentType_String

Object_ComponentType(Parent) <> ComponentType_String

ComponentType_String must be one of the strings from the following list:

• 'Graphical'
• 'Jumper'
• 'Mechanical'
• 'Net Tie'
• 'Net Tie (In BOM)'
• 'Standard'
• 'Standard (No BOM)'

Example Usage

Object_ComponentType(Parent) = 'Net Tie (In BOM)'
Returns all child objects of all part objects whose Component Type property is Net Tie (In BOM).

Object_ComponentType(Parent) <> 'Standard'
Returns all objects except child objects of part objects whose Component Type property is Standard.

Object_ComponentType(Parent) <> '' && Object_ComponentType(Parent) <> 'Standard'
Object_ComponentType(Parent) > '' && Object_ComponentType(Parent) <> 'Standard'
Object_ObjectKind(Parent) = 'Part' && Object_ComponentType(Parent) <> 'Standard'
Returns all child objects of all part objects whose Component Type property is not Standard.

Notes

• The Component Type property is only defined for part objects.
• The single quote characters (') at the start and end of ComponentType_String are mandatory.

Summary

Returns all child objects of each part object whose Current Footprint property complies with the Query.

Syntax

Object_CurrentFootprint(Parent) : String

Example Usage

Object_CurrentFootprint(Parent) = 'DIP14'
Returns all child objects of part objects whose Current Footprint property is DIP14.

Object_CurrentFootprint(Parent) Like 'SIP?*'
Returns all child objects of part objects whose Current Footprint property starts with SIP and contains at least one more following character.

Summary

Returns all child objects of each part object whose Database Table Name property complies with the Query.

Syntax

Object_DatabaseTableName(Parent) : String

Example Usage

Object_DatabaseTableName(Parent) = 'Tantalum_Capacitors'
Returns all child objects of part objects whose Database Table Name property is Tantalum_Capacitors.

Object_DatabaseTableName(Parent) Like '*Res*'
Returns all child objects of part objects whose Database Table Name property includes Res.

Summary

Returns all child objects of each part object whose Component Designator property complies with the Query.

Syntax

Object_Designator(Parent) : String

Example Usage

Object_Designator(Parent) = 'U2'
Returns all child objects of part objects whose Component Designator property is U2.

Object_Designator(Parent) Like '*Channel*'
Returns all child objects of part objects whose Component Designator property includes Channel.

Summary

Returns all child objects of each part object whose Lock Designator property complies with the Query.

Syntax

Object_DesignatorLocked(Parent) : Boolean_String

Example Usage

Object_DesignatorLocked(Parent) = 'True'
Returns all child objects of part objects whose Lock Designator property is enabled.

Object_DesignatorLocked(Parent) = 'False'
Returns all child objects of part objects whose Lock Designator property is disabled.

Summary

Returns all child objects of each part object whose Design Item ID property complies with the Query.

Syntax

Object_DesignItemID(Parent) : String

Example Usage

Object_DesignItemID(Parent) = 'LM833'
Returns all child objects of part objects whose Design Item ID property is LM833.

Object_DesignItemID(Parent) Like '*Osc*'
Returns all child objects of part objects whose Design Item ID property includes Osc.

Summary

Returns all child objects of each pin object whose Electrical Type property complies with the Query.

Syntax

Object_ElectricalType(Parent) = ElectricalType_String
Object_ElectricalType(Parent) <> ElectricalType_String

ElectricalType_String must be one of the strings from the following list:

• 'HiZ'
• 'Input'
• 'I/O'
• 'Open Collector'
• 'Open Emitter'
• 'Output'
• 'Passive'
• 'Power'

Example Usage

Object_ElectricalType(Parent) = 'Power'
Returns all child objects of all pin objects whose Electrical Type property is Power.

Object_ElectricalType(Parent) <> 'HiZ'
Returns all objects except child objects of pin objects whose Electrical Type property is HiZ.

Object_ElectricalType(Parent) <> '' && Object_ElectricalType(Parent) <> 'HiZ'
Object_ElectricalType(Parent) > '' && Object_ElectricalType(Parent) <> 'HiZ'
Object_ObjectKind(Parent) = 'Pin' && Object_ElectricalType(Parent) <> 'HiZ'
Returns all child objects of all pin objects, except those pin objects whose Electrical Type property is HiZ.

Summary

Returns all child objects of each part object that is linked to (or references) a footprint model whose properties comply with the Query.

Syntax

Object_HasFootprint(Parent,ModelName : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The ModelName string specifies the Name property of the linked footprint model.

The CurrentModelOnly parameter specifies whether or not the linked footprint model has to be the Current Footprint for each part. When this is False, the linked footprint model does not have to be the Current Footprint (but it still can be); when this is True, the linked footprint model does have to be the Current Footprint.

Example Usage

Object_HasFootprint(Parent,'SOIC14',False)
Object_HasFootprint(Parent,'SOIC14',False) = True
Object_HasFootprint(Parent,'SOIC14',False) = 'True'
Returns all child objects of part objects that are linked to a Footprint Model whose Name property is SOIC14; that Model does not have to be each part's Current Footprint (but it can be).

Object_HasFootprint(Parent,'DIP14',True)
Object_HasFootprint(Parent,'DIP14',True) = True
Object_HasFootprint(Parent,'DIP14',True) = 'True'
Returns all child objects of part objects that are linked to a Footprint Model whose Name property is DIP14; that Model must be the Current Footprint for the part.

Summary

Returns all child objects of each part object that is linked (or references) to a domain model whose properties comply with the Query.

Syntax

Object_HasModel(Parent,ModelType : String,ModelName : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The ModelType string specifies the Type property of a linked model, and must be one of the strings from the following list:

• 'PCBLIB' - use this string to target a linked model whose Type property is Footprint.
• 'IBIS' - use this string to target a linked model whose Type property is Ibis Model.
• 'SI' - use this string to target a linked model whose Type property is Signal Integrity.
• 'SIM' - use this string to target a linked model whose Type property is Simulation.
• 'FPGA' - use this string to target a linked model whose Type property is FPGA.

The ModelName string specifies the Name property of a linked Model.

The CurrentModelOnly parameter specifies whether or not the linked model has to be a Current Model of each part. When this is False, the linked model does not have to be a Current Model (but it still can be); when this is True, the linked model does have to be a Current Model.

Example Usage

Object_HasModel(Parent,'PCBLIB','SOIC14',False)
Object_HasModel(Parent,'PCBLIB','SOIC14',False) = True
Object_HasModel(Parent,'PCBLIB','SOIC14',False) = 'True'
Returns all child objects of part objects that are linked to a Footprint Model whose Name property is SOIC14; that Model does not have to be each part's Current Footprint Model (but it can be).

Object_HasModel(Parent,'PCBLIB','DIP14',True)
Object_HasModel(Parent,'PCBLIB','DIP14',True) = True
Object_HasModel(Parent,'PCBLIB','DIP14',True) = 'True'
Returns all child objects of part objects that are linked to a Footprint Model whose Name property is DIP14; that Model must be the Current Footprint Model for the part.

Object_HasModel(Parent,'SI','RES1',False)
Object_HasModel(Parent,'SI','RES1',False) = True
Object_HasModel(Parent,'SI','RES1',False) = 'True'
Returns all child objects of part objects that are linked to a Signal Integrity Model whose Name property is RES1; that Model does not have to be each Part's Current Signal Integrity Model (but it can be).

Object_HasModel(Parent,'SIM','RESISTOR',True)
Object_HasModel(Parent,'SIM','RESISTOR',True) = True
Object_HasModel(Parent,'SIM','RESISTOR',True) = 'True'
Returns all child objects of part objects that are linked to a Simulation Model whose Name property is RESISTOR; that Model must be the Current Simulation Model for the part.

Summary

Returns all child objects of each part object that is linked (or references) to a domain model, containing a parameter object whose Parameter Name and Value properties comply with the Query.

Syntax

Object_HasModelParameter(Parent,Parameter Name : String,Value : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The CurrentModelOnly parameter specifies whether or not the linked model (which contains a compliant parameter) has to be a Current Model of each part. When this is False, the linked model does not have to be a Current Model (but it still can be); when this is True, the linked model does have to be a Current Model.

Example Usage

Object_HasModelParameter(Parent,'Inductance A','1mH',False)
Object_HasModelParameter(Parent,'Inductance A','1mH',False) = True
Object_HasModelParameter(Parent,'Inductance A','1mH',False) = 'True'
Returns all child objects of part objects that are linked to a model that contains a parameter object whose Parameter Name property is Inductance A and whose Value property is 1mH. That model does not have to be a Current Model of each Part (but it can be).

Object_HasModelParameter(Parent,'Coupling Factor','0.999',True)
Object_HasModelParameter(Parent,'Coupling Factor','0.999',True) = True
Object_HasModelParameter(Parent,'Coupling Factor','0.999',True) = 'True'
Returns all child objects of part objects that are linked to a model that contains a parameter object whose Parameter Name property is Coupling Factor and whose Value property is 0.999. That model must be a Current Model of the Part.

Summary

Returns all child objects of all parameter set, part, pin, port, probe, and sheet symbol objects, containing a parameter object whose Parameter Name and Value properties comply with the Query.

Syntax

Object_HasParameter(Parent,Parameter Name : String,Value : String) : Boolean/Boolean_String

Example Usage

Object_HasParameter(Parent,'Comment','1K')
Object_HasParameter(Parent,'Comment','1K') = True
Object_HasParameter(Parent,'Comment','1K') = 'True'
Returns all child objects of all parameter set, part, pin, port, probe, and sheet symbol objects that contain a parameter object whose Parameter Name property is Comment, and whose Value property is 1K.

Summary

Returns all child objects of all part objects containing a pin object whose Pin Designator and Name properties comply with the Query.

Syntax

Object_HasPin(Parent,Pin Designator : String,Name : String) : Boolean/Boolean_String

Example Usage

Object_HasPin(Parent,'7','GND')
Object_HasPin(Parent,'7','GND') = True
Object_HasPin(Parent,'7','GND') = 'True'
Returns all child objects of all part objects that contain a pin object whose Pin Designator property is 7, and whose Name property is GND.

Summary

Returns all child objects of all sheet symbol objects containing a sheet entry whose Name property complies with the Query.

Syntax

Object_HasSheetEntry(Parent , Sheet Entry Name : String) : Boolean/Boolean_String

Example Usage

Object_HasSheetEntry(Parent,'CLK')
Object_HasSheetEntry(Parent,'CLK') = True
Object_HasSheetEntry(Parent,'CLK') = 'True'
Returns all child objects of all sheet symbol objects that contain a sheet entry object whose Name property is CLK.

Summary

Returns all child objects of pin objects whose IEEE Symbol Inside property complies with the Query.

Syntax

Object_IeeeSymbolInner(Parent) = IeeeSymbolInner_String
Object_IeeeSymbolInner(Parent) <> IeeeSymbolInner_String

IeeeSymbolInner_String must be one of the following strings:

• 'High Current'
• 'HiZ'
• 'No Symbol'
• 'Open Collector'
• 'Open Collector Pull Up'
• 'Open Emitter'
• 'Open Emitter Pull Up'
• 'Open Output'
• 'Pulse'
• 'Postponed Output'
• 'Schmitt'
• 'Shift Left'

Example Usage

Object_IeeeSymbolInner(Parent) = 'HiZ'
Returns all child objects of pin objects whose IEEE Symbol Inside property is HiZ.

Object_IeeeSymbolInner(Parent) <> 'Pulse'
Returns all objects except child objects of pin objects whose IEEE Symbol Inside property is Pulse.

Object_ObjectKind(Parent) = 'Pin' && Object_IeeeSymbolInner(Parent) <> 'Open Emitter'
Returns all child objects of pin objects except those pin objects whose IEEE Symbol Inside property is Open Emitter.

Notes

• The single quote characters (') at the start and end of IeeeSymbolInner_String are mandatory.
• The IEEE Symbol Inside property is only defined for pin objects.

Summary

Returns all child objects of pin objects whose IEEE Symbol Inside Edge property complies with the Query.

Syntax

Object_IeeeSymbolInnerEdge(Parent) = IeeeSymbolInnerEdge_String
Object_IeeeSymbolInnerEdge(Parent) <> IeeeSymbolInnerEdge_String

IeeeSymbolInnerEdge_String must be one of the following strings:

• 'Clock'
• 'No Symbol'

Example Usage

Object_IeeeSymbolInnerEdge(Parent) = 'Clock'
Returns all child objects of pin objects whose IEEE Symbol Inside Edge property is Clock.

Object_IeeeSymbolInnerEdge(Parent) <> 'No Symbol'
Returns all objects except child objects of pin objects whose IEEE Symbol Inside Edge property is No Symbol.

Object_ObjectKind(Parent) = 'Pin' && Object_IeeeSymbolInnerEdge(Parent) <> 'Clock'
Returns all child objects of pin objects except those pin objects whose IEEE Symbol Inside Edge property is Clock.

Notes

• The single quote characters (') at the start and end of IeeeSymbolInnerEdge_String are mandatory.
• The IEEE Symbol Inside Edge property is only defined for pin objects.

Summary

Returns all child objects of pin objects whose IEEE Symbol Outside property complies with the Query.

Syntax

Object_IeeeSymbolOuter(Parent) = IeeeSymbolOuter_String
Object_IeeeSymbolOuter(Parent) <> IeeeSymbolOuter_String

IeeeSymbolOuter_String must be one of the following strings:

• 'Analog Signal In'
• 'Bidirectional Signal Flow'
• 'Digital Signal In'
• 'Left Right Signal Flow'
• 'No Symbol'
• 'Not Logic Connection'
• 'Right Left Signal Flow'

Example Usage

Object_IeeeSymbolOuter(Parent) = 'Digital Signal In'
Returns all child objects of pin objects whose IEEE Symbol Outside property is Digital Signal In.

Object_IeeeSymbolOuter(Parent) <> 'Bidirectional Signal Flow'
Returns all objects except child objects of pin objects whose IEEE Symbol Outside property is Bidirectional Signal Flow.

Object_ObjectKind(Parent) = 'Pin' && Object_IeeeSymbolOuter(Parent) <> 'No Symbol'
Returns all child objects of pin objects except those pin objects whose IEEE Symbol Outside property is No Symbol.

Notes

• The single quote characters (') at the start and end of IeeeSymbolOuter_String are mandatory.
• The IEEE Symbol Outside property is only defined for pin objects.

Summary

Returns all child objects of pin objects whose IEEE Symbol Outside Edge property complies with the Query.

Syntax

Object_IeeeSymbolOuterEdge(Parent) = IeeeSymbolOuterEdge_String
Object_IeeeSymbolOuterEdge(Parent) <> IeeeSymbolOuterEdge_String

IeeeSymbolOuterEdge_String must be one of the following strings:

• 'Active Low Input'
• 'Active Low Output'
• 'Dot'
• 'No Symbol'

Example Usage

Object_IeeeSymbolOuterEdge(Parent) = 'Dot'
Returns all child objects of pin objects whose IEEE Symbol Outside Edge property is Dot.

Object_IeeeSymbolOuterEdge(Parent) <> 'Active Low Output'
Returns all objects except child objects of pin objects whose IEEE Symbol Outside Edge property is Active Low Output.

Object_ObjectKind(Parent) = 'Pin' && Object_IeeeSymbolOuterEdge(Parent) <> 'No Symbol'
Returns all child objects of pin objects except those pin objects whose IEEE Symbol Outside Edge property is No Symbol.

Notes

• The single quote characters (') at the start and end of IeeeSymbolOuterEdge_String are mandatory.
• The IEEE Symbol Outside Edge property is only defined for pin objects.

Summary

Returns all child objects of port objects whose IO Type property complies with the Query.

Syntax

Object_IOType(Parent) = IOType_String
Object_IOType(Parent) <> IOType_String

IOType_String must be one of the strings from the following list:

• 'Bidirectional'
• 'Input'
• 'Output'
• 'Unspecified'

Example Usage

Object_IOType(Parent) = 'Bidirectional'
Returns all child objects of port objects whose IO Type property is Bidirectional.

Object_IOType(Parent) <> 'Output'
Returns all objects except child objects of port objects whose IO Type property is Output.

Notes

• The IO Type property is defined for port and sheet entry objects, but only port objects can have children that are returnable by this expression.
• The single quote characters (') at the start and end of IOType_String are mandatory.

Summary

Returns all child objects of pin objects whose Hide property complies with the Query.

Syntax

Object_IsHidden(Parent) : Boolean/Boolean_String

Example Usage

Object_IsHidden(Parent)
Object_IsHidden(Parent) = True
Object_IsHidden(Parent) = 'True'
Returns all child objects of pin objects whose Hide property is enabled.

Not Object_IsHidden(Parent)
Object_IsHidden(Parent) = False
Object_IsHidden(Parent) = 'False'
Returns all objects except child objects of pin objects whose Hide property is enabled.

Object_ObjectKind(Parent) = 'Pin' && Not Object_IsHidden(Parent)
Returns all child objects of pin objects except those pin objects whose Hide property is disabled.

Note

The Hide property is defined for harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects, but only pin objects can have children that are returnable by this expression.

Summary

Returns all child objects of part objects whose Mirrored property complies with the Query.

Syntax

Object_IsMirrored(Parent) : Boolean_String

Example Usage

Object_IsMirrored(Parent) = 'True'
Returns all child objects of part objects whose Mirrored property is enabled.

Object_IsMirrored(Parent) = 'False'
Returns all child objects of part objects whose Mirrored property is disabled.

Note

The Mirrored property is defined for IEEE symbol, part, and text string objects, but only part objects can have children that are returnable by this expression.

Summary

Returns all child objects of pin objects whose Length property complies with the Query.

Syntax

Object_Length(Parent) : Numeric_String
Object_Length(Parent) : Number

Example Usage

Object_Length(Parent) = '30'
Returns all child objects of pin objects whose Length property is equal to 30.

Object_Length(Parent) Between '20' And '40'
Returns all child objects of pin objects whose Length property is greater than or equal to 20 and less than or equal to 40.

Object_Length(Parent) >= '10'
Returns all child objects of pin objects whose Length property is greater than or equal to 10.

Object_ObjectKind(Parent) = 'Pin' && Object_Length(Parent) < 30
Returns all child objects of pin objects whose Length property is less than 30.

Object_Length(Parent) <> '40'
Returns all objects except child objects of pin objects whose Length property is equal to 40.

Object_ObjectKind(Parent) = 'Pin' && Object_Length(Parent) <> 40
Returns all child objects of pin objects except those pin objects whose Length property is 40.

Note

The Length property is only defined for pin objects.

Summary

Returns all child objects of part objects whose Library property complies with the Query.

Syntax

Object_LibraryName(Parent) : String

Example Usage

Object_LibraryName(Parent) = 'Miscellaneous Devices.IntLib'
Returns all child objects of part objects whose Library property is Miscellaneous Devices.IntLib.

Object_LibraryName(Parent) Like 'Miscellaneous*.IntLib'
Returns all child objects of part objects that have a Library property whose associated string starts with Miscellaneous and which ends with .IntLib.

Note

The Library property is only defined for part objects.

Summary

Returns all child objects of part objects whose Symbol Reference property complies with the Query.

Syntax

Object_LibReference(Parent) : String

Example Usage

Object_LibReference(Parent) = 'LM833'
Returns all child objects of part objects whose Symbol Reference property is LM833.

Note

The Symbol Reference property is only defined for part objects.

Summary

Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property complies with the Query.

Syntax

Object_LocationX(Parent) : Numeric_String

Example Usage

Object_LocationX(Parent) = '320'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property is equal to 320.

Object_LocationX(Parent) Between '150' And '430'
Returnsall child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property is greater than or equal to 150 and less than or equal to 430.

Object_LocationX(Parent) >= '250'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property is greater than or equal to 250.

Object_LocationX(Parent) < 350
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property is less than 350.

Object_LocationX(Parent) <> '210'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose X1 property is not equal to 210.

Summary

Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property complies with the Query.

Syntax

Object_LocationY(Parent) : Numeric_String

Example Usage

Object_LocationY(Parent) = '320'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property is equal to 320.

Object_LocationY(Parent) Between '150' And '430'
Returnsall child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property is greater than or equal to 150 and less than or equal to 430.

Object_LocationY(Parent) >= '250'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property is greater than or equal to 250.

Object_LocationY(Parent) < 350
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property is less than 350.

Object_LocationY(Parent) <> '210'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Y1 property is not equal to 210.

Summary

Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Locked property complies with the Query.

Syntax

Object_Locked(Parent) : Boolean/Boolean_String

Example Usage

Object_Locked(Parent)
Object_Locked(Parent) = True
Object_Locked(Parent) = 'True'
Returns all child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Locked property is enabled.

Not Object_Locked(Parent)
Object_Locked(Parent) = False
Object_Locked(Parent) = 'False'
Returns all objects except child objects of harness connector, parameter set, part, pin, port, probe, and sheet symbol objects whose Locked property is disabled.

Summary

Returns all child objects of objects whose Object Kind property complies with the Query.

Syntax

Object_ObjectKind(Parent) = ObjectKind_String
Object_ObjectKind(Parent) <> ObjectKind_String

ObjectKind_String specifies the object kind and must be one of the following strings:

• 'Harness Connector'
• 'Parameter Set'
• 'Part'
• 'Pin'
• 'Port'
• 'Probe'
• 'Sheet Symbol'
• ''

Example Usage

Object_ObjectKind(Parent) = 'Sheet Symbol'
Returns all child objects of sheet symbol objects.

Object_ObjectKind(Parent) <> 'Parameter Set'
Returns all objects except for child objects of parameter set objects.

Object_ObjectKind(Parent) = 'Part'
Returns all child objects of part objects.

Object_ObjectKind(Parent) = ''
Returns all objects that do not have a parent object.

Note

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

Summary

Returns all child objects of parameter set, part, pin, and probe objects, whose Orientation property complies with the Query.

Syntax

Object_Orientation(Parent) = Orientation_String
Object_Orientation(Parent) <> Orientation_String

Orientation_String must be one of the strings from the following list:

• '0 Degrees'
• '90 Degrees'
• '180 Degrees'
• '270 Degrees'

Example Usage

Object_Orientation(Parent) = '90 Degrees'
Returns all child objects of parameter set, part, pin, and probe objects whose Orientation property is 90 Degrees.

Object_Orientation(Parent) <> '180 Degrees'
Returns all objects except child objects of parameter set, part, pin, and probe objects whose Orientation property is 180 Degrees.

Object_Orientation(Parent) <> '' && Object_Orientation(Parent) <> '180 Degrees'
Object_Orientation(Parent) > '' && Object_Orientation(Parent) <> '180 Degrees'
Returns all child objects of parameter sets, parts, pins, and probe objects whose Orientation property is not 180 Degrees.

Notes

• The Orientation property is defined for the designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects. However, only parameter set, part, pin, and probe objects can have children that are returnable by this expression.

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

Summary

Returns all child objects of part objects whose Current Part property complies with the Query.

Syntax

Object_PartId(Parent) : String

Example Usage

Object_PartId(Parent) = 'B'
Returns all child objects of part objects whose Current Part property is B.

Object_ObjectKind(Parent) = 'Part' && Object_PartId(Parent) <> 'A'
Returns all child objects of part objects except those part objects whose Current Part property is A.

Note

The Current Part property is only defined for part objects.

Summary

Returns all child objects of pin objects whose Show Designator property complies with the Query.

Syntax

Object_PinShowDesignator(Parent) : Boolean_String

Example Usage

Object_PinShowDesignator(Parent) = 'True'
Returns all child objects of pin objects whose Show Designator property is enabled.

Object_PinShowDesignator(Parent) = 'False'
Returns all child objects of pin objects whose Show Designator property is disabled.

Note

The Show Designator property is only defined for pin objects.

Summary

Returns all child objects of part objects whose Pins Locked property complies with the Query.

Syntax

Object_PinsLocked(Parent) : Boolean_String

Example Usage

Object_PinsLocked(Parent) = 'True'
Returns all child objects of part objects whose Pins Locked property is enabled.

Object_PinsLocked(Parent) = 'False'
Returns all child objects of part objects whose Pins Locked property is disabled.

Note

The Pins Locked property is only defined for part objects.

Summary

Returns all child objects of sheet symbol objects (sheet symbol, device sheet symbol, managed sheet instance symbol) whose Sheet File Name property complies with the Query.

Syntax

Object_SheetFileName(Parent) : String

Example Usage

Object_SheetFileName(Parent) = 'Microcontroller_STM32F101.SchDoc'
Returns all child objects of sheet symbol objects whose Sheet File Name property is Microcontroller_STM32F101.SchDoc.

Object_SheetFileName(Parent) Like '*Res*'
Returns all child objects of sheet symbol objects whose Sheet File Name property includes Res.

Note

The Sheet File Name property is only defined for sheet symbol objects.

Summary

Returns all child objects of sheet symbol objects (sheet symbol, device sheet symbol, managed sheet instance symbol) whose Sheet Name property (i.e. the Sheet Symbol Designator) complies with the Query.

Syntax

Object_SheetName(Parent) : String

Example Usage

Object_SheetName(Parent) = 'Accelerometer'
Returns all child objects of sheet symbol objects whose Sheet Name property is Accelerometer.

Object_SheetName(Parent) Like '*Power*'
Returns all child objects of sheet symbol objects whose Sheet Name property includes Power.

Note

The Sheet Name property is only defined for sheet symbol objects.

Summary

Returns all child objects of part objects whose Show Hidden Pins property complies with the Query.

Syntax

Object_ShowHiddenPins(Parent) : Boolean_String

Example Usage

Object_ShowHiddenPins(Parent) = 'True'
Returns all child objects of part objects whose Show Hidden Pins property is enabled.

Object_ShowHiddenPins(Parent) = 'False'
Returns all child objects of part objects whose Show Hidden Pins property is disabled.

Note

The Show Hidden Pins property is only defined for part objects.

Summary

Returns all child objects of pin objects whose Show Name property complies with the Query.

Syntax

Object_ShowName(Parent) : Boolean_String

Example Usage

Object_ShowName(Parent) = 'True'
Returns all child objects of pin objects whose Show Name property is enabled.

Object_ShowName(Parent) = 'False'
Returns all child objects of pin objects whose Show Name property is disabled.

Note

The Show Name property is defined for parameter and pin objects, but only pin objects can have children that are returnable by this expression.

Summary

Returns all child objects of port objects whose Text Color property complies with the Query.

Syntax

Object_TextColor(Parent) : Numeric_String
Object_TextColor(Parent) : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Object_TextColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Text Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Text Color Div 65536
• Green = Text Color Div 256 Mod 256
• Red = Text Color Mod 256

Example Usage

Object_TextColor(Parent) = '0'
Object_TextColor(Parent) <> '' && Object_TextColor(Parent) = 0
Returns all child objects of port objects whose Text Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Object_TextColor(Parent) = '32896'
Object_TextColor(Parent) > '' && Object_TextColor(Parent) = 32896
Returns all child objects of port objects whose Text Color property is 32896 (which corresponds to values of Blue = 0, Green = 128, and Red = 128).

Object_TextColor(Parent) <> '16777215'
Returns all objects except child objects of port objects whose Text Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

Object_ObjectKind(Parent) = 'Port' && Object_TextColor(Parent) <> 16777215
Returns all child objects of port objects whose Text Color property is not 16777215.

Object_TextColor(Parent) > '' && Object_TextColor(Parent) Div 65536 >= 96 && Object_TextColor(Parent) Div 256 Mod 256 Between 64 And 192 && Object_TextColor(Parent) Mod 256 <= 128
Returns all child objects of port objects whose Text Color property is such that the Blue component has a value that is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

Object_ObjectKind(Parent) = 'Port' && Object_TextColor(Parent) Mod 256 Between 64 And 192
Returns all child objects of port objects whose Text Color property's Red component has a value that is greater than or equal to 64 and less than or equal to 192.

Note

The Text Color property is defined for harness entry, note, port, sheet entry, and text frame objects, but only port objects can have children that are returnable by this expression.

Summary

Returns all child objects of part objects whose Use Database Table Name property complies with the Query.

Syntax

Object_UseDBTableName(Parent) : Boolean_String

Example Usage

Object_UseDBTableName(Parent) = 'True'
Returns all child objects of part objects whose Use Database Table Name property is enabled.

Object_UseDBTableName(Parent) = 'False'
Returns all child objects of part objects whose Use Database Table Name property is disabled.

Note

The Use Database Table Name property is only defined for part objects.

Summary

Returns all child objects of part objects whose Use Library Name property complies with the Query.

Syntax

Object_UseLibraryName(Parent) : Boolean_String

Example Usage

Object_UseLibraryName(Parent) = 'True'
Returns all child objects of part objects whose Use Library Name property is enabled.

Object_UseLibraryName(Parent) = 'False'
Returns all child objects of part objects whose Use Library Name property is disabled.

Note

The Use Library Name property is only defined for part objects.