org.sensorhub.api.sensor

Interface ISensorDataInterface

All Superinterfaces:

IEventProducer, IStreamingDataInterface

public interface ISensorDataInterface
extends IStreamingDataInterface

Interface to be implemented by all sensor drivers connected to the system.

Data provided by this interface can be actual measurements but also status information. Each sensor output is mapped to a separate instance of this interface, allowing them to have completely independent sampling rates.

Even when storage is not supported, implementations MUST at least be capable of retaining the latest record received from sensor and make it available with getLatestRecord().

Implementation MUST send events of type SensorDataEvent when new data is produced by sensor.

Since:

Nov 5, 2010

Method Summary

Modifier and Type	Method and Description
int	clearAllRecords() Clears all records currently stored in driver or sensor memory. This method must be implemented if isStorageSupported() returns true.
java.util.List<DataBlock>	getAllRecords(boolean clear) Retrieves all records stored by the driver or sensor. This method must be implemented if isStorageSupported() returns true.
DataBlock	getLatestRecord() Gets the latest record received on this data channel.
java.util.List<DataBlock>	getLatestRecords(int maxRecords, boolean clear) Retrieves the N last records stored. This method must be implemented if isStorageSupported() returns true.
java.lang.String	getName() Gets this output interface name.
int	getNumberOfAvailableRecords() Retrieves number of record currectly available from driver or on-board sensor memory. This method must be implemented if isStorageSupported() returns true.
ISensorModule<?>	getParentModule() Allows by-reference access to parent sensor module
int	getStorageCapacity() Gets the internal storage capacity. This method must be implemented if isStorageSupported() returns true.
boolean	isStorageSupported() Checks data storage capability

Methods inherited from interface org.sensorhub.api.data.IStreamingDataInterface

getAverageSamplingPeriod, getLatestRecordTime, getRecommendedEncoding, getRecordDescription, isEnabled

Methods inherited from interface org.sensorhub.api.common.IEventProducer

registerListener, unregisterListener

Method Detail

getParentModule

ISensorModule<?> getParentModule()

Allows by-reference access to parent sensor module

Specified by:

getParentModule in interface IStreamingDataInterface

Returns:

parent module instance

getName

java.lang.String getName()

Gets this output interface name.

It MUST be the name reported in the map by getXXXOutputs methods of ISensorModule

Specified by:

getName in interface IStreamingDataInterface

Returns:

name of this output interface

See Also:

ISensorModule.getAllOutputs()

getLatestRecord

DataBlock getLatestRecord()

Gets the latest record received on this data channel. Even implementations with no storage support must always retain the last record and implement this method.

When storage is supported, this method does not cause data to be removed from memory.

Note that this does not trigger a new measurement but simply retrieves the result of the last measurement made.

Specified by:

getLatestRecord in interface IStreamingDataInterface

Returns:

the last measurement record or null if no data is available

isStorageSupported

boolean isStorageSupported()

Checks data storage capability

Note that storage can be provided by the sensor itself or by the driver.

Returns:

true if record storage is supported internally, false otherwise

getStorageCapacity

int getStorageCapacity()
                throws SensorException

Gets the internal storage capacity.
This method must be implemented if isStorageSupported() returns true.

Returns:

maximum number of records that can be stored

Throws:

SensorException - if storage is not supported or a problem occured while checking sensor on-board storage capacity

getNumberOfAvailableRecords

int getNumberOfAvailableRecords()
                         throws SensorException

Retrieves number of record currectly available from driver or on-board sensor memory.
This method must be implemented if isStorageSupported() returns true.

Returns:

the number of available records

Throws:

SensorException - if storage is not supported or a problem occured while reading from on-board sensor storage

getLatestRecords

java.util.List<DataBlock> getLatestRecords(int maxRecords,
                                           boolean clear)
                                    throws SensorException

Retrieves the N last records stored.
This method must be implemented if isStorageSupported() returns true.

Parameters:

maxRecords - Maximum number of records to retrieve

clear - if true, also clears records from driver or sensor memory

Returns:

a list of records sorted by acquisition time (empty if no records are available)

Throws:

SensorException - if storage is not supported or a problem occured while reading from on-board sensor storage

getAllRecords

java.util.List<DataBlock> getAllRecords(boolean clear)
                                 throws SensorException

Retrieves all records stored by the driver or sensor.
This method must be implemented if isStorageSupported() returns true.

Parameters:

clear - if true, also clears records from driver or sensor memory

Returns:

the list of all records in storage sorted by acquisition time (empty if no records are available)

Throws:

SensorException - if storage is not supported or a problem occured while reading from on-board sensor storage

clearAllRecords

int clearAllRecords()
             throws SensorException

Clears all records currently stored in driver or sensor memory.
This method must be implemented if isStorageSupported() returns true.

Returns:

number of records removed

Throws:

SensorException - if storage is not supported or a problem occured while clearing on-board sensor storage