org.sensorhub.impl.sensor.swe

Class SWEVirtualSensor

java.lang.Object

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

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

org.sensorhub.impl.sensor.swe.SWEVirtualSensor

All Implemented Interfaces:

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

public class SWEVirtualSensor
extends AbstractSensorModule<SWEVirtualSensorConfig>

Driver for SWE enabled sensors communicating via SOS & SPS standard services. This can also be used to communicate with a sensor deployed on another (usually remote) sensor hub node. TODO forward full SensorML description

Since:

Sep 5, 2015

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

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

DEFAULT_XMLID_PREFIX, 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
SWEVirtualSensor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkConfig()
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
AbstractFeature	getCurrentFeatureOfInterest() Retrieves the feature of interest for which this producer is currently generating data. In the case of a module generating data from multiple entities (e.g.
boolean	isConnected() Returns the sensor connection status. This method must do whatever it can to really detect the presence of the sensor.
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, generateXmlIDFromUUID, getAllOutputs, getCommandInputs, getCurrentDescription, getDefaultIdSuffix, getLastDescriptionUpdate, getLocalFrameID, getObservationOutputs, getStatusOutputs, getUniqueIdentifier, init, init, loadState, notifyNewDescription, removeAllControlInputs, removeAllOutputs, saveState, 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

log

protected static final org.slf4j.Logger log

Constructor Detail

SWEVirtualSensor

public SWEVirtualSensor()

Method Detail

checkConfig

protected void checkConfig()
                    throws SensorHubException

Throws:

SensorHubException

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

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<SWEVirtualSensorConfig>

getCurrentFeatureOfInterest

public AbstractFeature getCurrentFeatureOfInterest()

Description copied from interface: IDataProducerModule

Retrieves the feature of interest for which this producer is currently generating data.

In the case of a module generating data from multiple entities (e.g. sensor network), the feature of interest currently observed by a given entity can be retrieved using IMultiSourceDataProducer.getCurrentFeatureOfInterest(String)

Specified by:

getCurrentFeatureOfInterest in interface IDataProducerModule<SWEVirtualSensorConfig>

Overrides:

getCurrentFeatureOfInterest in class AbstractSensorModule<SWEVirtualSensorConfig>

Returns:

map of entityID to feature objects

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