org.sensorhub.api.sensor

Class SensorControlEvent

java.lang.Object

org.sensorhub.api.common.Event<EventTypeEnum>

org.sensorhub.api.common.EntityEvent<CommandStatus.StatusCode>

org.sensorhub.api.sensor.SensorControlEvent

public class SensorControlEvent
extends EntityEvent<CommandStatus.StatusCode>

Special type of immutable event carrying status data by reference

Since:

Nov 5, 2010

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandStatus	status Status of the command that triggered this event

Fields inherited from class org.sensorhub.api.common.EntityEvent

relatedEntityID

Fields inherited from class org.sensorhub.api.common.Event

source, timeStamp, type

Constructor Summary

Constructors

Constructor and Description
SensorControlEvent(long timeStamp, ISensorControlInterface controlInterface, CommandStatus status) Constructs the event for an individual sensor
SensorControlEvent(long timeStamp, java.lang.String sensorID, ISensorControlInterface controlInterface, CommandStatus status) Constructs the event for a sensor that is part of a network

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSensorID() Gets the unique ID of the sensor related to this event. For sensor networks, it can be either the ID of the network as a whole (if the command was global) or the ID of one of the sensor in the network (if the command was sent to a particular sensor).
ISensorControlInterface	getSource() Gets the source of the event as an object reference.
CommandStatus	getStatus()

Methods inherited from class org.sensorhub.api.common.EntityEvent

getRelatedEntityID

Methods inherited from class org.sensorhub.api.common.Event

getTimeStamp, getType

Methods inherited from class java.lang.Object

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

Field Detail

status

protected CommandStatus status

Status of the command that triggered this event

Constructor Detail

SensorControlEvent

public SensorControlEvent(long timeStamp,
                          ISensorControlInterface controlInterface,
                          CommandStatus status)

Constructs the event for an individual sensor

Parameters:

timeStamp - unix time of event generation

controlInterface - sensor control interface that generated the event

status - status of command at time the event is generated

SensorControlEvent

public SensorControlEvent(long timeStamp,
                          java.lang.String sensorID,
                          ISensorControlInterface controlInterface,
                          CommandStatus status)

Constructs the event for a sensor that is part of a network

Parameters:

timeStamp - unix time of event generation

sensorID - ID of individual sensor in the network

controlInterface - sensor control interface that generated the event

status - status of command at time the event is generated

Method Detail

getSensorID

public java.lang.String getSensorID()

Gets the unique ID of the sensor related to this event.
For sensor networks, it can be either the ID of the network as a whole (if the command was global) or the ID of one of the sensor in the network (if the command was sent to a particular sensor).

Returns:

the ID of the sensor that this event refers to

getStatus

public CommandStatus getStatus()

getSource

public ISensorControlInterface getSource()

Description copied from class: Event

Gets the source of the event as an object reference.

Overrides:

getSource in class Event<CommandStatus.StatusCode>

Returns:

Source object that generated this event