Module org.yamcs.core

Package org.yamcs.algorithms

Class ScriptAlgorithmExecutorFactory

java.lang.Object

org.yamcs.algorithms.ScriptAlgorithmExecutorFactory

All Implemented Interfaces:

AlgorithmExecutorFactory

public class ScriptAlgorithmExecutorFactory
extends Object
implements AlgorithmExecutorFactory

Handles the creation of algorithm executors for script algorithms for a given language and scriptEngine (currently javascript or python are supported).

Each algorithm is created as a function in the scriptEngine. There might be multiple executors for the same algorithm: for example in the command verifier there will be one algorithm executor for each command. However there will be only one function created in the script engine.

Constructor Summary

Constructors

Constructor	Description
ScriptAlgorithmExecutorFactory(ScriptEngineManager scriptEngineManager, String language, List<String> libraryNames)

Method Summary

Modifier and Type	Method	Description
static String	generateFunctionCode(String functionName, CustomAlgorithm algorithmDef)
List<String>	getLanguages()	Returns all the languages supported by this factory.
ScriptAlgorithmExecutor	makeExecutor(CustomAlgorithm calg, AlgorithmExecutionContext execCtx)	Creates a new executor for the algorithm running in the execution context

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptAlgorithmExecutorFactory

public ScriptAlgorithmExecutorFactory(ScriptEngineManager scriptEngineManager,
 String language,
 List<String> libraryNames)

Method Details

makeExecutor

public ScriptAlgorithmExecutor makeExecutor(CustomAlgorithm calg,
 AlgorithmExecutionContext execCtx)

Description copied from interface: AlgorithmExecutorFactory

Creates a new executor for the algorithm running in the execution context

Specified by:

makeExecutor in interface AlgorithmExecutorFactory

Parameters:

calg - - the algorithm definition

execCtx - - the algorithm execution context

Returns:

generateFunctionCode

public static String generateFunctionCode(String functionName,
 CustomAlgorithm algorithmDef)

getLanguages

public List<String> getLanguages()

Description copied from interface: AlgorithmExecutorFactory

Returns all the languages supported by this factory. Used in order to not create new factories for the same language with different names (e.g. JavaScript and ECMAScript)

Specified by:

getLanguages in interface AlgorithmExecutorFactory

Returns: