Module org.yamcs.core

Package org.yamcs.algorithms

Class ActiveAlgorithm

java.lang.Object

org.yamcs.algorithms.ActiveAlgorithm

public class ActiveAlgorithm
extends Object

This class stores some info related to one active algorithm

Field Summary

Fields

Modifier and Type	Field	Description
protected final CopyOnWriteArrayList<AlgorithmExecListener>	execListeners	Algorithm execution listeners

Constructor Summary

Constructors

Constructor	Description
ActiveAlgorithm(org.yamcs.xtce.Algorithm algorithm, AlgorithmExecutionContext context, AlgorithmExecutor executor)

Method Summary

Modifier and Type	Method	Description
void	addExecListener(AlgorithmExecListener listener)
org.yamcs.xtce.Algorithm	getAlgorithm()
long	getErrorCount()	Gets the number of errors produced by the algorithm
String	getErrorMessage()	gets the last error message produced by the algorithm or null if it never produced an error message
long	getErrorTime()	gets the system time (wall clock time) when the last error message was produced
AlgorithmExecutionContext	getExecutionContext()
List<org.yamcs.xtce.InputParameter>	getInputList()
String	getName()
List<org.yamcs.xtce.OutputParameter>	getOutputList()
org.yamcs.xtce.Algorithm.Scope	getScope()
org.yamcs.protobuf.AlgorithmStatus.Builder	getStatus()
org.yamcs.xtce.TriggerSetType	getTriggerSet()
protected void	propagateErrorToListeners(List<RawEngValue> inputValues, String errorMsg)
void	removeExecListener(AlgorithmExecListener listener)
List<ParameterValue>	runAlgorithm(long acqTime, long genTime, ProcessingData data)
String	toString()
boolean	update(ProcessingData data)

Methods inherited from class java.lang.Object

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

Field Details

execListeners

protected final CopyOnWriteArrayList<AlgorithmExecListener> execListeners

Algorithm execution listeners

Constructor Details

ActiveAlgorithm

public ActiveAlgorithm(org.yamcs.xtce.Algorithm algorithm,
 AlgorithmExecutionContext context,
 AlgorithmExecutor executor)

Method Details

getAlgorithm

public org.yamcs.xtce.Algorithm getAlgorithm()

getExecutionContext

public AlgorithmExecutionContext getExecutionContext()

update

public boolean update(ProcessingData data)

runAlgorithm

public List<ParameterValue> runAlgorithm(long acqTime,
 long genTime,
 ProcessingData data)

propagateErrorToListeners

protected void propagateErrorToListeners(List<RawEngValue> inputValues,
 String errorMsg)

addExecListener

public void addExecListener(AlgorithmExecListener listener)

removeExecListener

public void removeExecListener(AlgorithmExecListener listener)

getErrorMessage

public String getErrorMessage()

gets the last error message produced by the algorithm or null if it never produced an error message

getErrorTime

public long getErrorTime()

gets the system time (wall clock time) when the last error message was produced

getErrorCount

public long getErrorCount()

Gets the number of errors produced by the algorithm

getScope

public org.yamcs.xtce.Algorithm.Scope getScope()

getStatus

public org.yamcs.protobuf.AlgorithmStatus.Builder getStatus()

getInputList

public List<org.yamcs.xtce.InputParameter> getInputList()

getOutputList

public List<org.yamcs.xtce.OutputParameter> getOutputList()

getTriggerSet

public org.yamcs.xtce.TriggerSetType getTriggerSet()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object