org.sensorhub.impl.sensor

Class SensorSystem

java.lang.Object

org.sensorhub.impl.module.AbstractModule<ConfigType>

org.sensorhub.impl.sensor.AbstractSensorModule<SensorSystemConfig>

org.sensorhub.impl.sensor.SensorSystem

All Implemented Interfaces:

IEventProducer, IDataProducerModule<SensorSystemConfig>, IModuleWithDescription, IModule<SensorSystemConfig>, ISensorModule<SensorSystemConfig>

public class SensorSystem
extends AbstractSensorModule<SensorSystemConfig>

Class allowing to group several sensors drivers and processes into a single system.
The system's outputs consist of the ones from the individual sensors and processes included in the group.
Relative location and orientation of components can also be set

Since:

Mar 19, 2016

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_ID
static String	DEFAULT_XMLID_PREFIX

Fields inherited from class org.sensorhub.impl.sensor.AbstractSensorModule

ERROR_NO_ENTITIES, ERROR_NO_HISTORY, ERROR_NO_UPDATE, foi, lastUpdatedSensorDescription, LOCATION_OUTPUT_ID, LOCATION_OUTPUT_NAME, locationOutput, randomUniqueID, sensorDescLock, sensorDescription, STATE_LAST_SML_UPDATE, STATE_UNIQUE_ID, uniqueID, UUID_URI_PREFIX, xmlID

Fields inherited from class org.sensorhub.impl.module.AbstractModule

config, eventHandler, lastError, logger, securityHandler, startRequested, state, stateLock, statusMsg

Constructor Summary

Constructors

Constructor and Description
SensorSystem()

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Cleans up all ressources used by the module when deleted All persistent resources created by the module should be cleaned when this is called
protected void	generateXmlIDFromUUID(String uuid)
Map<String,IProcessModule<?>>	getProcesses()
Map<String,ISensorModule<?>>	getSensors()
void	init() Initializes the module synchronously with the current configuration. Implementations of this method must block until the module is successfully initialized or send an exception. Module lifecycle events may not be generated when calling this method directly.
boolean	isConnected() Returns the sensor connection status. This method must do whatever it can to really detect the presence of the sensor.
void	loadState(IModuleStateManager loader) Restores the state of this module Implementations of this method must block until the module state is successfully loaded or send an exception.
void	saveState(IModuleStateManager saver) Saves the state of this module. Implementations of this method must block until the module state is successfully saved or send an exception.
void	start() Starts the module synchronously with the current configuration. Implementations of this method must block until the module is successfully started or send an exception. Module lifecycle events may not be generated when calling this method directly. init() should always be called before start().
void	stop() Stops the module. All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.) Implementations of this method must block until the module is successfully stopped or send an exception. Module lifecycle events may not be generated when calling this method directly. stop() can be called right after init() even if start() hasn't been called.
protected void	updateSensorDescription() This method should be called whenever the sensor description needs to be regenerated. This default implementation reads the base description from the SensorML file if provided and then appends the unique sensor identifier, time validity and the description of all registered outputs and control inputs.

Methods inherited from class org.sensorhub.impl.sensor.AbstractSensorModule

addControlInput, addLocationOutput, addOutput, generateUniqueID, generateXmlID, getAllOutputs, getCommandInputs, getCurrentDescription, getCurrentFeatureOfInterest, getDefaultIdSuffix, getLastDescriptionUpdate, getLocalFrameID, getObservationOutputs, getStatusOutputs, getUniqueIdentifier, init, notifyNewDescription, removeAllControlInputs, removeAllOutputs, updateConfig

Methods inherited from class org.sensorhub.impl.module.AbstractModule

canInit, canStart, canStop, clearError, clearStatus, getConfiguration, getCurrentError, getCurrentState, getLocalID, getLogger, getName, getStatusMessage, isInitialized, isStarted, notifyConnectionStatus, registerListener, reportError, reportError, reportStatus, requestInit, requestStart, requestStop, setConfiguration, setState, toString, unregisterListener, waitForState

Methods inherited from class java.lang.Object

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

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

getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, isInitialized, isStarted, registerListener, requestInit, requestStart, requestStop, setConfiguration, unregisterListener, waitForState

Field Detail

DEFAULT_XMLID_PREFIX

public static final String DEFAULT_XMLID_PREFIX

See Also:

Constant Field Values

AUTO_ID

public static final String AUTO_ID

See Also:

Constant Field Values

Constructor Detail

SensorSystem

public SensorSystem()

Method Detail

init

public void init()
          throws SensorHubException

Description copied from interface: IModule

Initializes the module synchronously with the current configuration.
Implementations of this method must block until the module is successfully initialized or send an exception.
Module lifecycle events may not be generated when calling this method directly.

Specified by:

init in interface IModule<SensorSystemConfig>

Overrides:

init in class AbstractSensorModule<SensorSystemConfig>

Throws:

SensorHubException

updateSensorDescription

protected void updateSensorDescription()

Description copied from class: AbstractSensorModule

This method should be called whenever the sensor description needs to be regenerated.
This default implementation reads the base description from the SensorML file if provided and then appends the unique sensor identifier, time validity and the description of all registered outputs and control inputs. This will also update the lastUpdatedSensorDescription time stamp and send a SENSOR_CHANGED event when

Overrides:

updateSensorDescription in class AbstractSensorModule<SensorSystemConfig>

start

public void start()
           throws SensorHubException

Description copied from interface: IModule

Starts the module synchronously with the current configuration.
Implementations of this method must block until the module is successfully started or send an exception.
Module lifecycle events may not be generated when calling this method directly.
init() should always be called before start().

Throws:

SensorHubException

stop

public void stop()
          throws SensorHubException

Description copied from interface: IModule

Stops the module.
All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.)
Implementations of this method must block until the module is successfully stopped or send an exception.
Module lifecycle events may not be generated when calling this method directly.
stop() can be called right after init() even if start() hasn't been called.

Throws:

SensorHubException

cleanup

public void cleanup()
             throws SensorHubException

Description copied from interface: IModule

Cleans up all ressources used by the module when deleted All persistent resources created by the module should be cleaned when this is called

Throws:

SensorHubException

isConnected

public boolean isConnected()

Description copied from interface: ISensorModule

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

loadState

public void loadState(IModuleStateManager loader)
               throws SensorHubException

Description copied from interface: IModule

Restores the state of this module
Implementations of this method must block until the module state is successfully loaded or send an exception.

Specified by:

loadState in interface IModule<SensorSystemConfig>

Overrides:

loadState in class AbstractSensorModule<SensorSystemConfig>

Throws:

SensorHubException

saveState

public void saveState(IModuleStateManager saver)
               throws SensorHubException

Description copied from interface: IModule

Saves the state of this module.
Implementations of this method must block until the module state is successfully saved or send an exception.

Specified by:

saveState in interface IModule<SensorSystemConfig>

Overrides:

saveState in class AbstractSensorModule<SensorSystemConfig>

Throws:

SensorHubException

getSensors

public Map<String,ISensorModule<?>> getSensors()

getProcesses

public Map<String,IProcessModule<?>> getProcesses()

generateXmlIDFromUUID

protected void generateXmlIDFromUUID(String uuid)

Overrides:

generateXmlIDFromUUID in class AbstractSensorModule<SensorSystemConfig>