org.lsst.ccs.utilities.scripting

Interface ScriptingSubsystemWrapper

public interface ScriptingSubsystemWrapper

THIS IS THROW AWAY CODE ONLY NEEDED FOR THE SCRIPTING DISCUSSION. This interface defines how a script interacts with a CCS Subsystem.

Method Summary

Methods

Modifier and Type	Method and Description
Future<ScriptingCommandResponse>	invokeAsynchronous(String command) Invoke an asynchronous command on the subsystem
Future<ScriptingCommandResponse>	invokeAsynchronous(String commandName, Object... args) Invoke an asynchronous command on the subsystem
ScriptingCommandResponse	invokeSynchronous(int timeout, String command) Invoke a synchronous command on the subsystem
ScriptingCommandResponse	invokeSynchronous(int timeout, String commandName, Object... args) Invoke a synchronous command on the subsystem

Method Detail

invokeSynchronous

ScriptingCommandResponse invokeSynchronous(int timeout,
                                         String commandName,
                                         Object... args)
                                           throws ScriptingTimeoutException

Invoke a synchronous command 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 - if exceptions are set to be thrown.

invokeSynchronous

ScriptingCommandResponse invokeSynchronous(int timeout,
                                         String command)
                                           throws ScriptingTimeoutException

Invoke a synchronous command 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 - if exceptions are set to be thrown.

invokeAsynchronous

Future<ScriptingCommandResponse> invokeAsynchronous(String commandName,
                                                  Object... args)

Invoke an asynchronous command 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).

invokeAsynchronous

Future<ScriptingCommandResponse> invokeAsynchronous(String command)

Invoke an asynchronous command 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).