Package org.netxms.client.objects

Class Room

java.lang.Object
org.netxms.client.objects.AbstractObject
org.netxms.client.objects.GenericObject
org.netxms.client.objects.DataCollectionTarget
org.netxms.client.objects.DataCollectionContainer
org.netxms.client.objects.Room
All Implemented Interfaces:
AutoBindObject, PollingTarget
public class Room extends DataCollectionContainer
Room object - physical room with floor plan where racks are placed at their real location. All coordinates and dimensions are in millimetres in room-local coordinates unless stated otherwise.

  • Constructor Details

    • Room

      public Room(NXCPMessage msg, NXCSession session)
      Create from NXCP message.
      Parameters:
      msg - NXCP message
      session - owning client session

  • Method Details

    • outlineFromArray

      public static List<RoomPoint> outlineFromArray(int[] values)
      Convert array of interleaved x,y values (as used in NXCP messages) to list of points.
      Parameters:
      values - interleaved x,y values (can be null)
      Returns:
      list of points

    • outlineToArray

      public static int[] outlineToArray(List<RoomPoint> points)
      Convert list of points to array of interleaved x,y values (as used in NXCP messages).
      Parameters:
      points - list of points
      Returns:
      interleaved x,y values

    • getObjectClassName

      public String getObjectClassName()
      Description copied from class: AbstractObject
      Get name of NetXMS object's class.
      Overrides:
      getObjectClassName in class AbstractObject
      Returns:
      Name of NetXMS object's class
      See Also:

    • getRacks

      public List<Rack> getRacks()
      Get racks located in this room.
      Returns:
      list of racks located in this room

    • getRoomType

      public RoomType getRoomType()
      Get room type.
      Returns:
      room type

    • getOutline

      public List<RoomPoint> getOutline()
      Get room outline as ordered list of polygon vertices.
      Returns:
      room outline

    • getArea

      public double getArea()
      Get floor area in square metres (calculated by server from room outline).
      Returns:
      floor area in square metres

    • getHeight

      public int getHeight()
      Get room height.
      Returns:
      room height in millimetres or 0 if undeclared

    • getGridOriginX

      public int getGridOriginX()
      Returns:
      X coordinate of floor tile grid origin

    • getGridOriginY

      public int getGridOriginY()
      Returns:
      Y coordinate of floor tile grid origin

    • getGridTileSize

      public int getGridTileSize()
      Get floor tile size.
      Returns:
      floor tile size in millimetres or 0 if there is no tile grid

    • getGridLabels

      public RoomGridLabels getGridLabels()
      Returns:
      floor tile label scheme

    • getBackgroundImage

      public UUID getBackgroundImage()
      Get image library UUID of floor plan backdrop.
      Returns:
      image library UUID of floor plan backdrop or null if not set

    • getBackgroundScale

      public int getBackgroundScale()
      Get backdrop calibration.
      Returns:
      backdrop scale in micrometres per image pixel

    • getBackgroundX

      public int getBackgroundX()
      Returns:
      X offset of the backdrop in room coordinates

    • getBackgroundY

      public int getBackgroundY()
      Returns:
      Y offset of the backdrop in room coordinates

    • getPassiveElements

      public List<RoomPassiveElement> getPassiveElements()
      Get passive elements placed on floor plan.
      Returns:
      list of passive elements