com.universaldevices.device.model
Class SystemStatus

java.lang.Object
  extended by com.universaldevices.device.model.SystemStatus

public class SystemStatus
extends java.lang.Object

This class is an object representation of ISY status. The methods and attributes of this class enables client to know at which state is the system (when busy) and approximately how long more will it take for it to become idle

Author:
UDArchitect

Constructor Summary
SystemStatus(java.lang.String body)
          Constructor
 
Method Summary
 int getDelayBetweenOps()
          Returns the number of milliseconds between each write operation
 int getNumRemainingOps()
          Returns the number of write operations remaining (max 256)
 int getStatus()
          Returns the status of the system which could of the following values:
com.universaldevices.common.Constants#DEV_ST_INITIALIZING
com.universaldevices.common.Constants#DEV_ST_QUERYING
com.universaldevices.common.Constants#DEV_ST_SEARCHING
com.universaldevices.common.Constants#DEV_ST_BUSY
com.universaldevices.common.Constants#DEV_ST_READY
 boolean isInSafeMode()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SystemStatus

public SystemStatus(java.lang.String body)
Constructor

The constructor is called as the result of a successful UDProxyDevice.getSystemStatus

Parameters:
body -
See Also:
UDProxyDevice
Method Detail

getDelayBetweenOps

public int getDelayBetweenOps()
Returns the number of milliseconds between each write operation

Returns:
- the number of milliseconds between each write operation (to the physical media)

getNumRemainingOps

public int getNumRemainingOps()
Returns the number of write operations remaining (max 256)

Returns:
- the number remaining write operations

getStatus

public int getStatus()
Returns the status of the system which could of the following values:
com.universaldevices.common.Constants#DEV_ST_INITIALIZING
com.universaldevices.common.Constants#DEV_ST_QUERYING
com.universaldevices.common.Constants#DEV_ST_SEARCHING
com.universaldevices.common.Constants#DEV_ST_BUSY
com.universaldevices.common.Constants#DEV_ST_READY

Returns:
- the status of the system
See Also:
Constants

isInSafeMode

public boolean isInSafeMode()
Returns:
the inSafeMode