org.jmisb.api.klv.st0903

Class VTargetSeries

java.lang.Object

org.jmisb.api.klv.st0903.VTargetSeries

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IVmtiMetadataValue

public class VTargetSeries
extends Object
implements IVmtiMetadataValue, INestedKlvValue

VMTI LS VTarget Series (ST 0903 VMTI LS Tag 101).

From ST0903:

VTargetSeries is a Series type which contains VTarget Packs only. The Length field for the series is the sum of all the data in the VTargetSeries Value field. The Value field is comprised of one or more VTarget Packs, each of which can be of a different size (thereby including different information) parsed according to the Length provided for each VTarget Pack.

Constructor Summary

Constructors

Constructor and Description
VTargetSeries(byte[] bytes) Deprecated. use VTargetSeries(byte[], EncodingMode) instead
VTargetSeries(byte[] bytes, EncodingMode encodingMode) Create from encoded bytes.
VTargetSeries(List<VTargetPack> values) Create the message from a list of VTargetPacks.

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.
IKlvValue	getField(IKlvKey tag) Get the value of a given item.
Set<? extends IKlvKey>	getIdentifiers() Get the set of identifiers for populated values.
List<VTargetPack>	getVTargets() Get the VTargets in the series.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTargetSeries

public VTargetSeries(List<VTargetPack> values)

Create the message from a list of VTargetPacks.

Parameters:

values - the target packs to include in the series.

VTargetSeries

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

Deprecated. use VTargetSeries(byte[], EncodingMode) instead

Create from encoded bytes.

This constructor only supports ST0903.4 and later.

Parameters:

bytes - Encoded byte array

Throws:

KlvParseException - if there is a parsing error on the byte array.

VTargetSeries

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

Create from encoded bytes.

This constructor allows selection of which encoding rules (according to the ST0903 version) to apply.

Parameters:

bytes - Encoded byte array

encodingMode - which encoding mode the bytes parameter uses.

Throws:

KlvParseException - if there is a parsing error on the byte array.

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: IVmtiMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IVmtiMetadataValue

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

getVTargets

public List<VTargetPack> getVTargets()

Get the VTargets in the series.

Returns:

the VTargets as a List

getField

public IKlvValue getField(IKlvKey tag)

Description copied from interface: INestedKlvValue

Get the value of a given item.

Specified by:

getField in interface INestedKlvValue

Parameters:

tag - Tag or other identifier of the value to retrieve

Returns:

The value, or null if no value was set

getIdentifiers

public Set<? extends IKlvKey> getIdentifiers()

Description copied from interface: INestedKlvValue

Get the set of identifiers for populated values.

Specified by:

getIdentifiers in interface INestedKlvValue

Returns:

The set of item identifiers for which values have been set