org.jmisb.api.klv.st1907

Class Correspondence_Row

java.lang.Object

org.jmisb.api.klv.st1907.Correspondence_Row

All Implemented Interfaces:

IKlvValue, IMimdMetadataValue

public class Correspondence_Row
extends Object
implements IMimdMetadataValue

MIMD Correspondence row attribute.

This is a specialisation of a floating point (double).

See ST1907 for more information on this data type.

Constructor Summary

Constructors

Constructor and Description
Correspondence_Row(byte[] bytes) Create Correspondence_Row from encoded bytes.
Correspondence_Row(byte[] bytes, int offset, int length) Create Correspondence_Row from encoded bytes.
Correspondence_Row(double value) Construct from value.

Method Summary

Modifier and Type	Method and Description
static Correspondence_Row	fromBytes(byte[] bytes) Create Correspondence_Row from encoded bytes.
byte[]	getBytes() Get the encoded bytes.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
double	getValue() Get the value of this Correspondence_Row.

Methods inherited from class java.lang.Object

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

Constructor Detail

Correspondence_Row

public Correspondence_Row(double value)
                   throws KlvParseException

Construct from value.

The minimum value is 0.

The value is in units of Rows.

Parameters:

value - a floating point (double) value to initialise this Correspondence_Row with.

Throws:

KlvParseException - if the value is not valid (e.g. outside of the valid range).

Correspondence_Row

public Correspondence_Row(byte[] bytes)
                   throws KlvParseException

Create Correspondence_Row from encoded bytes.

Parameters:

bytes - Encoded byte array.

Throws:

KlvParseException - if the byte array could not be parsed.

Correspondence_Row

public Correspondence_Row(byte[] bytes,
                          int offset,
                          int length)
                   throws KlvParseException

Create Correspondence_Row from encoded bytes.

This version allows parsing of a specific number of bytes from a given offset.

Parameters:

bytes - Encoded byte array.

offset - the offset into the byte array to start decoding.

length - the number of bytes to decode.

Throws:

KlvParseException - if the byte array could not be parsed.

Method Detail

fromBytes

public static Correspondence_Row fromBytes(byte[] bytes)
                                    throws KlvParseException

Create Correspondence_Row from encoded bytes.

Parameters:

bytes - Encoded byte array.

Returns:

new Correspondence_Row corresponding to the encoded byte array.

Throws:

KlvParseException - if the byte array could not be parsed.

getDisplayName

public String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Specified by:

getDisplayName in interface IKlvValue

Returns:

The name of the type

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

getDisplayableValue

public String getDisplayableValue()

Description copied from interface: IKlvValue

Return a string of the displayable value.

Specified by:

getDisplayableValue in interface IKlvValue

Returns:

String representing the value

getValue

public double getValue()

Get the value of this Correspondence_Row.

Returns:

The value as a floating point (double), in units of Rows.