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

WithinRoom

Created: September 19, 2015 | Updated: August 20, 2021 | Applies to versions: 15.1, 16.0, 16.1, 17.0, 17.1, 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2
Now reading version 19. For the latest, read: WithinRoom for version 21

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.
Note

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.