Package org.yamcs.mdb

Interface CalibratorProc

All Known Subinterfaces:

AlgorithmCalibratorProc

All Known Implementing Classes:

NumericCalibratorProc, TcoCalibrator

public interface CalibratorProc

Interface for calibrators (raw to engineering conversion) used for telemetry or de-calibrators(engineering to raw conversion) used for commands.

Prior to Yamcs 5.12 only numerical calibrations were possible; starting with Yamcs 5.12 it is possible to convert any type to any type. The numerical calibrators have been moved to NumericCalibratorProc class.

Also starting with Yamcs 5.12, the calibrators get access to the ProcessingContext allowing them to lookup other parameters that may be required to perform the calibration.

The calibrators know the target data type, and the value they generate should conform to the expected type.

Method Summary

Modifier and Type	Method	Description
Value	calibrate(Value rawValue, ProcessingContext pctx)	Convert the raw value to an engineering value
Value	decalibrate(Value engValue, ProcessingContext pctx)	Convert the engineering value to a raw value

Method Details

calibrate

Value calibrate(Value rawValue,
 ProcessingContext pctx)
         throws XtceProcessingException

Convert the raw value to an engineering value

Throws:

XtceProcessingException - if the calibrator cannot calibrate the input value v or if a required input (that should be in the pdata) is not present

decalibrate

Value decalibrate(Value engValue,
 ProcessingContext pctx)
           throws XtceProcessingException

Convert the engineering value to a raw value

Throws:

XtceProcessingException - if the calibrator cannot calibrate the input value v or if a required input (that should be in the pdata) is not present