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

TouchesRoom

Created: August 02, 2022 | Updated: August 02, 2022 | Applies to version: 4

This document is no longer available beyond version 4. Information can now be found here: TouchesRoom for version 5

Nexus message

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 Copy Link Copied

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 Copy Link Copied

TouchesRoom(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 Copy Link Copied

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 Copy Link Copied

  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.
English
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Printer-friendly version