org.xtce.math

Interface Calibration

All Known Implementing Classes:

MathOperationCalibration, PolynomialCalibration, SplineCalibration

public interface Calibration

The Calibration interface provides the XTCE calibration types with a common Java interface for encoding and decoding support.

Author:

David Overeem

Method Summary

Modifier and Type	Method and Description
Number	calibrate(Number xValue) Method to convert an uncalibrated value to a calibrated value by applying the Calibrator in the XTCE document.
Number	uncalibrate(Number yValue) Method to convert a calibrated value to an uncalibrated value by reversing the Calibrator in the XTCE document.

Method Detail

calibrate

Number calibrate(Number xValue)
          throws XTCEDatabaseException

Method to convert an uncalibrated value to a calibrated value by applying the Calibrator in the XTCE document.

Parameters:

xValue - Number containing the uncalibrated value.

Returns:

Number containing the calibrated value.

Throws:

XTCEDatabaseException - thrown in the event that the operation cannot be completed. The message will contain the reason, which is already internationalized.

uncalibrate

Number uncalibrate(Number yValue)
            throws XTCEDatabaseException

Method to convert a calibrated value to an uncalibrated value by reversing the Calibrator in the XTCE document.

Parameters:

yValue - Number containing the calibrated value.

Returns:

Number containing the uncalibrated value, which can be a value selected as "best" representing the uncalibration when there are multiple possible uncalibrated values.

Throws:

XTCEDatabaseException - thrown in the event that the operation cannot be completed. The message will contain the reason, which is already internationalized.