org.sensorhub.api.sensor

Interface ISensorControlInterface

All Superinterfaces:

IEventProducer

public interface ISensorControlInterface
extends IEventProducer

Interface to be implemented by all sensor drivers connected to the system Commands can be sent to each sensor controllable input via this interface. Commands can be executed synchronously or asynchronously by sensors. If asynchronous mode is supported, implementations of this class MUST produce events of type SensorControlEvent.

Since:

Nov 5, 2010

Method Summary

Modifier and Type	Method and Description
CommandStatus	cancelCommand(java.lang.String commandID) Cancels a command before it is executed (for async or scheduled commands)
CommandStatus	execCommand(DataBlock command) Executes the command synchronously, blocking until completion of command
CommandStatus	execCommandGroup(java.util.List<DataBlock> commands) Executes multiple commands synchronously and in the order specified.
DataComponent	getCommandDescription() Retrieves description of command message Note that this can be a choice of multiple messages
CommandStatus	getCommandStatus(java.lang.String commandID) Retrieves command status
java.util.List<CommandStatus>	getCommandStatusHistory(java.lang.String commandID) Gets complete status history for the specified command
java.lang.String	getName() Gets the interface name.
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
CommandStatus	scheduleCommand(DataBlock command, org.vast.util.DateTime execTime) Schedules a command to be executed asynchronously at the specified time
CommandStatus	scheduleCommandGroup(java.util.List<DataBlock> commands, org.vast.util.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(java.util.List<DataBlock> commands) Sends a group of commands for asynchronous execution.

Methods inherited from interface org.sensorhub.api.common.IEventProducer

registerListener, unregisterListener

Method Detail

getParentSensor

ISensorModule<?> getParentSensor()

Allows by-reference access to parent sensor interface

Returns:

the parent sensor module instance

getName

java.lang.String getName()

Gets the interface name. It should be the name reported in the map by ISensorModule.getCommandInputs()

Returns:

name of this control interface

isEnabled

boolean isEnabled()

Checks if this interface is enabled

Returns:

true if interface is enabled, false otherwise

isAsyncExecSupported

boolean isAsyncExecSupported()

Checks asynchronous execution capability

Returns:

true if asynchronous command execution is supported, false otherwise

isSchedulingSupported

boolean isSchedulingSupported()

Checks scheduled execution capability

Returns:

true if scheduled command execution is supported, false otherwise

isStatusHistorySupported

boolean isStatusHistorySupported()

Checks status history capability

Returns:

true if status history is supported, false otherwise

getCommandDescription

DataComponent getCommandDescription()

Retrieves description of command message Note that this can be a choice of multiple messages

Returns:

Data component containing message structure

execCommand

CommandStatus execCommand(DataBlock command)
                   throws SensorException

Executes the command synchronously, blocking until completion of command

Parameters:

command - command message data

Returns:

status after execution of command

Throws:

SensorException

execCommandGroup

CommandStatus execCommandGroup(java.util.List<DataBlock> commands)
                        throws SensorException

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

Parameters:

commands - list of command messages data

Returns:

a single status message for the command group

Throws:

SensorException

sendCommand

CommandStatus sendCommand(DataBlock command)
                   throws SensorException

Sends a command that will be executed asynchronously

Parameters:

command - command message data

Returns:

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

Throws:

SensorException

See Also:

isAsyncExecSupported()

sendCommandGroup

CommandStatus sendCommandGroup(java.util.List<DataBlock> commands)
                        throws SensorException

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

Parameters:

commands - list of command messages data

Returns:

a single status object for the command group

Throws:

SensorException

See Also:

isAsyncExecSupported()

scheduleCommand

CommandStatus scheduleCommand(DataBlock command,
                              org.vast.util.DateTime execTime)
                       throws SensorException

Schedules a command to be executed asynchronously at the specified time

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:

isSchedulingSupported()

scheduleCommandGroup

CommandStatus scheduleCommandGroup(java.util.List<DataBlock> commands,
                                   org.vast.util.DateTime execTime)
                            throws SensorException

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

Parameters:

commands -

execTime -

Returns:

a single status object for the command group

Throws:

SensorException

See Also:

isSchedulingSupported()

cancelCommand

CommandStatus cancelCommand(java.lang.String commandID)
                     throws SensorException

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

Parameters:

commandID - id of command to be canceled

Returns:

status of the cancelled command

Throws:

SensorException

See Also:

isAsyncExecSupported()

getCommandStatus

CommandStatus getCommandStatus(java.lang.String commandID)
                        throws SensorException

Retrieves command status

Parameters:

commandID - id of command to get status for

Returns:

current status of the command with the specified ID

Throws:

SensorException

See Also:

isAsyncExecSupported()

getCommandStatusHistory

java.util.List<CommandStatus> getCommandStatusHistory(java.lang.String commandID)
                                               throws SensorException

Gets complete status history for the specified command

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:

isStatusHistorySupported()