org.jmisb.api.klv.st0903.vtracker

Class BoundarySeries

java.lang.Object

org.jmisb.api.klv.st0903.vtracker.BoundarySeries

All Implemented Interfaces:

IKlvValue, IVmtiMetadataValue, IVTrackMetadataValue

public class BoundarySeries
extends Object
implements IVmtiMetadataValue, IVTrackMetadataValue

Boundary Series (ST0903 VTracker Local Set Tag 5).

From ST0903:

BoundarySeries is of type BoundarySeries that specifies a bounding area or volume, which encloses the full extent of VMTI detections for the entity. For a simple, planar bounding box, the area will generally lie on the surface of the Earth (although not necessarily, depending upon the Height values provided) defining the “footprint” of the track. By specifying additional vertices, enables describing complex, multifaceted volumes.

Constructor Summary

Constructors

Constructor and Description
BoundarySeries(byte[] bytes) Deprecated. use BoundarySeries(byte[], EncodingMode) to explicitly specify the encoding mode use in the embedded LocationPack floating point values.
BoundarySeries(byte[] bytes, EncodingMode encodingMode) Create from encoded bytes.
BoundarySeries(List<LocationPack> locations) Create from value.

Method Summary

Modifier and Type	Method and Description
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.
List<LocationPack>	getLocations() Get the TargetLocation structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundarySeries

public BoundarySeries(List<LocationPack> locations)

Create from value.

Parameters:

locations - the Location Packs to add.

BoundarySeries

@Deprecated
public BoundarySeries(byte[] bytes)
                           throws KlvParseException

Deprecated. use BoundarySeries(byte[], EncodingMode) to explicitly specify the encoding mode use in the embedded LocationPack floating point values.

Create from encoded bytes.

Parameters:

bytes - Encoded byte array comprising the BoundarySeries

Throws:

KlvParseException - if the byte array could not be parsed.

BoundarySeries

public BoundarySeries(byte[] bytes,
                      EncodingMode encodingMode)
               throws KlvParseException

Create from encoded bytes.

ST0903 changed the encoding for the Location to 2-byte IMAPB (4-byte IMAPB for Latitude / Longitude) in ST0903.4. Earlier versions used a set of unsigned integer encoding that was then mapped into the same ranges that the IMAPB encoding uses. Which formatting applies can only be determined from the ST0903 version in the parent VmtiLocalSet. The compatibilityMode parameter determines whether to parse using the legacy encoding or current encoding.

Note that this only affects parsing. Output encoding is IMAPB (ST0903.4 or later).

Parameters:

bytes - Encoded byte array comprising the BoundarySeries

encodingMode - which encoding mode the bytes parameter uses.

Throws:

KlvParseException - if the byte array could not be parsed.

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: IVmtiMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IVmtiMetadataValue

Specified by:

getBytes in interface IVTrackMetadataValue

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

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

getLocations

public List<LocationPack> getLocations()

Get the TargetLocation structure.

Returns:

the list of Target Locations.