Package org.codice.ddf.libs.klv.data.numerical

Class KlvIntegerEncodedFloatingPoint

java.lang.Object

org.codice.ddf.libs.klv.KlvDataElement<T>

org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement<Double>

org.codice.ddf.libs.klv.data.numerical.KlvIntegerEncodedFloatingPoint

public class KlvIntegerEncodedFloatingPoint
extends KlvNumericalDataElement<Double>

Represents a KLV element containing a floating-point value that has been encoded as an integer value.

Field Summary

Fields inherited from class org.codice.ddf.libs.klv.data.numerical.KlvNumericalDataElement

errorIndicatorValue

Fields inherited from class org.codice.ddf.libs.klv.KlvDataElement

key, keyBytes, name, value

Constructor Summary

Constructors

Constructor	Description
KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?> klvRawDataValue, long encodedRangeMin, long encodedRangeMax, double actualRangeMin, double actualRangeMax)	Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.
KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?> klvRawDataValue, long encodedRangeMin, long encodedRangeMax, double actualRangeMin, double actualRangeMax, Optional<Double> errorIndicatorValue)	Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.

Method Summary

Modifier and Type	Method	Description
protected KlvIntegerEncodedFloatingPoint	copy()
protected void	decodeValue(Klv klv)
boolean	isErrorIndicated()	If there is a floating point error indicator, then use it.

Methods inherited from class org.codice.ddf.libs.klv.KlvDataElement

getKey, getKeyAsString, getName, getValue

Methods inherited from class java.lang.Object

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

Constructor Details

KlvIntegerEncodedFloatingPoint

public KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?> klvRawDataValue,
 long encodedRangeMin,
 long encodedRangeMax,
 double actualRangeMin,
 double actualRangeMax)

Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.

The value returned by this KlvIntegerEncodedFloatingPoint is calculated as follows:

The value returned by klvRawDataValue is converted to a long

Scale the value by calculating: (value - encodedRangeMin) / ( encodedRangeMax - encodedRangeMin)

Apply the scaled value to the actual range: scaled value * (actualRangeMax - actualRangeMin) + actualRangeMin

Parameters:

klvRawDataValue - the KlvNumericalDataElement that retrieves the raw numerical value

encodedRangeMin - the minimum integer-encoded value

encodedRangeMax - the maximum integer-encoded value

actualRangeMin - the minimum decoded floating-point value

actualRangeMax - the maximum decoded floating-point value

KlvIntegerEncodedFloatingPoint

public KlvIntegerEncodedFloatingPoint(KlvNumericalDataElement<?> klvRawDataValue,
 long encodedRangeMin,
 long encodedRangeMax,
 double actualRangeMin,
 double actualRangeMax,
 Optional<Double> errorIndicatorValue)

Constructs a KlvIntegerEncodedFloatingPoint representing a KLV element containing a floating-point value that has been encoded as an integer value.

The value returned by this KlvIntegerEncodedFloatingPoint is calculated as follows:

The value returned by klvRawDataValue is converted to a long

Scale the value by calculating: (value - encodedRangeMin) / ( encodedRangeMax - encodedRangeMin)

Apply the scaled value to the actual range: scaled value * (actualRangeMax - actualRangeMin) + actualRangeMin

Parameters:

klvRawDataValue - the KlvNumericalDataElement that retrieves the raw numerical value

encodedRangeMin - the minimum integer-encoded value

encodedRangeMax - the maximum integer-encoded value

actualRangeMin - the minimum decoded floating-point value

actualRangeMax - the maximum decoded floating-point value

errorIndicatorValue - value that indicates an encoded error

Method Details

decodeValue

protected void decodeValue(Klv klv)

Specified by:

decodeValue in class KlvNumericalDataElement<Double>

copy

protected KlvIntegerEncodedFloatingPoint copy()

Specified by:

copy in class KlvNumericalDataElement<Double>

isErrorIndicated

public boolean isErrorIndicated()

If there is a floating point error indicator, then use it. Otherwise, check the raw data for an error indicator.

Overrides:

isErrorIndicated in class KlvNumericalDataElement<Double>

Returns:

true if an error indicator is encoded