Package org.yamcs.algorithms

Class AlgorithmManager

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractProcessorService

org.yamcs.algorithms.AlgorithmManager

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ParameterProcessor, ParameterProvider, ProcessorService

public class AlgorithmManager
extends AbstractProcessorService
implements ParameterProvider, ProcessorService, ParameterProcessor

Manages the provision of requested parameters that require the execution of one or more XTCE algorithms.

Upon initialization it will scan all algorithms, and schedule any that are to be triggered periodically. OutputParameters of all algorithms will be indexed, so that AlgorithmManager knows what parameters it can provide to the ParameterRequestManager.

Algorithms and any needed algorithms that require earlier execution, will be activated as soon as a request for one of its output parameters is registered.

Algorithm executors are created by AlgorithmExecutorFactory which themselves are created by the AlgorithmEngine. The algorithm engines are registered at server startup using the registerAlgorithmEngine(String, AlgorithmEngine) method. javascript will be automatically registered as well as python if available.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields inherited from class org.yamcs.AbstractProcessorService

config, log, processor

Constructor Summary

Constructors

Constructor	Description
AlgorithmManager()

Method Summary

Modifier and Type	Method	Description
ActiveAlgorithm	activateAlgorithm(Algorithm algorithm, AlgorithmExecutionContext execCtx)	Activate an algorithm in a context.
void	addAlgorithmTextListener(AlgorithmTextListener listener)
boolean	canProvide(Yamcs.NamedObjectId itemId)	Returns whether or not a given parameter can be provided by this provider
boolean	canProvide(Parameter p)
void	clearAlgorithmOverride(CustomAlgorithm calg)
AlgorithmExecutionContext	createContext(String name)	Create a new algorithm execution context.
void	disableTracing(Algorithm algo)
protected void	doStart()
protected void	doStop()
void	enableTracing(Algorithm algo)
CustomAlgorithm	getAlgorithmOverride(Algorithm algo)
Collection<CustomAlgorithm>	getAlgorithmOverrides()
AlgorithmStatus	getAlgorithmStatus(Algorithm algo)
Parameter	getParameter(Yamcs.NamedObjectId paraId)	Returns the parameterDefinition corresponding to the parameter id
Processor	getProcessor()
Spec	getSpec()	Returns the valid configuration of the input args of this service.
AlgorithmTrace	getTrace(Algorithm algo)
void	init(Processor processor, YConfiguration config, Object spec)
void	overrideAlgorithm(CustomAlgorithm calg, String text)	Override the algorithm
void	process(ProcessingContext processingCtx)	Called by PRM when new parameters are received.
static void	registerAlgorithmEngine(String name, AlgorithmEngine eng)
void	removeAlgorithmTextListener(AlgorithmTextListener listener)
void	removeContext(AlgorithmExecutionContext ctx)
void	setParameterProcessor(ParameterProcessor parameterRequestManager)	Send parameters to this processor.
void	startProviding(Parameter paramDef)	Adds a new parameter to the list of parameters that have to provided
void	startProvidingAll()	start providing all known parameters
void	stopProviding(Parameter paramDef)	Removes a parameter from the list of parameters that have to be provided

Methods inherited from class org.yamcs.AbstractProcessorService

getConfig, getYamcsInstance

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Constructor Details

AlgorithmManager

public AlgorithmManager()

Method Details

getSpec

public Spec getSpec()

Description copied from interface: ProcessorService

Returns the valid configuration of the input args of this service.

Specified by:

getSpec in interface ProcessorService

Returns:

the argument specification, or null if the args should not be validated.

registerAlgorithmEngine

public static void registerAlgorithmEngine(String name,
 AlgorithmEngine eng)

init

public void init(Processor processor,
 YConfiguration config,
 Object spec)

Specified by:

init in interface ProcessorService

Overrides:

init in class AbstractProcessorService

config - service configuration as specified in processor.yaml

spec - passed by the user when creating the processor (for instance via the REST API)

startProviding

public void startProviding(Parameter paramDef)

Description copied from interface: ParameterProvider

Adds a new parameter to the list of parameters that have to provided

Specified by:

startProviding in interface ParameterProvider

createContext

public AlgorithmExecutionContext createContext(String name)

Create a new algorithm execution context.

Parameters:

name - - name of the context

Returns:

the newly created context

removeContext

public void removeContext(AlgorithmExecutionContext ctx)

activateAlgorithm

public ActiveAlgorithm activateAlgorithm(Algorithm algorithm,
 AlgorithmExecutionContext execCtx)
                                  throws AlgorithmException

Activate an algorithm in a context.

If the algorithm cannot be activated (e.g. error compiling) returns null.

Throws:

AlgorithmException

startProvidingAll

public void startProvidingAll()

Description copied from interface: ParameterProvider

start providing all known parameters

Specified by:

startProvidingAll in interface ParameterProvider

stopProviding

public void stopProviding(Parameter paramDef)

Description copied from interface: ParameterProvider

Removes a parameter from the list of parameters that have to be provided

Specified by:

stopProviding in interface ParameterProvider

canProvide

public boolean canProvide(Parameter p)

Specified by:

canProvide in interface ParameterProvider

canProvide

public boolean canProvide(Yamcs.NamedObjectId itemId)

Description copied from interface: ParameterProvider

Returns whether or not a given parameter can be provided by this provider

Specified by:

canProvide in interface ParameterProvider

Returns:

getParameter

public Parameter getParameter(Yamcs.NamedObjectId paraId)
                       throws InvalidIdentification

Description copied from interface: ParameterProvider

Returns the parameterDefinition corresponding to the parameter id

Specified by:

getParameter in interface ParameterProvider

Parameters:

paraId - - id of the parameter that is returned

Returns:

Throws:

InvalidIdentification

process

public void process(ProcessingContext processingCtx)

Called by PRM when new parameters are received.

Specified by:

process in interface ParameterProcessor

setParameterProcessor

public void setParameterProcessor(ParameterProcessor parameterRequestManager)

Description copied from interface: ParameterProvider

Send parameters to this processor.

Specified by:

setParameterProcessor in interface ParameterProvider

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

getProcessor

public Processor getProcessor()

addAlgorithmTextListener

public void addAlgorithmTextListener(AlgorithmTextListener listener)

removeAlgorithmTextListener

public void removeAlgorithmTextListener(AlgorithmTextListener listener)

clearAlgorithmOverride

public void clearAlgorithmOverride(CustomAlgorithm calg)

overrideAlgorithm

public void overrideAlgorithm(CustomAlgorithm calg,
 String text)

Override the algorithm

Parameters:

calg -

text -

getAlgorithmOverrides

public Collection<CustomAlgorithm> getAlgorithmOverrides()

getAlgorithmOverride

public CustomAlgorithm getAlgorithmOverride(Algorithm algo)

enableTracing

public void enableTracing(Algorithm algo)

disableTracing

public void disableTracing(Algorithm algo)

getTrace

public AlgorithmTrace getTrace(Algorithm algo)

getAlgorithmStatus

public AlgorithmStatus getAlgorithmStatus(Algorithm algo)