org.yamcs.algorithms

Class AbstractAlgorithmExecutor

java.lang.Object

org.yamcs.algorithms.AbstractAlgorithmExecutor

All Implemented Interfaces:

AlgorithmExecutor

Direct Known Subclasses:

MathAlgorithmExecutor, ScriptAlgorithmExecutor

public abstract class AbstractAlgorithmExecutor
extends Object
implements AlgorithmExecutor

Field Summary

Fields

Modifier and Type	Field and Description
protected Algorithm	algorithmDef
protected AlgorithmExecutionContext	execCtx
protected CopyOnWriteArrayList<AlgorithmExecListener>	execListeners
protected Set<InputParameter>	mandatoryToRun
protected Set<Parameter>	requiredParameters

Constructor Summary

Constructors

Constructor and Description
AbstractAlgorithmExecutor(Algorithm algorithmDef, AlgorithmExecutionContext execCtx)

Method Summary

Modifier and Type	Method and Description
void	addExecListener(AlgorithmExecListener listener)
Algorithm	getAlgorithm()
AlgorithmExecutionContext	getExecutionContext()
int	getLookbackSize(Parameter parameter)
Set<Parameter>	getRequiredParameters()
protected void	propagateToListeners(Object returnValue, List<ParameterValue> outputValues)
protected abstract void	updateInput(InputParameter inputParameter, ParameterValue newValue)
boolean	updateParameters(List<ParameterValue> items) update the parameters and return true if the algorithm should run

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.algorithms.AlgorithmExecutor

runAlgorithm

Field Detail

execCtx

protected final AlgorithmExecutionContext execCtx

algorithmDef

protected final Algorithm algorithmDef

execListeners

protected final CopyOnWriteArrayList<AlgorithmExecListener> execListeners

requiredParameters

protected Set<Parameter> requiredParameters

mandatoryToRun

protected Set<InputParameter> mandatoryToRun

Constructor Detail

AbstractAlgorithmExecutor

public AbstractAlgorithmExecutor(Algorithm algorithmDef,
                                 AlgorithmExecutionContext execCtx)

Method Detail

updateParameters

public boolean updateParameters(List<ParameterValue> items)

update the parameters and return true if the algorithm should run

Specified by:

updateParameters in interface AlgorithmExecutor

Parameters:

items -

Returns:

true if the algorithm should run

updateInput

protected abstract void updateInput(InputParameter inputParameter,
                                    ParameterValue newValue)

propagateToListeners

protected void propagateToListeners(Object returnValue,
                                    List<ParameterValue> outputValues)

addExecListener

public void addExecListener(AlgorithmExecListener listener)

Specified by:

addExecListener in interface AlgorithmExecutor

getExecutionContext

public AlgorithmExecutionContext getExecutionContext()

Specified by:

getExecutionContext in interface AlgorithmExecutor

getLookbackSize

public int getLookbackSize(Parameter parameter)

Specified by:

getLookbackSize in interface AlgorithmExecutor

getRequiredParameters

public Set<Parameter> getRequiredParameters()

Specified by:

getRequiredParameters in interface AlgorithmExecutor

getAlgorithm

public Algorithm getAlgorithm()

Specified by:

getAlgorithm in interface AlgorithmExecutor