org.sensorhub.api.sensor

Interface ISensorModule<ConfigType extends SensorConfig>

Type Parameters:

ConfigType -

All Superinterfaces:

IDataProducerModule<ConfigType>, IEventProducer, IModule<ConfigType>, IModuleWithDescription

public interface ISensorModule<ConfigType extends SensorConfig>
extends IDataProducerModule<ConfigType>, IEventProducer

Interface to be implemented by all sensor drivers connected to the system.
Inputs/Output should always be created in the init() method even if they are further modified during or after startup.

Since:

Nov 5, 2010

Field Summary

Fields inherited from interface org.sensorhub.api.module.IModule

CANNOT_INIT_MSG, CANNOT_LOAD_MSG, CANNOT_START_MSG, CANNOT_STOP_MSG, CANNOT_UPDATE_MSG

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,? extends ISensorDataInterface>	getAllOutputs() Retrieves the list of interfaces to all sensor data outputs
java.util.Map<java.lang.String,? extends ISensorControlInterface>	getCommandInputs() Retrieves the list of interface to sensor command inputs
AbstractPhysicalProcess	getCurrentDescription() Retrieves most current sensor description.
java.util.Map<java.lang.String,? extends ISensorDataInterface>	getObservationOutputs() Retrieves the list of interface to sensor observation outputs
java.util.Map<java.lang.String,? extends ISensorDataInterface>	getStatusOutputs() Retrieves the list of interface to sensor status outputs
boolean	isConnected() Returns the sensor connection status. This method must do whatever it can to really detect the presence of the sensor.

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

getCurrentFeatureOfInterest

Methods inherited from interface org.sensorhub.api.module.IModule

cleanup, getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, registerListener, requestInit, requestStart, requestStop, saveState, setConfiguration, start, stop, unregisterListener, updateConfig, waitForState

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

getLastDescriptionUpdate, getUniqueIdentifier

Method Detail

getCurrentDescription

AbstractPhysicalProcess getCurrentDescription()

Retrieves most current sensor description.

Specified by:

getCurrentDescription in interface IModuleWithDescription

Returns:

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

getAllOutputs

java.util.Map<java.lang.String,? extends ISensorDataInterface> getAllOutputs()

Retrieves the list of interfaces to all sensor data outputs

Specified by:

getAllOutputs in interface IDataProducerModule<ConfigType extends SensorConfig>

Returns:

map of output names -> data interface objects

getStatusOutputs

java.util.Map<java.lang.String,? extends ISensorDataInterface> getStatusOutputs()

Retrieves the list of interface to sensor status outputs

Returns:

map of output names -> data interface objects

getObservationOutputs

java.util.Map<java.lang.String,? extends ISensorDataInterface> getObservationOutputs()

Retrieves the list of interface to sensor observation outputs

Returns:

map of output names -> data interface objects

getCommandInputs

java.util.Map<java.lang.String,? extends ISensorControlInterface> getCommandInputs()

Retrieves the list of interface to sensor command inputs

Returns:

map of input names -> control interface objects

isConnected

boolean isConnected()

Returns the sensor connection status.
This method must do whatever it can to really detect the presence of the sensor. Consequently, this method can block for long periods of time.

Returns:

true if sensor is actually connected and can communicate with the driver