Package org.yamcs.xtceproc

Class ProcessorData

java.lang.Object

org.yamcs.xtceproc.ProcessorData

public class ProcessorData
extends Object

Holds information related and required for XTCE processing. It is separated from Processor because it has to be usable when not a full blown processor is available (e.g. XTCE packet processing) Contains a cache of the last known value for each parameter

Constructor Summary

Constructors

Constructor	Description
ProcessorData(String instance, String procName, XtceDb xtcedb, ProcessorConfig config)
ProcessorData(Processor proc, ProcessorConfig config)

Method Summary

Modifier and Type	Method	Description
void	clearParameterAlarmOverrides(Parameter p)
void	clearParameterCalibratorOverrides(Parameter p)
void	clearParameterOverrides(Parameter p)
CalibratorProc	getCalibrator(CriteriaEvaluator contextEvaluator, DataEncoding de)	returns a calibrator processor for the given data encoding.
DataDecoder	getDataDecoder(DataEncoding de)
DataEncoder	getDataEncoder(DataEncoding de)
CalibratorProc	getDecalibrator(DataEncoding de)
EventProducer	getEventProducer()
LastValueCache	getLastValueCache()
ParameterType	getParameterType(Parameter parameter)
ParameterTypeProcessor	getParameterTypeProcessor()	Returns the parameter type processor (this is the guy that converts from raw to engineering value) used by the associated processor.
ProcessorConfig	getProcessorConfig()
String	getProcessorName()
<T> T	getUserData(String key)	Get the instance of the user defined object if any.
XtceDb	getXtceDb()
String	getYamcsInstance()
void	removeDefaultAlarm(Parameter p)
void	removeDefaultCalibrator(Parameter p)
void	setContextCalibratorList(Parameter p, List<ContextCalibrator> contextCalibrator)
void	setDefaultCalibrator(Parameter p, Calibrator defaultCalibrator)
void	setDefaultEnumerationAlarm(Parameter p, EnumerationAlarm alarm)
void	setDefaultNumericAlarm(Parameter p, NumericAlarm alarm)
void	setEnumerationContextAlarm(Parameter p, List<EnumerationContextAlarm> contextAlarmList)
void	setNumericContextAlarm(Parameter p, List<NumericContextAlarm> contextAlarmList)
<T> void	setUserData(String key, T value)	Set some object to be shared with all the users of this processor data

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorData

public ProcessorData(Processor proc,
                     ProcessorConfig config)

ProcessorData

public ProcessorData(String instance,
                     String procName,
                     XtceDb xtcedb,
                     ProcessorConfig config)

Parameters:

xtcedb -

config - - generate events in case of errors when processing data

Method Detail

setUserData

public <T> void setUserData(String key,
                            T value)

Set some object to be shared with all the users of this processor data

Parameters:

key -

value -

getUserData

public <T> T getUserData(String key)

Get the instance of the user defined object if any. Returns null if no data has been set.

Parameters:

key -

Returns:

getCalibrator

public CalibratorProc getCalibrator(CriteriaEvaluator contextEvaluator,
                                    DataEncoding de)

returns a calibrator processor for the given data encoding. Can be null if the DataEncoding does not define a calibrator.

Returns:

a calibrator processor or null

getDecalibrator

public CalibratorProc getDecalibrator(DataEncoding de)

getDataDecoder

public DataDecoder getDataDecoder(DataEncoding de)

getDataEncoder

public DataEncoder getDataEncoder(DataEncoding de)

getXtceDb

public XtceDb getXtceDb()

getParameterTypeProcessor

public ParameterTypeProcessor getParameterTypeProcessor()

Returns the parameter type processor (this is the guy that converts from raw to engineering value) used by the associated processor.

Returns:

getEventProducer

public EventProducer getEventProducer()

getLastValueCache

public LastValueCache getLastValueCache()

getParameterType

public ParameterType getParameterType(Parameter parameter)

clearParameterOverrides

public void clearParameterOverrides(Parameter p)

clearParameterCalibratorOverrides

public void clearParameterCalibratorOverrides(Parameter p)

setDefaultCalibrator

public void setDefaultCalibrator(Parameter p,
                                 Calibrator defaultCalibrator)

setContextCalibratorList

public void setContextCalibratorList(Parameter p,
                                     List<ContextCalibrator> contextCalibrator)

clearParameterAlarmOverrides

public void clearParameterAlarmOverrides(Parameter p)

removeDefaultCalibrator

public void removeDefaultCalibrator(Parameter p)

removeDefaultAlarm

public void removeDefaultAlarm(Parameter p)

setDefaultNumericAlarm

public void setDefaultNumericAlarm(Parameter p,
                                   NumericAlarm alarm)

setNumericContextAlarm

public void setNumericContextAlarm(Parameter p,
                                   List<NumericContextAlarm> contextAlarmList)

setDefaultEnumerationAlarm

public void setDefaultEnumerationAlarm(Parameter p,
                                       EnumerationAlarm alarm)

setEnumerationContextAlarm

public void setEnumerationContextAlarm(Parameter p,
                                       List<EnumerationContextAlarm> contextAlarmList)

getYamcsInstance

public String getYamcsInstance()

getProcessorConfig

public ProcessorConfig getProcessorConfig()

getProcessorName

public String getProcessorName()