IRoom interface
The IRoom interface is a PCB room object. A room is controlled by the room design rule. This room serves as a boundary constraint for a group of specified components as a component or channel class.
public interface IRoom : IDMObject
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Inherits: IDMObject
Methods
| Method | Returns | Description |
|---|---|---|
| DM_HX | int | Returns the higher X coordinate of the room object. |
| DM_HY | int | Returns the higher Y coordinate of the room object. |
| DM_Layer | int | Returns the PCB Layer value of the room object that it is on. |
| DM_LX | int | Returns the lower X coordinate of the room object. |
| DM_LY | int | Returns the lower Y coordinate of the room object. |
| DM_RoomName | string | The method returns the room name. |
| DM_Scope1Expression | string | The method returns the scope 1 expression which describes the scope of this room object. |
| DM_SetRoomPCBHandle | void |
DM_HX
Returns the higher X coordinate of the room object.
int DM_HX();
Returns: int
DM_HY
Returns the higher Y coordinate of the room object.
int DM_HY();
Returns: int
DM_Layer
Returns the PCB Layer value of the room object that it is on.
int DM_Layer();
Returns: int
DM_LX
Returns the lower X coordinate of the room object.
int DM_LX();
Returns: int
DM_LY
Returns the lower Y coordinate of the room object.
int DM_LY();
Returns: int
DM_RoomName
The method returns the room name.
string DM_RoomName();
Returns: string
DM_Scope1Expression
The method returns the scope 1 expression which describes the scope of this room object.
string DM_Scope1Expression();
Returns: string
DM_SetRoomPCBHandle
No description yet.
void DM_SetRoomPCBHandle(object argPCBRoomHandle);
| Parameter | Type | Passing |
|---|---|---|
argPCBRoomHandle | object | value |
Returns: nothing (void)
Inherited members
- From IDMObject: DM_CalculateParameterValue, DM_CurrentSheetInstanceNumber, DM_FullCrossProbeString, DM_GeneralField, DM_GetVCSProject, DM_ImageIndex, DM_IsFormulaString, DM_IsInferredObject, DM_LocationString, DM_LocationX, DM_LocationY, DM_LongDescriptorString, DM_NetIndex_Flat, DM_NetIndex_Sheet, DM_NetIndex_SubNet, DM_ObjectKindString, DM_ObjectKindStringForCrossProbe, DM_OwnerDocument, DM_OwnerDocumentFullPath, DM_OwnerDocumentName, DM_ParameterCount, DM_Parameters, DM_PcbHandle, DM_PCBObjectHandle, DM_PCBObjectInterface, DM_PrimaryCrossProbeString, DM_SchHandle, DM_SCHObjectHandle, DM_SCHObjectInterface, DM_SecondaryCrossProbeString, DM_SetVCSProject, DM_SheetIndex_Logical, DM_SheetIndex_Physical, DM_ShortDescriptorString, DM_ValidForNavigation, DM_VHDLEntity