org.sensorhub.impl.sensor

Class AbstractSensorControl<SensorType extends ISensorModule<?>>

java.lang.Object

org.sensorhub.impl.sensor.AbstractSensorControl<SensorType>

Type Parameters:

SensorType - Type of parent sensor

All Implemented Interfaces:

IEventProducer, ISensorControlInterface

Direct Known Subclasses:

SWEVirtualSensorControl

public abstract class AbstractSensorControl<SensorType extends ISensorModule<?>>
extends Object
implements ISensorControlInterface

Default implementation of common sensor control interface API methods. By default, async exec, scheduling and status history are reported as unsupported.

Since:

Nov 22, 2014

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_NO_ASYNC
protected static String	ERROR_NO_SCHED
protected static String	ERROR_NO_STATUS_HISTORY
protected IEventHandler	eventHandler
protected SensorType	parentSensor

Constructor Summary

Constructors

Constructor and Description
AbstractSensorControl(SensorType parentSensor)

Method Summary

Methods

Modifier and Type	Method and Description
CommandStatus	cancelCommand(String commandID) Cancels a command before it is executed (for async or scheduled commands)
CommandStatus	execCommandGroup(List<DataBlock> commands) Executes multiple commands synchronously and in the order specified.
CommandStatus	getCommandStatus(String commandID) Retrieves command status
List<CommandStatus>	getCommandStatusHistory(String commandID) Gets complete status history for the specified command
ISensorModule<?>	getParentSensor() Allows by-reference access to parent sensor interface
boolean	isAsyncExecSupported() Checks asynchronous execution capability
boolean	isEnabled() Checks if this interface is enabled
boolean	isSchedulingSupported() Checks scheduled execution capability
boolean	isStatusHistorySupported() Checks status history capability
void	registerListener(IEventListener listener) Registers a listener with this event producer.
CommandStatus	scheduleCommand(DataBlock command, DateTime execTime) Schedules a command to be executed asynchronously at the specified time
CommandStatus	scheduleCommandGroup(List<DataBlock> commands, DateTime execTime) Schedules a group of commands to be executed asynchronously at the specified time.
CommandStatus	sendCommand(DataBlock command) Sends a command that will be executed asynchronously
CommandStatus	sendCommandGroup(List<DataBlock> commands) Sends a group of commands for asynchronous execution.
void	unregisterListener(IEventListener listener) Unregisters a listener from this event producer.

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.sensor.ISensorControlInterface

execCommand, getCommandDescription, getName

Field Detail

ERROR_NO_ASYNC

protected static String ERROR_NO_ASYNC

ERROR_NO_SCHED

protected static String ERROR_NO_SCHED

ERROR_NO_STATUS_HISTORY

protected static String ERROR_NO_STATUS_HISTORY

parentSensor

protected SensorType extends ISensorModule<?> parentSensor

eventHandler

protected IEventHandler eventHandler

Constructor Detail

AbstractSensorControl

public AbstractSensorControl(SensorType parentSensor)

Method Detail

getParentSensor

public ISensorModule<?> getParentSensor()

Description copied from interface: ISensorControlInterface

Allows by-reference access to parent sensor interface

Specified by:

getParentSensor in interface ISensorControlInterface

Returns:

the parent sensor module instance

isEnabled

public boolean isEnabled()

Description copied from interface: ISensorControlInterface

Checks if this interface is enabled

Specified by:

isEnabled in interface ISensorControlInterface

Returns:

true if interface is enabled, false otherwise

execCommandGroup

public CommandStatus execCommandGroup(List<DataBlock> commands)
                               throws SensorException

Description copied from interface: ISensorControlInterface

Executes multiple commands synchronously and in the order specified. This method will block until all commands are completed

Specified by:

execCommandGroup in interface ISensorControlInterface

Parameters:

commands - list of command messages data

Returns:

a single status message for the command group

Throws:

SensorException

isAsyncExecSupported

public boolean isAsyncExecSupported()

Description copied from interface: ISensorControlInterface

Checks asynchronous execution capability

Specified by:

isAsyncExecSupported in interface ISensorControlInterface

Returns:

true if asynchronous command execution is supported, false otherwise

