Altium Designer Home
...
((PCB Query Functions))_AD
PCB Query((Membership Checks))_AD
Query_Lang-PCBFunctions_MembershipChecks_WithinRoomWithinRoom_AD
This document is no longer available beyond version 21. Information can now be found here: WithinRoom for version 24
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.
Syntax
WithinRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String
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
- The single quote characters (') at the start and end of each
RoomNamestring are mandatory. - Parent coordinate, dimension, and Net objects are not returned.