Package org.yamcs.commanding

Class AlgorithmVerifier

java.lang.Object

org.yamcs.commanding.AlgorithmVerifier

All Implemented Interfaces:

AlgorithmExecListener

public class AlgorithmVerifier
extends Object
implements AlgorithmExecListener

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandVerifier	cv
protected final CommandVerificationHandler	cvh
protected final Log	log
protected ParameterValue	returnPv
static final String	YAMCS_PARAMETER_RETURN_VALUE	Imaginary parameter for publishing an optional return value to cmdhist

Method Summary

Modifier and Type	Method	Description
void	algorithmRun(List<RawEngValue> inputValues, Object result, List<ParameterValue> outputValues)	Called when the algorithm has run successfully
String	getStage()
org.yamcs.commanding.Verifier.State	getState()
void	processCmdData(ProcessingContext ctx)

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.AlgorithmExecListener

algorithmError

Field Details

YAMCS_PARAMETER_RETURN_VALUE

public static final String YAMCS_PARAMETER_RETURN_VALUE

Imaginary parameter for publishing an optional return value to cmdhist

See Also:

• Constant Field Values

log

protected final Log log

cv

protected final CommandVerifier cv

cvh

protected final CommandVerificationHandler cvh

returnPv

protected ParameterValue returnPv

Method Details

algorithmRun

public void algorithmRun(List<RawEngValue> inputValues,
 Object result,
 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

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

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

processCmdData

public void processCmdData(ProcessingContext ctx)

getState

public org.yamcs.commanding.Verifier.State getState()

getStage

public String getStage()