org.lsst.ccs.utilities.scripting

Interface CCS

All Known Subinterfaces:

CCS

public interface CCS

THIS IS THROW AWAY CODE ONLY NEEDED FOR THE SCRIPTING DISCUSSION. Main scripting entry point to CCS.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptingSubsystemWrapper	attachSubsystem(String subsystemName) Creates and instance of a ScriptingSubsystemWrapper by making sure that the given subsystemName corresponds to a CCS subsystem that is currently available, not locked and alive.
boolean	getThrowExceptions() Returns true if exceptions are thrown, otherwise they are returned as the Object on the invoke methods.
void	setThrowExceptions(boolean throwExceptions) In the scripting environment, exceptions resulted from method invocation can either be thrown or returned.

Method Detail

setThrowExceptions

void setThrowExceptions(boolean throwExceptions)

In the scripting environment, exceptions resulted from method invocation can either be thrown or returned. Use this method to toggle between the two options.

Parameters:

throwExceptions - boolean flag. If true exceptions will be thrown.

getThrowExceptions

boolean getThrowExceptions()

Returns true if exceptions are thrown, otherwise they are returned as the Object on the invoke methods.

Returns:

true/false to indicate if exceptions are thrown/returned

attachSubsystem

ScriptingSubsystemWrapper attachSubsystem(String subsystemName)
                                          throws RuntimeException

Creates and instance of a ScriptingSubsystemWrapper by making sure that the given subsystemName corresponds to a CCS subsystem that is currently available, not locked and alive. The process of creating the ScriptingSubsystemWrapper involves acquiring a lock on the subsystem. Should we be able to specify the lock level?

Parameters:

subsystemName - The name of the CCS subsystem. e.g. ccs-rafts.

Returns:

The ScriptingSubsystemWrapper representing the CCS subsystem

Throws:

RuntimeException