org.jmisb.api.klv.st0601

Class WaypointList

java.lang.Object

org.jmisb.api.klv.st0601.WaypointList

All Implemented Interfaces:

IKlvValue, IUasDatalinkValue

public class WaypointList
extends Object
implements IUasDatalinkValue

Waypoint List (ST 0601 Item 141).

From ST:

List of waypoints and their status.

Waypoints are a series of aircraft destinations used to navigate the aircraft to certain locations. Waypoints are typically included in a flight plan and known at the beginning of a mission; however, depending on real-time events and information, the plan may change. Several types of changes are possible throughout the lifecycle of a mission: the waypoint order changes; cancellation of a waypoint; and adding ad hoc waypoints.

The Waypoint List is a list of Waypoint Records encoded as a Variable Length Pack (VLP) to support waypoint management. A Waypoint Record contains: Waypoint ID, Prosecution Order, Info Value, and Location.

See the Waypoint data transfer object documentation for description of the components within a Waypoint.

Constructor Summary

Constructors

Constructor and Description
WaypointList(byte[] bytes) Create from encoded bytes.
WaypointList(List<Waypoint> waypoints) 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<Waypoint>	getWaypoints() Get the waypoints that make up this waypoint list.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaypointList

public WaypointList(List<Waypoint> waypoints)

Create from value.

Parameters:

waypoints - list of Waypoint values

WaypointList

public WaypointList(byte[] bytes)
             throws KlvParseException

Create from encoded bytes.

Parameters:

bytes - Waypoint List, byte array with Variable Length Pack encoding

Throws:

KlvParseException - if there is a problem when parsing the structure

Method Detail

getWaypoints

public List<Waypoint> getWaypoints()

Get the waypoints that make up this waypoint list.

Returns:

the ordered list of waypoints.

getBytes

public byte[] getBytes()

Description copied from interface: IUasDatalinkValue

Get the encoded bytes.

Specified by:

getBytes in interface IUasDatalinkValue

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