org.jmisb.api.klv.st1303

Class NaturalFormatEncoder

java.lang.Object

org.jmisb.api.klv.st1303.NaturalFormatEncoder

public class NaturalFormatEncoder
extends Object

Multi-Dimensional Array Pack (MDAP) Natural Format Encoder.

This encodes the provided array as a sequence of primitive values.

Constructor Summary

Constructors

Constructor and Description
NaturalFormatEncoder() Constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	encode(boolean[][] data) Encode a two dimensional Boolean array to a Multi-Dimensional Array Pack using Natural Format Encoding.
byte[]	encode(double[] data) Encode a two dimensional real array to a Multi-Dimensional Array Pack using Natural Format Encoding.
byte[]	encode(long[] data) Encode a one dimensional (signed) integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.
byte[]	encode(long[][] data) Encode a two dimensional (signed) integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.
byte[]	encodeUnsigned(long[] data) Encode a one dimensional unsigned integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.
byte[]	encodeUnsigned(long[][] data) Encode a two dimensional unsigned integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

NaturalFormatEncoder

public NaturalFormatEncoder()

Constructor.

MDAP Natural Format encoding does not require parameters.

Method Detail

encode

public byte[] encode(double[] data)
              throws KlvParseException

Encode a two dimensional real array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Parameters:

data - the array of arrays of (double) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.

encode

public byte[] encode(long[] data)
              throws KlvParseException

Encode a one dimensional (signed) integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Parameters:

data - the array of (long) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.

encode

public byte[] encode(long[][] data)
              throws KlvParseException

Encode a two dimensional (signed) integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Parameters:

data - the array of arrays of (long) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.

encodeUnsigned

public byte[] encodeUnsigned(long[] data)
                      throws KlvParseException

Encode a one dimensional unsigned integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Parameters:

data - the arrays of (long) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.

encodeUnsigned

public byte[] encodeUnsigned(long[][] data)
                      throws KlvParseException

Encode a two dimensional unsigned integer array to a Multi-Dimensional Array Pack using Natural Format Encoding.

Parameters:

data - the array of arrays of (long) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.

encode

public byte[] encode(boolean[][] data)
              throws KlvParseException

Encode a two dimensional Boolean array to a Multi-Dimensional Array Pack using Natural Format Encoding.

This serialises each value into a byte array.

Parameters:

data - the array of arrays of (boolean) values.

Returns:

the encoded byte array including the MISB ST1303 header and array data.

Throws:

KlvParseException - if the encoding fails, such as for invalid array dimensions.