org.yamcs.algorithms

Interface AlgorithmExecutor

All Known Subinterfaces:

DataDecoder

All Known Implementing Classes:

AbstractAlgorithmExecutor, AbstractDataDecoder, ScriptAlgorithmExecutor

public interface AlgorithmExecutor

Represents the execution context of one algorithm. An AlgorithmExecutor is reused upon each update of one or more of its InputParameters.

Method Summary

Modifier and Type	Method and Description
void	addExecListener(AlgorithmExecListener listener)
Algorithm	getAlgorithm()
AlgorithmExecutionContext	getExecutionContext()
int	getLookbackSize(Parameter parameter)
Set<Parameter>	getRequiredParameters()
List<ParameterValue>	runAlgorithm(long acqTime, long genTime) Runs the associated algorithm with the latest InputParameters
boolean	updateParameters(List<ParameterValue> paramList) Update parameters and return true if the algorithm should run

Method Detail

getAlgorithm

Algorithm getAlgorithm()

getRequiredParameters

Set<Parameter> getRequiredParameters()

getLookbackSize

int getLookbackSize(Parameter parameter)

updateParameters

boolean updateParameters(List<ParameterValue> paramList)

Update parameters and return true if the algorithm should run

Parameters:

paramList - - list of input parameters

Returns:

true if the algorithm should run

runAlgorithm

List<ParameterValue> runAlgorithm(long acqTime,
                                  long genTime)

Runs the associated algorithm with the latest InputParameters

Parameters:

acqTime -

genTime -

Returns:

the outputted parameters, if any

addExecListener

void addExecListener(AlgorithmExecListener listener)

getExecutionContext

AlgorithmExecutionContext getExecutionContext()