Query_Lang-PCBFunctions_MembershipChecks_InStructureClassInStructureClass_AD

This document is no longer available beyond version 4.0. Information can now be found here: InStructureClass for version 5

Applies to NEXUS Client 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')
In
StructureClass('Output channel','Input channel') = True
In
StructureClass('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*')
In
StructureClass('Input*') = True
In
StructureClass('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.