Package org.eclipse.scanning.api.script

Interface IScriptService

All Known Implementing Classes:

GDAJythonScriptService

public interface IScriptService

A service to run scripts, python, javascript, r etc. This service may be backed by a custom engine which supports a subset of the scripting languages. It might be implemented by an OSGi Jython or by an eclipse EASE environment.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VAR_NAME_CUSTOM_PARAMS
static final String	VAR_NAME_SCAN_BEAN
static final String	VAR_NAME_SCAN_MODEL
static final String	VAR_NAME_SCAN_PATH
static final String	VAR_NAME_SCAN_REQUEST
static final String	VAR_NAME_SCAN_REQUEST_JSON

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}

Field Details

VAR_NAME_SCAN_BEAN

static final String VAR_NAME_SCAN_BEAN

See Also:

• Constant Field Values

VAR_NAME_SCAN_REQUEST

static final String VAR_NAME_SCAN_REQUEST

See Also:

• Constant Field Values

VAR_NAME_SCAN_REQUEST_JSON

static final String VAR_NAME_SCAN_REQUEST_JSON

See Also:

• Constant Field Values

VAR_NAME_SCAN_MODEL

static final String VAR_NAME_SCAN_MODEL

See Also:

• Constant Field Values

VAR_NAME_SCAN_PATH

static final String VAR_NAME_SCAN_PATH

See Also:

• Constant Field Values

VAR_NAME_CUSTOM_PARAMS

static final String VAR_NAME_CUSTOM_PARAMS

See Also:

• Constant Field Values

Method Details

supported

ScriptLanguage[] supported()

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

Returns:

the available supported scripting languages that this service can execute.

setNamedValue

void setNamedValue(String name,
 Object value)

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

Parameters:

name - name

value - value

execute

void execute(ScriptRequest req)
      throws UnsupportedLanguageException,
ScriptExecutionException

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

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

abortScripts

void abortScripts()

Aborts any currently executing scripts.