WithinRoom
This document is no longer available beyond version 21. Information can now be found here: WithinRoom for version 25
The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.
If you don’t see a discussed feature in your software, contact Altium Sales to find out more.
Parent page: PCB Query Functions - Membership Checks
Summary Copy Link Copied
Returns objects that totally reside within the region occupied by any room object (confinement constraint rule) whose Name property complies with the Query.
Syntax Copy Link Copied
WithinRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String
Example Usage Copy Link Copied
Within
Room('Power')
Within
Room('Power') = True
Within
Room('Power') = 'True'
Returns objects that totally reside within the region occupied by any Room whose Name property is Power.
Within
Room('COUT1','COUT2')
Within
Room('COUT1','COUT2') = True
Within
Room('COUT1','COUT2') = 'True'
Returns objects that totally reside within the regions occupied by any Rooms whose Name property is either COUT1 or COUT2.
Within
Room('Monitor','Auxilary','Effects')
Within
Room('Monitor','Auxilary','Effects') = True
Within
Room('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 Copy Link Copied
- The single quote characters (') at the start and end of each
RoomName
string are mandatory. - Parent coordinate, dimension, and Net objects are not returned.