Package org.yamcs.algorithms

Class AlgorithmExecutionResult

java.lang.Object

org.yamcs.algorithms.AlgorithmExecutionResult

public class AlgorithmExecutionResult
extends Object

Describes the result of the algorithm execution, which consists of the following components:

• Input Parameter Values (Optional) - A list of parameters that were used as input to the algorithm.
• Output Parameter Values - A list of ParameterValue objects that are propagated to Yamcs clients.
• Return Value - This is not an output parameter but is specifically used for command verifiers (see the details below).

Command Verifier Return Value

In older versions of Yamcs, the command verifier would return either a boolean value (True) indicating success or a String indicating failure. While this approach is still supported, the current preferred method is to use the custom VerificationResult class, which provides a more suitable representation of the verifier's result.

Constructor Summary

Constructors

Constructor	Description
AlgorithmExecutionResult(Object returnValue, List<ParameterValue> outputValues)
AlgorithmExecutionResult(List<ParameterValue> outputValues)
AlgorithmExecutionResult(List<RawEngValue> inputValues, Object returnValue, List<ParameterValue> outputValues)
AlgorithmExecutionResult(ParameterValue outputValue)	Constructor for an algorithm result which returns exactly one value

Method Summary

Modifier and Type	Method	Description
List<RawEngValue>	getInputValues()
List<ParameterValue>	getOutputValues()
Object	getReturnValue()

Methods inherited from class java.lang.Object

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

Constructor Details

AlgorithmExecutionResult

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

AlgorithmExecutionResult

public AlgorithmExecutionResult(Object returnValue,
 List<ParameterValue> outputValues)

AlgorithmExecutionResult

public AlgorithmExecutionResult(List<ParameterValue> outputValues)

AlgorithmExecutionResult

public AlgorithmExecutionResult(ParameterValue outputValue)

Constructor for an algorithm result which returns exactly one value

Parameters:

outputValue -

Method Details

getInputValues

public List<RawEngValue> getInputValues()

getOutputValues

public List<ParameterValue> getOutputValues()

getReturnValue

public Object getReturnValue()