Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 1.1
43.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... PCB Query Functions Membership Checks

InStructureClass

Created: September 19, 2015 | Updated: August 20, 2021 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2
Now reading version 1.1. For the latest, read: InStructureClass for version 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all parent and child objects of the Component Classes and Net Classes, that are members of the specified Structure Class.

Syntax

InStructureClass(ClassName1 : String,ClassName2 : String,...,ClassNamen : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined structure classes, by name, is presented.

Example Usage

InStructureClass('Red_LED')
InStructureClass('Red_LED') = True
InStructureClass('Red_LED') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of the Red_LED Structure Class.

InStructureClass('Output channel','Input channel')
InStructureClass('Output channel','Input channel') = True
InStructureClass('Output channel','Input channel') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of either the Output channel or Input channel Structurel Classes.

InStructureClass('Input*')
InStructureClass('Input*') = True
InStructureClass('Input*') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of any Structure Class whose Name property starts with Input.

Tips

  1. The single quote characters (') at the start and end of each ClassName string are mandatory.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.