Package org.yamcs.algorithms
Interface AlgorithmExecutor
-
- All Known Subinterfaces:
DataDecoder,DataEncoder
- All Known Implementing Classes:
AbstractAlgorithmExecutor,AbstractDataDecoder,AbstractDataEncoder,LeadingSizeBinaryDecoder,LeadingSizeBinaryEncoder,MathAlgorithmExecutor,ScriptAlgorithmExecutor
public interface AlgorithmExecutorRepresents the execution context of one algorithm. An AlgorithmExecutor is reused upon each update of one or more of its InputParameters.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddExecListener(AlgorithmExecListener listener)AlgorithmgetAlgorithm()AlgorithmExecutionContextgetExecutionContext()intgetLookbackSize(Parameter parameter)List<ParameterValue>runAlgorithm(long acqTime, long genTime)Runs the associated algorithm with the latest InputParametersbooleanupdateParameters(List<ParameterValue> paramList)Update parameters and return true if the algorithm should run
-
-
-
Method Detail
-
getAlgorithm
Algorithm getAlgorithm()
-
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()
-
-