org.sensorhub.api.data

Interface IModuleWithDescription

All Known Subinterfaces:

IDataProducerModule<ConfigType>, ISensorModule<ConfigType>, IStreamProcessModule<ConfigType>

All Known Implementing Classes:

AbstractSensorModule, AbstractStreamProcess, SensorSystem, SMLStreamProcess, SOSVirtualSensor, SWEVirtualSensor

public interface IModuleWithDescription

Base interface for all modules that provide a SensorML description (such as sensors, actuators and processes)

Since:

Feb 21, 2015

Author:

Alex Robin

Method Summary

Methods

Modifier and Type	Method and Description
AbstractProcess	getCurrentDescription() Retrieves most current SensorML description of the entity whose data is provided by this module.
long	getLastDescriptionUpdate() Used to check when SensorML description was last updated.
String	getUniqueIdentifier()

Method Detail

getUniqueIdentifier

String getUniqueIdentifier()

Returns:

The object's globally unique identifier

getCurrentDescription

AbstractProcess getCurrentDescription()

Retrieves most current SensorML description of the entity whose data is provided by this module. All implementations must return an instance of AbstractProcess with a valid unique identifier.
In the case of a module generating data from multiple entities (e.g. sensor network), this returns the description of the group as a whole. Descriptions of individual entities within the group are retrived using IMultiSourceDataProducer.getCurrentDescription(String)

Returns:

AbstractProcess SensorML description of the data producer or null if none is available at the time of the call

getLastDescriptionUpdate

long getLastDescriptionUpdate()

Used to check when SensorML description was last updated. This is useful to avoid requesting the object when it hasn't changed.

Returns:

Date/time of last description update as unix time (ms since 1970) or Long.MIN_VALUE if description was never updated.