Module org.yamcs.core

Package org.yamcs.algorithms

Class AlgorithmExecutionContext

java.lang.Object

org.yamcs.algorithms.AlgorithmExecutionContext

public class AlgorithmExecutionContext
extends Object

A context is a collection of active algorithms. Each algorithm has only one instance active in a given context.

There is normally a global context in a processor and a few contexts related to the command verifiers.

The process(long, ProcessingData) method will trigger calling all the active algorithms from this context in order.

Constructor Summary

Constructors

Constructor	Description
AlgorithmExecutionContext(String contextName, ProcessorData procData, int maxErrCount)

Method Summary

Modifier and Type	Method	Description
void	addAlgorithm(ActiveAlgorithm activeAlgorithm)
boolean	containsAlgorithm(String algoFqn)
void	disableTracing(org.yamcs.xtce.Algorithm algo)
void	enableTracing(org.yamcs.xtce.Algorithm algo)
List<ActiveAlgorithm>	getActiveAlgorithms()
ActiveAlgorithm	getAlgorithm(String algoFqn)
org.yamcs.protobuf.AlgorithmStatus	getAlgorithmStatus(String algoFqn)
EventProducer	getEventProducer()
Mdb	getMdb()
String	getName()
ProcessorData	getProcessorData()
AlgorithmTrace	getTrace(String algoFqn)
void	logTrace(String algoFqn, String msg)
void	process(long acqTime, ProcessingData data)	Update the input data and run the affected algorithms
ActiveAlgorithm	removeAlgorithm(String algoFqn)	remove the active algorithm with the given identifier.
ActiveAlgorithm	removeAlgorithm(org.yamcs.xtce.Algorithm algorithm)

Methods inherited from class java.lang.Object

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

Constructor Details

AlgorithmExecutionContext

public AlgorithmExecutionContext(String contextName,
 ProcessorData procData,
 int maxErrCount)

Method Details

process

public void process(long acqTime,
 ProcessingData data)

Update the input data and run the affected algorithms

Add the result of the algorithms to the processing data

getName

public String getName()

containsAlgorithm

public boolean containsAlgorithm(String algoFqn)

addAlgorithm

public void addAlgorithm(ActiveAlgorithm activeAlgorithm)

removeAlgorithm

public ActiveAlgorithm removeAlgorithm(String algoFqn)

remove the active algorithm with the given identifier.

The algorithm will not be called in subsequent calls to process(long, ProcessingData)

Parameters:

algoFqn -

Returns:

the active algorithm removed or null if there was no active algorithm

removeAlgorithm

public ActiveAlgorithm removeAlgorithm(org.yamcs.xtce.Algorithm algorithm)

getActiveAlgorithms

public List<ActiveAlgorithm> getActiveAlgorithms()

getProcessorData

public ProcessorData getProcessorData()

getMdb

public Mdb getMdb()

getEventProducer

public EventProducer getEventProducer()

enableTracing

public void enableTracing(org.yamcs.xtce.Algorithm algo)

disableTracing

public void disableTracing(org.yamcs.xtce.Algorithm algo)

getTrace

public AlgorithmTrace getTrace(String algoFqn)

logTrace

public void logTrace(String algoFqn,
 String msg)

getAlgorithm

public ActiveAlgorithm getAlgorithm(String algoFqn)

getAlgorithmStatus

public org.yamcs.protobuf.AlgorithmStatus getAlgorithmStatus(String algoFqn)