org.sensorhub.api.sensor

Class SensorDataEvent

java.lang.Object

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

org.sensorhub.api.common.EntityEvent<DataEvent.Type>

org.sensorhub.api.data.DataEvent

org.sensorhub.api.sensor.SensorDataEvent

public class SensorDataEvent
extends DataEvent

Type of event generated when new data is available from sensors. It is immutable and carries sensor data by reference

Since:

Nov 5, 2010

Nested Class Summary

Nested classes/interfaces inherited from class org.sensorhub.api.data.DataEvent

DataEvent.Type

Field Summary

Fields inherited from class org.sensorhub.api.data.DataEvent

records

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
SensorDataEvent(long timeStamp, ISensorDataInterface dataInterface, DataBlock... records) Constructs an event for data produced by an isolated sensor. The sensor ID is obtained from the sensor description of the parent sensor module.
SensorDataEvent(long timeStamp, java.lang.String sensorID, IStreamingDataInterface dataInterface, DataBlock... records) Constructs an event for data produced by the specified sensor. This flavor is used to identify a particular sensor within 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 attached data includes records generated by all or several members of the network) or the ID of one of the sensor in the network (if the attached data has been generated by a single sensor).
ISensorDataInterface	getSource() Gets the source of the event as an object reference.

Methods inherited from class org.sensorhub.api.data.DataEvent

getRecordDescription, getRecords, getType

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

getRelatedEntityID

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

getTimeStamp

Methods inherited from class java.lang.Object

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

Constructor Detail

SensorDataEvent

public SensorDataEvent(long timeStamp,
                       ISensorDataInterface dataInterface,
                       DataBlock... records)

Constructs an event for data produced by an isolated sensor.
The sensor ID is obtained from the sensor description of the parent sensor module.

Parameters:

timeStamp - time of event generation (unix time in milliseconds, base 1970)

dataInterface - sensor output interface that produced the associated data

records - arrays of records that triggered this notification

SensorDataEvent

public SensorDataEvent(long timeStamp,
                       java.lang.String sensorID,
                       IStreamingDataInterface dataInterface,
                       DataBlock... records)

Constructs an event for data produced by the specified sensor.
This flavor is used to identify a particular sensor within a network.

Parameters:

timeStamp - time of event generation (unix time in milliseconds, base 1970)

sensorID - Unique ID of the sensor that produced the data

dataInterface - stream interface that generated the associated data

records - arrays of records that triggered this notification

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 attached data includes records generated by all or several members of the network) or the ID of one of the sensor in the network (if the attached data has been generated by a single sensor).

Returns:

the ID of the sensor that this event refers to

getSource

public ISensorDataInterface getSource()

Description copied from class: Event

Gets the source of the event as an object reference.

Overrides:

getSource in class DataEvent

Returns:

Source object that generated this event