TouchesRoom
This document is no longer available beyond version 21. Information can now be found here: TouchesRoom for version 25
Parent page: PCB Query Functions - Membership Checks
Summary
Returns objects that either totally or partially reside within the region occupied by any room object (confinement constraint rule) whose Name property complies with the Query.
Syntax
TouchesRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String
Example Usage
TouchesRoom('Power')
TouchesRoom('Power') = True
TouchesRoom('Power') = 'True'
Returns objects that either totally or partially reside within the region occupied by any Room whose Name property is Power.
TouchesRoom('COUT1','COUT2')
TouchesRoom('COUT1','COUT2') = True
TouchesRoom('COUT1','COUT2') = 'True'
Returns objects that either totally or partially reside within the regions occupied by any Rooms whose Name property is either COUT1 or COUT2.
TouchesRoom('Monitor','Auxilary','Effects')
TouchesRoom('Monitor','Auxilary','Effects') = True
TouchesRoom('Monitor','Auxilary','Effects') = 'True'
Returns objects that either totally or partially 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
RoomName
string are mandatory. - Parent coordinate, dimension, and Net objects are not returned.