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

InChannelClass

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 3.1. For the latest, read: InChannelClass 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 objects associated with component objects that are members of the specified Design Channel Class.

Syntax

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

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

Example Usage

InChannelClass('Red_LED')
InChannelClass('Red_LED') = True
InChannelClass('Red_LED') = 'True'
Returns all objects associated with component objects that are members of the Red_LED Design Channel Class.

InChannelClass('Output channel','Input channel')
InChannelClass('Output channel','Input channel') = True
InChannelClass('Output channel','Input channel') = 'True'
Returns all objects associated with component objects that are members of either the Output channel or Input channel Design Channel Classes.

InChannelClass('Input*')
InChannelClass('Input*') = True
InChannelClass('Input*') = 'True'
Returns all objects associated with component objects that are members of any Design Channel Class whose Name property starts with Input.

Tips

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