org.sensorhub.api.sensor

Class SensorEvent

java.lang.Object

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

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

org.sensorhub.api.sensor.SensorEvent

public class SensorEvent
extends EntityEvent<SensorEvent.Type>

Event generated when sensor state/configuration changes.

Since:

Nov 5, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SensorEvent.Type Possible event types for a SensorEvent

Field Summary

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
SensorEvent(long timeStamp, ISensorModule<?> sensorModule, SensorEvent.Type type) Constructs the event for an individual sensor
SensorEvent(long timeStamp, java.lang.String sensorID, ISensorModule<?> sensorModule, SensorEvent.Type type) 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, this can be either the ID of the network as a whole (if the change is global) or the ID of one of the sensor in the network (if the change applies only to that particular sensor, e.g.
ISensorModule<?>	getSource() Gets the source of the event as an object reference.

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

Constructor Detail

SensorEvent

public SensorEvent(long timeStamp,
                   ISensorModule<?> sensorModule,
                   SensorEvent.Type type)

Constructs the event for an individual sensor

Parameters:

timeStamp - unix time of event generation

sensorModule - sensor module that generated the event

type - type of event

SensorEvent

public SensorEvent(long timeStamp,
                   java.lang.String sensorID,
                   ISensorModule<?> sensorModule,
                   SensorEvent.Type type)

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

sensorModule - sensor module that generated the event

type - type of event

Method Detail

getSensorID

public java.lang.String getSensorID()

Gets the unique ID of the sensor related to this event.
For sensor networks, this can be either the ID of the network as a whole (if the change is global) or the ID of one of the sensor in the network (if the change applies only to that particular sensor, e.g. recalibration).

Returns:

the ID of the sensor that this event refers to

getSource

public ISensorModule<?> getSource()

Description copied from class: Event

Gets the source of the event as an object reference.

Overrides:

getSource in class Event<SensorEvent.Type>

Returns:

Source object that generated this event