org.sensorhub.impl.processing

Class SMLStreamProcess

java.lang.Object

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

org.sensorhub.impl.processing.AbstractStreamProcess<SMLStreamProcessConfig>

org.sensorhub.impl.processing.SMLStreamProcess

All Implemented Interfaces:

IEventListener, IEventProducer, IDataProducerModule<SMLStreamProcessConfig>, IModuleWithDescription, IModule<SMLStreamProcessConfig>, IProcessModule<SMLStreamProcessConfig>, IStreamProcessModule<SMLStreamProcessConfig>

public class SMLStreamProcess
extends AbstractStreamProcess<SMLStreamProcessConfig>

Implementation of process module fully configured using a SensorML process chain description. The SensorML execution engine is used to execute the different processing components used in the chain.

Since:

Feb 20, 2015

Author:

Alex Robin

Nested Class Summary

Nested classes/interfaces inherited from class org.sensorhub.impl.processing.AbstractStreamProcess

AbstractStreamProcess.InputData

Field Summary

Fields inherited from class org.sensorhub.impl.processing.AbstractStreamProcess

DEFAULT_ID, errorCount, inputs, lastUpdatedSensorDescription, MAX_ERRORS, outputInterfaces, outputs, parameters, paused, processDescription, streamSources

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

config, eventHandler

Constructor Summary

Constructors

Constructor and Description
SMLStreamProcess()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	connectInput(String inputName, String dataPath, org.vast.process.DataQueue inputQueue)
void	init(SMLStreamProcessConfig config) Initializes the module with the specified configuration
boolean	isCompatibleDataSource(DataSourceConfig dataSource) Checks that a given data source is acceptable for this process
boolean	isPauseSupported() Checks if this particular processing module supports pausing
protected void	process(DataEvent lastEvent) Method called everytime a new data event has been received on any input. Concrete implementation must override this method to launch processing when appropriate (e.g.
protected void	scanIOList(net.opengis.OgcPropertyList<net.opengis.swe.v20.AbstractSWEIdentifiable> ioList, Map<String,net.opengis.swe.v20.DataComponent> ioMap, boolean isOutput)
void	start() Starts the module with the current configuration. 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.) stop() can be called right after init() even if start() hasn't been called.
void	updateConfig(SMLStreamProcessConfig config) Updates the module's configuration dynamically. The module must honor this new configuration unless an error is detected.

Methods inherited from class org.sensorhub.impl.processing.AbstractStreamProcess

addOutput, cleanup, getAllOutputs, getCurrentDescription, getCurrentFeatureOfInterest, getInputDescriptors, getLastDescriptionUpdate, getOutputDescriptors, getParameters, handleEvent, pause, resume

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

getConfiguration, getLocalID, getName, isEnabled, loadState, registerListener, saveState, unregisterListener

Methods inherited from class java.lang.Object

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

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

getConfiguration, getLocalID, getName, isEnabled, loadState, registerListener, saveState, unregisterListener

Constructor Detail

SMLStreamProcess

public SMLStreamProcess()

Method Detail

init

public void init(SMLStreamProcessConfig config)
          throws SensorHubException

Description copied from interface: IModule

Initializes the module with the specified configuration

Specified by:

init in interface IModule<SMLStreamProcessConfig>

Overrides:

init in class AbstractModule<SMLStreamProcessConfig>

Throws:

SensorHubException

updateConfig

public void updateConfig(SMLStreamProcessConfig config)
                  throws SensorHubException

Description copied from interface: IModule

Updates the module's configuration dynamically.
The module must honor this new configuration unless an error is detected. It is the responsability of the module to initiate a restart if the new configuration requires it.

Specified by:

updateConfig in interface IModule<SMLStreamProcessConfig>

Overrides:

updateConfig in class AbstractModule<SMLStreamProcessConfig>

Throws:

SensorHubException

connectInput

protected void connectInput(String inputName,
                String dataPath,
                org.vast.process.DataQueue inputQueue)
                     throws Exception

Overrides:

connectInput in class AbstractStreamProcess<SMLStreamProcessConfig>

Throws:

Exception

scanIOList

protected void scanIOList(net.opengis.OgcPropertyList<net.opengis.swe.v20.AbstractSWEIdentifiable> ioList,
              Map<String,net.opengis.swe.v20.DataComponent> ioMap,
              boolean isOutput)
                   throws ProcessException

Throws:

ProcessException

start

public void start()
           throws SensorHubException

Description copied from interface: IModule

Starts the module with the current configuration.
init() should always be called before start().

Specified by:

start in interface IModule<SMLStreamProcessConfig>

Overrides:

start in class AbstractStreamProcess<SMLStreamProcessConfig>

Throws:

SensorHubException

stop

public void stop()

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.)
stop() can be called right after init() even if start() hasn't been called.

Specified by:

stop in interface IModule<SMLStreamProcessConfig>

Overrides:

stop in class AbstractStreamProcess<SMLStreamProcessConfig>

isPauseSupported

public boolean isPauseSupported()

Description copied from interface: IStreamProcessModule

Checks if this particular processing module supports pausing

Returns:

true if the process can be paused and resumed at any time

isCompatibleDataSource

public boolean isCompatibleDataSource(DataSourceConfig dataSource)

Description copied from interface: IProcessModule

Checks that a given data source is acceptable for this process

Returns:

true if data source is acceptable for this process

process

protected void process(DataEvent lastEvent)
                throws ProcessException

Description copied from class: AbstractStreamProcess

Method called everytime a new data event has been received on any input.
Concrete implementation must override this method to launch processing when appropriate (e.g. when enough data has been received).
Since data is accumulated in input queues, process should properly remove any data that needs to be discarded from the queues, as early as possible, even when no processing is done.

Specified by:

process in class AbstractStreamProcess<SMLStreamProcessConfig>

Parameters:

lastEvent - data event triggering this call

Throws:

ProcessException