io.relayr.java.model.state

Class State

java.lang.Object

io.relayr.java.model.state.State

All Implemented Interfaces:

java.io.Serializable

public class State
extends java.lang.Object
implements java.io.Serializable

Device state is a device specific storage. It shows latest state of devices' readings, configuration, commands and metadata. Latest state refers to a list of latest changes in device actions. If device, for example, is sending a reading every number of seconds only latest reading will be saved and persisted in the state

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
State()

Method Summary

Modifier and Type	Method and Description
StateCommands	getCommands() Returns list of devices' latest used commands and version.
StateConfigurations	getConfigurations() Returns list of devices' latest used configurations and version.
java.lang.Object	getMetadata() Metadata is an dictionary object defined by user.
StateReadings	getReadings() Returns list of devices' latest send readings and version.
Version	getVersion() Returns current device state version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

State

public State()

Method Detail

getReadings

public StateReadings getReadings()

Returns list of devices' latest send readings and version. Device readings are defined in Transport that can be find in DeviceModel for each device.

Returns:

StateReadings

getCommands

public StateCommands getCommands()

Returns list of devices' latest used commands and version. Device commands are defined in Transport that can be find in DeviceModel for each device.

Returns:

StateCommands

getConfigurations

public StateConfigurations getConfigurations()

Returns list of devices' latest used configurations and version. Device configurations are defined in Transport that can be find in DeviceModel for each device.

Returns:

StateCommands

getMetadata

public java.lang.Object getMetadata()

Metadata is an dictionary object defined by user. It can be used to save device specific data that's not defined by device model.

Returns:

Object

getVersion

public Version getVersion()

Returns current device state version. Version is defined with incremental number and timestamp of last update.