Package gda.jython

Class GDAJythonScriptService

java.lang.Object

gda.jython.GDAJythonScriptService

All Implemented Interfaces:

IScriptService

public class GDAJythonScriptService
extends Object
implements IScriptService

Implementation of IScriptService for GDA. Runs scripts via the ICommandRunner interface (i.e. JythonServerFacade). The language supported is ScriptLanguage.SPEC_PASTICHE.

Field Summary

Fields inherited from interface org.eclipse.scanning.api.script.IScriptService

VAR_NAME_CUSTOM_PARAMS, VAR_NAME_SCAN_BEAN, VAR_NAME_SCAN_MODEL, VAR_NAME_SCAN_PATH, VAR_NAME_SCAN_REQUEST, VAR_NAME_SCAN_REQUEST_JSON

Constructor Summary

Constructors

Constructor	Description
GDAJythonScriptService()

Method Summary

Modifier and Type	Method	Description
void	abortScripts()	Aborts any currently executing scripts.
void	execute(ScriptRequest req)	Execute a script on the server.
void	setNamedValue(String name, Object value)	Sets the variable with the given name to the given value, if the implementation supports this.
ScriptLanguage[]	supported()	For DAQ server version 8 and 9 this will probably be {JYTHON, SPEC_PASTICHE}

Methods inherited from class java.lang.Object

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

Constructor Details

GDAJythonScriptService

public GDAJythonScriptService()

Method Details

supported

public ScriptLanguage[] supported()

Description copied from interface: IScriptService

For DAQ server version 8 and 9 this will probably be {JYTHON, SPEC_PASTICHE}

Specified by:

supported in interface IScriptService

Returns:

the available supported scripting languages that this service can execute.

execute

public void execute(ScriptRequest req)
             throws UnsupportedLanguageException,
ScriptExecutionException

Description copied from interface: IScriptService

Execute a script on the server. This can be used for instance inside scanning to run a script before and after a scan.

Specified by:

execute in interface IScriptService

Parameters:

req - the script request

Throws:

UnsupportedLanguageException - if the script language specified by ScriptRequest.getLanguage() is not supported by this script service.

ScriptExecutionException - if an error occurred running the script

setNamedValue

public void setNamedValue(String name,
 Object value)

Description copied from interface: IScriptService

Sets the variable with the given name to the given value, if the implementation supports this.

Specified by:

setNamedValue in interface IScriptService

Parameters:

name - name

value - value

abortScripts

public void abortScripts()

Description copied from interface: IScriptService

Aborts any currently executing scripts.

Specified by:

abortScripts in interface IScriptService