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

WithinRoom

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.2. For the latest, read: WithinRoom 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 objects that totally reside within the region occupied by any room object (confinement constraint rule) whose Name property complies with the Query.

For pads and vias to be returned, their center points must reside within the specified room(s).

Syntax

WithinRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String

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

Example Usage

WithinRoom('Power')
WithinRoom('Power') = True
WithinRoom('Power') = 'True'
Returns objects that totally reside within the region occupied by any Room whose Name property is Power.

WithinRoom('COUT1','COUT2')
WithinRoom('COUT1','COUT2') = True
WithinRoom('COUT1','COUT2') = 'True'
Returns objects that totally reside within the regions occupied by any Rooms whose Name property is either COUT1 or COUT2.

WithinRoom('Monitor','Auxilary','Effects')
WithinRoom('Monitor','Auxilary','Effects') = True
WithinRoom('Monitor','Auxilary','Effects') = 'True'
Returns objects that totally reside within the regions occupied by any Rooms whose Name property is Monitor, or Auxilary, or Effects.

Tips

  1. The single quote characters (') at the start and end of each RoomName string are mandatory.
  2. Parent coordinate, dimension, and Net objects are not returned.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.