Package 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	Description
protected	ScriptingSubsystemWrapper(String subsystemName, ConcurrentMessagingUtils cmdAgent)

Method Summary

Modifier and Type	Method	Description
Future<Object>	internalAsynchCommand(CommandRequest cmd)
Future<Object>	sendAsynchCommand(String commandName, Object... args)	Invoke an asynchronous command with arguments on the subsystem
Object	sendSynchCommand(String commandName, Object... args)
Object	sendSynchCommand(Duration timeout, String commandName, Object... args)	Invoke a synchronous command with arguments on the subsystem

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptingSubsystemWrapper

protected ScriptingSubsystemWrapper(String subsystemName,
 ConcurrentMessagingUtils cmdAgent)

Method Details

sendSynchCommand

public Object sendSynchCommand(Duration timeout,
 String commandName,
 Object... args)
                        throws ScriptingTimeoutException,
Exception

Invoke a synchronous command with arguments on the subsystem

Parameters:

timeout - Duration 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 Object obtained 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 depending on CCS.setThrowExceptions(boolean).

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

sendSynchCommand

public Object sendSynchCommand(String commandName,
 Object... args)
                        throws ScriptingTimeoutException,
Exception

Throws:

ScriptingTimeoutException

Exception

sendAsynchCommand

public Future<Object> sendAsynchCommand(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