Module org.yamcs.core

Package org.yamcs.algorithms

Class AlgorithmTrace

java.lang.Object

org.yamcs.algorithms.AlgorithmTrace

All Implemented Interfaces:

AlgorithmExecListener

public class AlgorithmTrace
extends Object
implements AlgorithmExecListener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LOGS
static final int	MAX_RUNS

Constructor Summary

Constructors

Constructor	Description
AlgorithmTrace()

Method Summary

Modifier and Type	Method	Description
void	addLog(String msg)
void	algorithmError(List<RawEngValue> inputValues, String errorMsg)	Called when the algorithm produced an error
void	algorithmRun(List<RawEngValue> inputValues, Object returnValue, List<ParameterValue> outputValues)	Called when the algorithm has run successfully
org.yamcs.protobuf.AlgorithmTrace	toProto()

Methods inherited from class java.lang.Object

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

Field Details

MAX_RUNS

public static final int MAX_RUNS

See Also:

• Constant Field Values

MAX_LOGS

public static final int MAX_LOGS

See Also:

• Constant Field Values

Constructor Details

AlgorithmTrace

public AlgorithmTrace()

Method Details

addLog

public void addLog(String msg)

algorithmRun

public void algorithmRun(List<RawEngValue> inputValues,
 Object returnValue,
 List<ParameterValue> outputValues)

Description copied from interface: AlgorithmExecListener

Called when the algorithm has run successfully

Specified by:

algorithmRun in interface AlgorithmExecListener

Parameters:

inputValues - - may be null if the algorithm does not have any input values or does not keep track of them

returnValue - - may be null if the algorithm does not return anything

outputValues - - may be empty if there is no output value

algorithmError

public void algorithmError(List<RawEngValue> inputValues,
 String errorMsg)

Description copied from interface: AlgorithmExecListener

Called when the algorithm produced an error

Specified by:

algorithmError in interface AlgorithmExecListener

toProto

public org.yamcs.protobuf.AlgorithmTrace toProto()