isSchedulingSupported

public boolean isSchedulingSupported()

Description copied from interface: ISensorControlInterface

Checks scheduled execution capability

Specified by:

isSchedulingSupported in interface ISensorControlInterface

Returns:

true if scheduled command execution is supported, false otherwise

isStatusHistorySupported

public boolean isStatusHistorySupported()

Description copied from interface: ISensorControlInterface

Checks status history capability

Specified by:

isStatusHistorySupported in interface ISensorControlInterface

Returns:

true if status history is supported, false otherwise

sendCommand

public CommandStatus sendCommand(DataBlock command)
                          throws SensorException

Description copied from interface: ISensorControlInterface

Sends a command that will be executed asynchronously

Specified by:

sendCommand in interface ISensorControlInterface

Parameters:

command - command message data

Returns:

initial status of the command (can change during the command life cycle)

Throws:

SensorException

See Also:

ISensorControlInterface.isAsyncExecSupported()

sendCommandGroup

public CommandStatus sendCommandGroup(List<DataBlock> commands)
                               throws SensorException

Description copied from interface: ISensorControlInterface

Sends a group of commands for asynchronous execution. Order is guaranteed but not atomicity

Specified by:

sendCommandGroup in interface ISensorControlInterface

Parameters:

commands - list of command messages data

Returns:

a single status object for the command group

Throws:

SensorException

See Also:

ISensorControlInterface.isAsyncExecSupported()

scheduleCommand

public CommandStatus scheduleCommand(DataBlock command,
                            DateTime execTime)
                              throws SensorException

Description copied from interface: ISensorControlInterface

Schedules a command to be executed asynchronously at the specified time

Specified by:

scheduleCommand in interface ISensorControlInterface

Parameters:

command - command message data

execTime - desired time of execution

Returns:

initial status of the command (can change during the command life cycle)

Throws:

SensorException

See Also:

ISensorControlInterface.isSchedulingSupported()

scheduleCommandGroup

public CommandStatus scheduleCommandGroup(List<DataBlock> commands,
                                 DateTime execTime)
                                   throws SensorException

Description copied from interface: ISensorControlInterface

Schedules a group of commands to be executed asynchronously at the specified time. Order is guaranteed but not atomicity

Specified by:

scheduleCommandGroup in interface ISensorControlInterface

Returns:

a single status object for the command group

Throws:

SensorException

See Also:

ISensorControlInterface.isSchedulingSupported()

cancelCommand

public CommandStatus cancelCommand(String commandID)
                            throws SensorException

Description copied from interface: ISensorControlInterface

Cancels a command before it is executed (for async or scheduled commands)

Specified by:

cancelCommand in interface ISensorControlInterface

Parameters:

commandID - id of command to be canceled

Returns:

status of the cancelled command

Throws:

SensorException

See Also:

ISensorControlInterface.isAsyncExecSupported()

getCommandStatus

public CommandStatus getCommandStatus(String commandID)
                               throws SensorException

Description copied from interface: ISensorControlInterface

Retrieves command status

Specified by:

getCommandStatus in interface ISensorControlInterface

Parameters:

commandID - id of command to get status for

Returns:

current status of the command with the specified ID

Throws:

SensorException

See Also:

ISensorControlInterface.isAsyncExecSupported()

getCommandStatusHistory

public List<CommandStatus> getCommandStatusHistory(String commandID)
                                            throws SensorException

Description copied from interface: ISensorControlInterface

Gets complete status history for the specified command

Specified by:

getCommandStatusHistory in interface ISensorControlInterface

Parameters:

commandID - id of command to get status history for

Returns:

list of command status, one object for each status change

Throws:

SensorException

See Also:

ISensorControlInterface.isStatusHistorySupported()

registerListener

public void registerListener(IEventListener listener)

Description copied from interface: IEventProducer

Registers a listener with this event producer. The listener is reponsible for filtering received events.

Specified by:

registerListener in interface IEventProducer

unregisterListener

public void unregisterListener(IEventListener listener)

Description copied from interface: IEventProducer

Unregisters a listener from this event producer. No more event will be sent to the listener from this producer.

Specified by:

unregisterListener in interface IEventProducer