org.lsst.ccs.scripting

Class ScriptingSubsystemWrapper

java.lang.Object

org.lsst.ccs.scripting.ScriptingSubsystemWrapper

public class ScriptingSubsystemWrapper
extends Object

This class defines how a script interacts with a CCS Subsystem.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptingSubsystemWrapper(String subsystemName, ConcurrentMessagingUtils cmdAgent)

Method Summary

Modifier and Type	Method and Description
Future<Object>	asynchCommand(String commandName, Object... args) Invoke an asynchronous command with arguments on the subsystem
Future<Object>	asynchCommandLine(String command) Invoke an asynchronous command line on the subsystem
Future<Object>	internalAsynchCommand(CommandRequest cmd)
ScriptingCommandResponse	synchCommand(int timeout, String commandName, Object... args) Invoke a synchronous command with arguments on the subsystem
ScriptingCommandResponse	synchCommandLine(int timeout, String command) Invoke a synchronous command line on the subsystem

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptingSubsystemWrapper

protected ScriptingSubsystemWrapper(String subsystemName,
                                    ConcurrentMessagingUtils cmdAgent)

Method Detail

synchCommand

public ScriptingCommandResponse synchCommand(int timeout,
                                             String commandName,
                                             Object... args)
                                      throws ScriptingTimeoutException,
                                             Exception

Invoke a synchronous command with arguments on the subsystem

Parameters:

timeout - Number of seconds to wait for command completion. Once the timeout is reached a ScriptingTimeoutException is thrown.

commandName - The name of the command to be executed. e.g. "takeImage"

args - Variable number of command arguments.

Returns:

The ScriptingCommandResponse containing the Object from the command execution It could be an exception if exceptions are set to be returned. See CCS.setThrowExceptions(boolean).

Throws:

ScriptingTimeoutException - When the timeout is reached a ScriptingTimeoutException will be either thrown or returned as part of the ScriptingCommandResponse, depending on CCS.setThrowExceptions(boolean).

Exception - When an exception occurs during the command execution the underlying Exception will be either thrown or returned as part of the ScriptingCommandResponse, depending on CCS.setThrowExceptions(boolean).

synchCommandLine

public ScriptingCommandResponse synchCommandLine(int timeout,
                                                 String command)
                                          throws ScriptingTimeoutException,
                                                 Exception

Invoke a synchronous command line on the subsystem

Parameters:

timeout - Number of seconds to wait for command completion. Once the timeout is reached a ScriptingTimeoutException is thrown.

command - The name full command to be executed, including the arguments. e.g. "takeImage 10 2"

Returns:

The ScriptingCommandResponse containing the Object from the command execution It could be an exception if exceptions are set to be returned. See CCS.setThrowExceptions(boolean).

Throws:

ScriptingTimeoutException - When the timeout is reached a ScriptingTimeoutException will be either thrown or returned as part of the ScriptingCommandResponse, depending on CCS.setThrowExceptions(boolean).

Exception - When an exception occurs during the command execution the underlying Exception will be either thrown or returned as part of the ScriptingCommandResponse, depending on CCS.setThrowExceptions(boolean).

asynchCommand

public Future<Object> asynchCommand(String commandName,
                                    Object... args)
                             throws Exception

Invoke an asynchronous command with arguments on the subsystem

Parameters:

commandName - The name of the command to be executed. e.g. "takeImage"

args - Variable number of command arguments.

Returns:

A java.util.concurrent.Future that will contain the ScriptingCommandResponse containing the Object resulted from the execution. The Future is returned only after the target subsystem has returned an Ack/nAck. The Object could be an Exception if exceptions are set to be returned. See CCS.setThrowExceptions(boolean).

Throws:

Exception - When an exception occurs during the command execution the underlying Exception will be either thrown or returned as part of the Future, depending on CCS.setThrowExceptions(boolean).

internalAsynchCommand

public Future<Object> internalAsynchCommand(CommandRequest cmd)
                                     throws Exception

Throws:

Exception

asynchCommandLine

public Future<Object> asynchCommandLine(String command)
                                 throws Exception

Invoke an asynchronous command line on the subsystem

Parameters:

command - The name full command to be executed, including the arguments. e.g. "takeImage 10 2"

Returns:

A java.util.concurrent.Future that will contain the ScriptingCommandResponse containing the Object resulted from the execution. The Future is returned only after the target subsystem has returned an Ack/nAck. The Object could be an Exception if exceptions are set to be returned. See CCS.setThrowExceptions(boolean).

Throws:

Exception - When an exception occurs during the command execution the underlying Exception will be either thrown or returned as part of the Future, depending on CCS.setThrowExceptions(boolean).