Module org.yamcs.core

Package org.yamcs.mdb

Class AbstractDataEncoder

java.lang.Object

org.yamcs.mdb.AbstractDataEncoder

All Implemented Interfaces:

AlgorithmExecutor, DataEncoder

Direct Known Subclasses:

LeadingSizeBinaryEncoder, ReverseBinaryEncoder, TimeBinaryEncoder

public abstract class AbstractDataEncoder
extends Object
implements DataEncoder

stubbed implementation of DataEncoder that "removes" all the AlgorithmExecutor methods - to be used until the data decoders will work as algorithms, or for data decoders that do not need any input parameters

Constructor Summary

Constructors

Constructor	Description
AbstractDataEncoder()

Method Summary

Modifier and Type	Method	Description
AlgorithmExecutionResult	execute(long acqTime, long genTime, ProcessingData data)	Runs the associated algorithm with the latest InputParameters
org.yamcs.xtce.Algorithm	getAlgorithm()
AlgorithmExecutionContext	getExecutionContext()
int	getLookbackSize(org.yamcs.xtce.Parameter parameter)
Set<org.yamcs.xtce.Parameter>	getRequiredParameters()
boolean	update(ProcessingData data)	Update the input data and return true if the algorithm should run

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

dispose, getInputList, getOutputList

Methods inherited from interface org.yamcs.mdb.DataEncoder

encodeRaw

Constructor Details

AbstractDataEncoder

public AbstractDataEncoder()

Method Details

getAlgorithm

public org.yamcs.xtce.Algorithm getAlgorithm()

Specified by:

getAlgorithm in interface AlgorithmExecutor

getRequiredParameters

public Set<org.yamcs.xtce.Parameter> getRequiredParameters()

getLookbackSize

public int getLookbackSize(org.yamcs.xtce.Parameter parameter)

update

public boolean update(ProcessingData data)

Update the input data and return true if the algorithm should run

Specified by:

update in interface AlgorithmExecutor

Returns:

true if the algorithm should run

execute

public AlgorithmExecutionResult execute(long acqTime,
 long genTime,
 ProcessingData data)

Runs the associated algorithm with the latest InputParameters

Specified by:

execute in interface AlgorithmExecutor

Returns:

the output parameters, if any

getExecutionContext

public AlgorithmExecutionContext getExecutionContext()

Specified by:

getExecutionContext in interface AlgorithmExecutor

Returns:

the execution context in which the executor activates