AvclMission (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.AvclMission

```
public class AvclMission
extends Object
```
Description : Data structure that will contain a single AVCL mission object (JAXB) and manipulate individual elements as directed by the mission editor All direct manipulation of the JAXB-developed classes should be handled by this or other classes in this package. This class is not intended to perform any mission editor or GUI functions in order to facilitate the changes required if the AVCL schema changes To the maximum extent possible, this class should maintain its current interface upon AVCL changes to minimize impact outside this class

Since:

06 May 2004 Program : AUV Workbench Platform : Windows 2000/Windows XP

Version:

$Id: AvclMission.java 9114 2015-08-01 02:42:25Z brutzman $

Author:

dtdavis

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABOVEGROUNDLEVELCONTROL` Above Ground Level (AGL) enumeration for aircraft altitude control type.
`static int`	`ABSOLUTE_TIMING` Enumeration for absolute timing, meaning that time values are actual clock values.
`static int`	`AGENDA` Enumeration for mission type: non-vehicle-specific agenda planning mission
`static int`	`AGENDA_AVOIDAREAELEMENT` Enumeration value for allowed commandType
`static int`	`AGENDA_GOAL` Enumeration value for allowed commandType
`static int`	`AGENDA_LAUNCH_POSITION` Enumeration value for allowed commandType
`static int`	`AGENDA_RECOVERY_POSITION` Enumeration value for allowed commandType
`static int`	`AGENDA_ROUTEELEMENT` Enumeration value for allowed commandType
`protected AgendaConstraintListType`	`agendaConstraintList` Handle to the list containing strategic-level agenda constraints
`protected AgendaGoalListType`	`agendaGoalList` Handle to the list containing strategic-level agenda goals
`protected AgendaMissionElementType`	`agendaMission` Handle to the strategic-level agenda mission element
`static int`	`AGL` Enumeration for commanded altitude type, Above Ground Level
`static int`	`ALLPLANES` Enumeration value for commanded plane surfaces
`static int`	`ALLPROPELLERS` Enumeration value for commanded propellers
`static int`	`ALLTRACKS` Enumeration value for ugv track type
`static int`	`ALTITUDE_ABV_BTM` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_ABV_BTM_BLK` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_AGL` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_AGL_BLK` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_AGL_MSL_BLK` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_MSL` Enumeration for block depth/altitude type
`static int`	`ALTITUDE_MSL_BLK` Enumeration for block depth/altitude type
`static int`	`ALTITUDECONTROL` Enumeration value for z-axis vertical control mode
`static int`	`ATTACK` Mission goal type
`static String[]`	`AVCL_COMMAND_NAMES` Enumeration values for allowed AVCL command names
`static int`	`BIOLOGICAL` Enumeration for contaminant type
`protected AvclBodyType`	`body` Handle to the AVCL body element
`static int`	`BOWLATERALTHRUSTER` Enumeration value for commanded body thrusters
`static int`	`BOWPLANES` Enumeration value for commanded plane surfaces
`static int`	`BOWVERTICALTHRUSTER` Enumeration value for commanded body thrusters
`static int`	`CENTERPROPELLER` Enumeration value for commanded propellers
`static int`	`CHEMICAL` Enumeration for contaminant type
`static int`	`CIRCLE` Enumeration for specifying a type of location geometry
`protected List<JAXBElement<?>>`	`commandElementList` Handle to the mission script command list
`static int`	`COMPOSITEWAYPOINT_COMMAND_UAV` Enumeration value for allowed commandType
`static int`	`COMPOSITEWAYPOINT_COMMAND_UGV` Enumeration value for allowed commandType
`static int`	`COMPOSITEWAYPOINT_COMMAND_USV` Enumeration value for allowed commandType
`static int`	`COMPOSITEWAYPOINT_COMMAND_UUV` Enumeration value for allowed commandType
`static Color`	`CURRENT_GOAL` Enumeration color for rendering mission status: current goal
`static int`	`DECONTAMINATE` Mission goal type
`static int`	`DEFAULTZCONTROL` Enumeration value for z-axis vertical control mode
`static int`	`DEMOLISH` Mission goal type
`static int`	`DEPTH` Enumeration for block depth/altitude type
`static int`	`DEPTH_ALTITUDE_ABV_BTM_BLK` Enumeration for block depth/altitude type
`static int`	`DEPTH_BLK` Enumeration for block depth/altitude type
`static int`	`DEPTHCONTROL` Enumeration value for z-axis vertical control mode
`static String`	`DIRECTTO` Enumeration for allowable homing/tracking mode used during waypoint navigation
`static int`	`DURATION_TIMING` Enumeration for relative timing, meaning that time values are duration intervals.
`static int`	`EDGESCAN` Enumeration value for target sonar scan mode
`static int`	`EGRESS_ROUTE` Enumeration for direction of routing (ingress or egress)
`protected EventLogElementType`	`eventLog` Handle to the Event Log element
`protected List<Object>`	`eventLogItems` Handle to the list of logged events
`static int`	`EXPANDINGSQUARE` Enumeration value for type of composite waypoint command
`static int`	`EXPLOSIVE` Enumeration for contaminant type
`static int`	`FOLLOWBEACON_COMMAND` Enumeration value for allowed commandType
`static int`	`FORWARDSCAN` Enumeration value for sonar scan mode
`protected GeoOriginElementType`	`geoOrigin` Handle to the GeoOrigin element
`static int`	`GIGAHERTZ` Enumeration for allowable frequency units
`static String[]`	`GOAL_NAMES`
`static Color`	`GOAL_ON_FAILURE` Enumeration color for rendering mission status: next goal on failure
`static Color`	`GOAL_ON_SUCCESS` Enumeration color for rendering mission status: next goal on success
`static int`	`GPSCOMPLETE` Enumeration value for GPS fix status
`static int`	`GPSFAIL` Enumeration value for GPS fix status
`static int`	`GPSFIX_COMMAND` Enumeration value for allowed commandType
`static int`	`GPSINPROGRESS` Enumeration value for GPS fix status
`static int`	`GPSSTART` Enumeration value for GPS fix status
`protected AvclHeadType`	`head` Handle to AVCL head element
`static int`	`HELP_COMMAND` Enumeration value for allowed commandType
`static int`	`HERTZ` Enumeration for allowable frequency units
`static int`	`HOVER_COMMAND` Enumeration value for allowed commandType
`static int`	`ILLUMINATE` Mission goal type
`static int`	`INGRESS_ROUTE` Enumeration for direction of routing (ingress or egress)
`static Color`	`INITIAL_GOAL` Enumeration color for rendering mission status: initial goal
`static int`	`JAM` Mission goal type
`static int`	`KILOHERTZ` Enumeration for allowable frequency units
`static int`	`KNOTS` Enumeration for type of speed units
`static int`	`LATERALTHRUSTERS` Enumeration value for commanded body thrusters
`static int`	`LATLONGPOSITION` Enumeration value for horizontal positioning representation
`static int`	`LEFT` Enumeration for commanded turn direction
`static int`	`LEFTTRACK` Enumeration value for ugv track type
`static int`	`LIMITING_LINE` Enumeration for specifying a type of location geometry
`static int`	`LOITER_COMMAND_UAV` Enumeration value for allowed commandType
`static int`	`LOITER_COMMAND_UGV` Enumeration value for allowed commandType
`static int`	`LOITER_COMMAND_USV` Enumeration value for allowed commandType
`static int`	`LOITER_COMMAND_UUV` Enumeration value for allowed commandType
`static int`	`MAGNETICBEARING` Enumeration value for bearing type
`static int`	`MAKEALTITUDE_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKEALTITUDEAGL_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKEALTITUDEMSL_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKECLIMBRATE_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKEDEPTH_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKEHEADING_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKEKNOTS_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKESPEED_COMMAND` Enumeration value for allowed commandType
`static int`	`MAKETURNRATE_COMMAND` Enumeration value for allowed commandType
`static int`	`MANUALSCAN` Enumeration value for sonar scan mode
`static int`	`MARK` Mission goal type
`static int`	`MEANSEALEVELCONTROL` Mean Sea Level (MSL) enumeration for aircraft altitude control type.
`static int`	`MEGAHERTZ` Enumeration for allowable frequency units
`static int`	`META_COMMAND` Enumeration value for allowed commandType
`static int`	`METERSPERSECOND` Enumeration for type of speed units
`protected MissionPreparationElementType`	`missionPreparation` Handle to the AVCL/body MissionPreparation element
`protected MissionResultsElementType`	`missionResults` Handle to the AVCL/body MissionResults element -- which might be null if not telemetry mission
`static int`	`MISSIONSCRIPT_COMMAND` Enumeration value for allowed commandType
`static int`	`MISSIONSCRIPTINLINE_COMMAND` Enumeration value for allowed commandType
`static int`	`MONITORTRANSMISSIONS` Mission goal type
`static int`	`MOVELATERAL_COMMAND` Enumeration value for allowed commandType
`static int`	`MOVEROTATE_COMMAND` Enumeration value for allowed commandType
`static int`	`MSL` Enumeration for commanded altitude type, Mean Sea Level
`static int`	`MUNITION` Enumeration for mission type: enhanced range munition
`static int`	`MUNITION_AIM_POSITION` Enumeration value for allowed commandType
`static int`	`MUNITION_LAUNCH_POSITION` Enumeration value for allowed commandType
`protected GuidedMunitionMissionElementType`	`munitionMission` Handle to the munition mission element for a munition mission
`static int`	`NOVALUE` Enumeration value indicating that no value was provided in a command (i.e. value is either missing or skipped)
`static int`	`NUCLEAR` Enumeration for contaminant type
`static int`	`NUMBER_GOAL_TYPES`
`static int`	`PARALLELTRACK` Enumeration value for type of composite waypoint command
`static int`	`PATROL` Mission goal type
`static int`	`POINT` Enumeration for specifying a type of location geometry
`static int`	`POLYGON` Enumeration for specifying a type of location geometry
`static int`	`PORT` Enumeration for commanded turn direction
`static int`	`PORTPROPELLER` Enumeration value for commanded propellers
`static int`	`POSITION_COMMAND_UAV` Enumeration value for allowed commandType
`static int`	`POSITION_COMMAND_UGV` Enumeration value for allowed commandType
`static int`	`POSITION_COMMAND_USV` Enumeration value for allowed commandType
`static int`	`POSITION_COMMAND_UUV` Enumeration value for allowed commandType
`static Color`	`PRIOR_GOAL` Enumeration color for rendering mission status: prior goal
`static int`	`QUIT_COMMAND` Enumeration value for allowed commandType
`static int`	`REALTIME_COMMAND` Enumeration value for allowed commandType
`static int`	`RECOVER_COMMAND` Enumeration value for allowed commandType
`static int`	`RECTANGLE` Enumeration for specifying a type of location geometry
`static int`	`RELATIVEBEARING` Enumeration value for bearing type
`static int`	`RELATIVEXYPOSITION` Enumeration value for horizontal positioning representation
`static int`	`RENDEZVOUS` Mission goal type
`static int`	`REPOSITION` Mission goal type
`protected List<SampledResultsElementType>`	`resultsList` Handle to MissionResults sampledResults list -- maybe null if not telemetry mission
`static int`	`RIGHT` Enumeration for commanded turn direction
`static int`	`RIGHTTRACK` Enumeration value for ugv track type
`static int`	`SAMPLEENVIRONMENT` Mission goal type
`static int`	`SEARCH` Mission goal type
`static int`	`SECTORPATTERN` Enumeration value for type of composite waypoint command
`static int`	`SENDMESSAGE_COMMAND` Enumeration value for allowed commandType
`static int`	`SETAILERON_COMMAND` Enumeration value for allowed commandType
`static int`	`SETELEVATOR_COMMAND` Enumeration value for allowed commandType
`static int`	`SETPLANES_COMMAND` Enumeration value for allowed commandType
`static int`	`SETPOWER_COMMAND` Enumeration value for allowed commandType
`static int`	`SETPROPELLER_COMMAND` Enumeration value for allowed commandType
`static int`	`SETRUDDER_COMMAND` Enumeration value for allowed commandType
`static int`	`SETSONAR_COMMAND` Enumeration value for allowed commandType
`static int`	`SETSTANDOFF_COMMAND` Enumeration value for allowed commandType
`static int`	`SETTHRUSTER_COMMAND` Enumeration value for allowed commandType
`static int`	`SETTIME_COMMAND` Enumeration value for allowed commandType
`static int`	`SETTIMESTEP_COMMAND` Enumeration value for allowed commandType
`static int`	`SETTRACKSPEED_COMMAND` Enumeration value for allowed commandType
`static int`	`STARBOARD` Enumeration for commanded turn direction
`static int`	`STBDPROPELLER` Enumeration value for commanded propellers
`static int`	`STERNLATERALTHRUSTER` Enumeration value for commanded body thrusters
`static int`	`STERNPLANES` Enumeration value for commanded plane surfaces
`static int`	`STERNVERTICALTHRUSTER` Enumeration value for commanded body thrusters
`static int`	`TAKESTATION_COMMAND` Enumeration value for allowed commandType
`static int`	`TARGETSCAN` Enumeration value for target sonar scan mode
`protected EventLogElementType`	`telemetryEventList` Handle to Telemetry event list
`static int`	`THRUSTERS_COMMAND` Enumeration value for allowed commandType
`static int`	`TOXIN` Enumeration for contaminant type
`static int`	`TRACE_COMMAND` Enumeration value for allowed commandType
`static int`	`TRACKSCAN` Enumeration value for sonar scan mode
`static String`	`TRACKTO` Enumeration for allowable tracking mode used during waypoint navigation
`static int`	`TRUEBEARING` Enumeration value for bearing type
`static int`	`UAV` Enumeration for mission type: unmanned air vehicle
`protected UavScriptCommandsType`	`uavCommandScript` Handle to the mission script element for a UUV mission
`static int`	`UGV` Enumeration for mission type: unmanned ground vehicle
`protected UgvScriptCommandsType`	`ugvCommandScript` Handle to the mission script element for a UGV mission
`static int`	`USV` Enumeration for mission type: unmanned surface vehicle
`protected UsvScriptCommandsType`	`usvCommandScript` Handle to the mission script element for a USV mission
`static int`	`UUV` Enumeration for mission type: unmanned underwater vehicle
`protected UuvScriptCommandsType`	`uuvCommandScript` Handle to the mission script element for a UUV mission
`static int`	`VERTICALTHRUSTERS` Enumeration value for commanded body thrusters
`static int`	`WAIT_COMMAND` Enumeration value for allowed commandType
`static int`	`WAITUNTILTIME_COMMAND` Enumeration value for allowed commandType
`static int`	`WAYPOINT_COMMAND_UAV` Enumeration value for allowed commandType
`static int`	`WAYPOINT_COMMAND_UGV` Enumeration value for allowed commandType
`static int`	`WAYPOINT_COMMAND_USV` Enumeration value for allowed commandType
`static int`	`WAYPOINT_COMMAND_UUV` Enumeration value for allowed commandType
`static int`	`WAYPOINTLIST` Enumeration value for type of composite waypoint command
`static int`	`XYPOSITION` Enumeration value for horizontal positioning representation

Constructor Summary

Constructors
Constructor and Description

AvclMission(int vehicle)
Constructor for a specific vehicle AvclMission

AvclMission(Object obj)
Alternate constructor

Constructors
Constructor and Description
`AvclMission(int vehicle)` Constructor for a specific vehicle AvclMission
`AvclMission(Object obj)` Alternate constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAgendaAvoidArea(AreaElementType obj)`
`void`	`addAgendaAvoidArea(int index, AreaElementType avoidArea)`
`void`	`addAgendaAvoidAreaElement(int index, JAXBElement<?> element)` Inserts an Agenda Goal Element at the specified location of the command list, current Agenda Goal Element is shifted down.
`void`	`addAgendaGoal(AgendaGoalElementType aget)`
`void`	`addAgendaGoal(int index, AgendaGoalElementType aget)`
`void`	`addAgendaGoalElement(int index, JAXBElement<?> element)` Inserts an Agenda Goal Element at the specified location of the command list, current Agenda Goal Element is shifted down.
`void`	`addAgendaGoalElement(JAXBElement<?> element)` Adds an Agenda Goal Element to the end of the goal list
`void`	`addAgendaLaunchPosition(Object obj)`
`void`	`addAgendaRecoveryPosition(Object obj)` Sets the designated recovery position for an agenda mission
`void`	`addCommandElement(int index, JAXBElement<?> commandElement)` Inserts a command at the specified location of the command list, current element is shifted down.
`void`	`addCommandElement(JAXBElement<?> commandElement)` Adds a command element to the end of the command list
`void`	`addMunitionAimPosition(Object obj)`
`void`	`addMunitionLaunchPosition(Object obj)`
`void`	`addSampledResult(SampledResultsElementType newResult)` Adds a sampled result element to the mission results section of the object
`static void`	`addVehicleCapability(Object charEl, String capability)` Adds a capability to the vehicle's capability list
`boolean`	`checkMetaElements(AVCL result)` Checks AVCL meta elements for proper entries and generates default elements if required
`void`	`clearCommandList()` Clears (deletes) all commands from the command list
`void`	`clearEventLog()` Clears all items from the event log
`void`	`clearGeoOrigin()` Clears the GeoOrigin element and deletes it without replacement
`void`	`clearMetaElements()` Clears (deletes) all meta elements in the document head section
`int`	`commandType(int index)` Returns an integer enumeration for the type of command at a specified location in the list
`static int`	`commandType(Object command)`
`JAXBElement<?>`	`copyCommandElement(int index)` Retrieves a command at a specified location in the list.
`static DateTimeGroupElementType`	`createCurrentDateTimeGroupElement(String description)` Creates a date time group element corresponding to the current time
`void`	`createGeoOrigin(double latitude, double longitude, double radius, String description)` Generates a new GeoOrigin element and assigns it to the mission
`void`	`createHeadElement()` Generates a new head element and adds it to the mission
`void`	`createMetaElement(String name, String content)` Generates a new meta element and adds it to the mission head section
`static SampledResultsElementType`	`createSampledResultElement(double time, String description)`
`static Object`	`createVehicleCharacteristicsElement(int vehicleType)` Creates a vehicle characteristics element element for the specified type of vehicle
`void`	`generateAgendaConfigurationElement()` Generates a vehicle configuration element containing minimum unmanned vehicle configuration requirements to successfully execute the currently defined mission
`void`	`generateEventLog()` Adds an EventLog element to the mission
`void`	`generateMunitionConfigurationElement()` Generates a vehicle configuration element containing minimum unmanned vehicle configuration requirements to successfully execute the currently defined mission
`void`	`generateUavConfigurationElement()` Generates a vehicle configuration element containing minimum unmanned ground vehicle configuration requirements to successfully execute the currently defined mission
`void`	`generateUgvConfigurationElement()` Generates a vehicle configuration element containing minimum unmanned ground vehicle configuration requirements to successfully execute the currently defined mission
`void`	`generateUsvConfigurationElement()` Generates a vehicle configuration element containing minimum unmanned surface vehicle configuration requirements to successfully execute the currently defined mission
`AreaElementType`	`getAgendaAvoidArea(int index)`
`AgendaConstraintListType`	`getAgendaConstraintList()` Returns a reference to the strategic-level agenda mission goals
`List<AreaElementType>`	`getAgendaConstraintListAvoidAreas()` Retrieve all agenda constraints
`RouteElementType`	`getAgendaConstraintsEgressRouting()`
`RouteElementType`	`getAgendaConstraintsIngressRouting()`
`AgendaGoalElementType`	`getAgendaGoal(int index)`
`List<AgendaGoalElementType>`	`getAgendaGoalList()` Returns a reference to the agenda mission goals
`AgendaGoalListType`	`getAgendaGoals()` Returns a reference to the agenda mission goals
`AbsoluteHorizontalPositionElementType`	`getAgendaLaunchPosition()` Returns a reference to the launch position element of an agenda mission
`AgendaMissionElementType`	`getAgendaMissionElement()` Returns the agenda mission element
`AbsoluteHorizontalPositionElementType`	`getAgendaRecoveryPosition()` Returns a reference to the recovery position element of an agenda mission
`JAXBElement<?>`	`getCommandElement(int index)` Returns the command at a specified location in the list.
`List<JAXBElement<?>>`	`getCommandElementList()` Returns a reference to the script command elements list
`int`	`getCommandListSize()` Returns the number of commands in the script
`JAXBElement<?>`	`getCommandTypeElement(Object cmd)`
`ConfigurationElementType`	`getConfiguration()` Returns the current Configuration element
`static String`	`getDescription(Object element)`
`List<?>`	`getEventLog()`
`GeoOriginElementType`	`getGeoOrigin()`
`static double`	`getGeoOriginLatitude(GeoOriginElementType go)`
`static double`	`getGeoOriginLongitude(GeoOriginElementType go)`
`static double`	`getGeoOriginRadius(GeoOriginElementType go)`
`JAXBContext`	`getJAXBContext()` Provide the `JAXBContext` for the current AVCL mission, which is JAXB binding framework for unmarshal, marshal and validate operations
`JAXBIntrospector`	`getJAXBIntrospector()` JAXB Introspector is used to invoke JAXBElement objects
`double`	`getLength()` TODO: Implement this
`static String`	`getMetaElementContent(JAXBElement<?> meta)`
`static String`	`getMetaElementDescription(JAXBElement<?> meta)`
`List<MetaType>`	`getMetaElementList()`
`static String`	`getMetaElementName(JAXBElement<?> meta)`
`File`	`getMissionFile()`
`AVCL`	`getMissionJaxb()`
`MissionPreparationElementType`	`getMissionPreparationElement()`
`MunitionAimPointElementType`	`getMunitionAimPosition()`
`MunitionLaunchPointElementType`	`getMunitionLaunchPosition()`
`GuidedMunitionMissionElementType`	`getMunitionMissionElement()` Returns the munition mission element
`ObjectFactory`	`getObjectFactory()` Object factory is used to generate content nodes defined during editing
`static String`	`getSampledResultDescription(SampledResultsElementType result)`
`static double`	`getSampledResultTime(SampledResultsElementType result)`
`List<SampledResultsElementType>`	`getTelemetryList()`
`static double`	`getTimeStamp(Object element)` Retrieve via introspection, the value of an element's timeStamp attribute
`UnitsOfMeasureElementType`	`getUnitsOfMeasure()` Returns the current Units of Measure element
`String`	`getUnitsOfMeasureAngle(Object uom)`
`String`	`getUnitsOfMeasureDistance(Object uom)`
`String`	`getUnitsOfMeasureTime(Object uom)`
`static Object`	`getVehicleCapability(Object charEl, int index)`
`int`	`getVehicleIDParameter()` Sets the vehicle ID attribute
`String`	`getVehicleNameParameter()` Gets the vehicle name attribute
`static int`	`getVehicleNumCapabilities(Object charEl)`
`int`	`getVehicleType()`
`String`	`getVehicleTypeParameter()` Gets the vehicle type attribute
`XMLValidationTool`	`getXMLValidationTool()`
`static AvclMission`	`instance()` Only need one instance for static usages
`boolean`	`isAgendaMission()`
`boolean`	`isEditable()`
`boolean`	`isEditableAgenda()`
`boolean`	`isMunitionMission()`
`static boolean`	`isPartialControlCommand(JAXBElement<?> commandElement)`
`static boolean`	`isPlottable(int cmdType)` Returns whether the command occupies a place on any of the visual displays
`boolean`	`isTelemetryReplayMission()` TODO: This needs to be a better check.
`static boolean`	`isTerminatingCommand(JAXBElement<?> commandElement)`
`boolean`	`isValid()`
`boolean`	`isValidXMLDocument()`
`void`	`logEvent(Object event)` Adds an event to the event log
`void`	`marshal()` Writes an XML (AVCL) to the default location (probably the file from which it was loaded)
`void`	`marshal(File outFile)` Writes XML (AVCL) to a designated file
`void`	`marshal(OutputStream stream)` Writes XML (AVCL) to a designated output stream
`void`	`marshal(String outFile)` Writes an XML (AVCL) to a designated file
`void`	`marshalNoHeader(Object fragment, File outFile)` Writes an XML (AVCL) to a designated file, but without the XML header
`void`	`marshalNoHeader(Object fragment, OutputStream stream)` Writes an XML (AVCL) to a designated output stream, but without the XML header
`void`	`marshalNoHeader(Object fragment, PrintStream writer)` Writes an XML (AVCL) to a designated output stream, but without the XML header
`void`	`marshalNoHeader(Object fragment, PrintWriter writer)` Writes an XML (AVCL) to a designated output stream, but without the XML header
`void`	`marshalNoHeader(Object fragment, String outFile)` Writes an XML (AVCL) to a designated file, but without the XML header
`String`	`marshalToString()` Writes an XML (AVCL) object to a String (not used)
`void`	`removeAgendaAvoidArea(int index)` Remove an agenda avoidance area from the mission
`Object`	`removeAgendaElement(int index)` Removes an Agenda Goal at a specified location in the list.
`void`	`removeAgendaGoal(int index)` Remove an agenda goal from the mission
`void`	`removeAgendaLaunchPosition()` Deletes the agenda-specified launch position
`void`	`removeAgendaRecoveryPosition()` Deletes the agenda-specified
`Object`	`removeCommand(int index)` Removes the command at a specified location in the list.
`void`	`removeMunitionElement(int index)`
`static Object`	`removeVehicleCapability(Object charEl, int index)`
`void`	`replaceCommand(int index, JAXBElement<?> commandElement)` Replaces a command at the specified location of the command list
`void`	`setAgendaLaunchPosition(AbsoluteHorizontalPositionElementType ahpt)`
`void`	`setAgendaRecoveryPosition(AbsoluteHorizontalPositionElementType ahpt)`
`void`	`setGeoOriginLatitude(double newLatitude)` Sets the latitude portion of the GeoOrigin element
`void`	`setGeoOriginLongitude(double newLongitude)` Sets the longitude portion of the GeoOrigin element
`void`	`setGeoOriginRadius(double newRadius)` Sets the radius portion of the GeoOrigin element
`void`	`setMissionFilename(String name)` Sets the name of a newly created, or existing mission file
`void`	`setMissionJaxb(AVCL missionJaxb)`
`void`	`setMissionOffsetDelta(String northing, String easting)` Set the mission area offset from a central geographical (Lat/Long) point
`void`	`setMunitionAimPosition(MunitionAimPointElementType obj)`
`void`	`setMunitionLaunchPosition(MunitionLaunchPointElementType obj)`
`static void`	`setSampledResultDescription(SampledResultsElementType result, String description)` Sets the description of a sampled result element
`static void`	`setSampledResultTime(SampledResultsElementType result, double time)` Sets the timestamp of a sampled result element
`static void`	`setTimeStamp(Object element, double newValue)` TimeStamp marshaling method
`void`	`setValid(boolean valid)`
`void`	`setVehicleIDParameter(int id)` Sets the vehicle ID attribute
`void`	`setVehicleNameParameter(String newName)` Sets the vehicle name attribute
`void`	`setVehicleType(int vehicleType)`
`void`	`setVehicleType(String vehicleType)` Sets the vehicle type attribute

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOVALUE
```
public static final int NOVALUE
```
    Enumeration value indicating that no value was provided in a command (i.e. value is either missing or skipped)
    
    See Also:
    
    Constant Field Values
  - XYPOSITION
```
public static final int XYPOSITION
```
    Enumeration value for horizontal positioning representation
    
    See Also:
    
    Constant Field Values
  - RELATIVEXYPOSITION
```
public static final int RELATIVEXYPOSITION
```
    Enumeration value for horizontal positioning representation
    
    See Also:
    
    Constant Field Values
  - LATLONGPOSITION
```
public static final int LATLONGPOSITION
```
    Enumeration value for horizontal positioning representation
    
    See Also:
    
    Constant Field Values
  - DEPTHCONTROL
```
public static final int DEPTHCONTROL
```
    Enumeration value for z-axis vertical control mode
    
    See Also:
    
    Constant Field Values
  - ALTITUDECONTROL
```
public static final int ALTITUDECONTROL
```
    Enumeration value for z-axis vertical control mode
    
    See Also:
    
    Constant Field Values
  - DEFAULTZCONTROL
```
public static final int DEFAULTZCONTROL
```
    Enumeration value for z-axis vertical control mode
    
    See Also:
    
    Constant Field Values
  - MEANSEALEVELCONTROL
```
public static final int MEANSEALEVELCONTROL
```
    Mean Sea Level (MSL) enumeration for aircraft altitude control type.
    
    See Also:
    
    ABOVEGROUNDLEVELCONTROL, Constant Field Values
  - ABOVEGROUNDLEVELCONTROL
```
public static final int ABOVEGROUNDLEVELCONTROL
```
    Above Ground Level (AGL) enumeration for aircraft altitude control type.
    
    See Also:
    
    MEANSEALEVELCONTROL, Constant Field Values
  - ABSOLUTE_TIMING
```
public static final int ABSOLUTE_TIMING
```
    Enumeration for absolute timing, meaning that time values are actual clock values.
    
    See Also:
    
    DURATION_TIMING, Constant Field Values
  - DURATION_TIMING
```
public static final int DURATION_TIMING
```
    Enumeration for relative timing, meaning that time values are duration intervals.
    
    See Also:
    
    ABSOLUTE_TIMING, Constant Field Values
  - NUMBER_GOAL_TYPES
```
public static final int NUMBER_GOAL_TYPES
```
    See Also:
    
    Constant Field Values
  - ATTACK
```
public static final int ATTACK
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - DECONTAMINATE
```
public static final int DECONTAMINATE
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - DEMOLISH
```
public static final int DEMOLISH
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - ILLUMINATE
```
public static final int ILLUMINATE
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - JAM
```
public static final int JAM
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - MARK
```
public static final int MARK
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - MONITORTRANSMISSIONS
```
public static final int MONITORTRANSMISSIONS
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - PATROL
```
public static final int PATROL
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - RENDEZVOUS
```
public static final int RENDEZVOUS
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - REPOSITION
```
public static final int REPOSITION
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - SAMPLEENVIRONMENT
```
public static final int SAMPLEENVIRONMENT
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - SEARCH
```
public static final int SEARCH
```
    Mission goal type
    
    See Also:
    
    Constant Field Values
  - GOAL_NAMES
```
public static final String[] GOAL_NAMES
```
  - DEPTH
```
public static final int DEPTH
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_ABV_BTM
```
public static final int ALTITUDE_ABV_BTM
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_MSL
```
public static final int ALTITUDE_MSL
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_AGL
```
public static final int ALTITUDE_AGL
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - DEPTH_BLK
```
public static final int DEPTH_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - DEPTH_ALTITUDE_ABV_BTM_BLK
```
public static final int DEPTH_ALTITUDE_ABV_BTM_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_ABV_BTM_BLK
```
public static final int ALTITUDE_ABV_BTM_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_AGL_BLK
```
public static final int ALTITUDE_AGL_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_MSL_BLK
```
public static final int ALTITUDE_MSL_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_AGL_MSL_BLK
```
public static final int ALTITUDE_AGL_MSL_BLK
```
    Enumeration for block depth/altitude type
    
    See Also:
    
    Constant Field Values
  - POINT
```
public static final int POINT
```
    Enumeration for specifying a type of location geometry
    
    See Also:
    
    Constant Field Values
  - CIRCLE
```
public static final int CIRCLE
```
    Enumeration for specifying a type of location geometry
    
    See Also:
    
    Constant Field Values
  - RECTANGLE
```
public static final int RECTANGLE
```
    Enumeration for specifying a type of location geometry
    
    See Also:
    
    Constant Field Values
  - POLYGON
```
public static final int POLYGON
```
    Enumeration for specifying a type of location geometry
    
    See Also:
    
    Constant Field Values
  - LIMITING_LINE
```
public static final int LIMITING_LINE
```
    Enumeration for specifying a type of location geometry
    
    See Also:
    
    Constant Field Values
  - INGRESS_ROUTE
```
public static final int INGRESS_ROUTE
```
    Enumeration for direction of routing (ingress or egress)
    
    See Also:
    
    Constant Field Values
  - EGRESS_ROUTE
```
public static final int EGRESS_ROUTE
```
    Enumeration for direction of routing (ingress or egress)
    
    See Also:
    
    Constant Field Values
  - TARGETSCAN
```
public static final int TARGETSCAN
```
    Enumeration value for target sonar scan mode
    
    See Also:
    
    Constant Field Values
  - EDGESCAN
```
public static final int EDGESCAN
```
    Enumeration value for target sonar scan mode
    
    See Also:
    
    Constant Field Values
  - FORWARDSCAN
```
public static final int FORWARDSCAN
```
    Enumeration value for sonar scan mode
    
    See Also:
    
    Constant Field Values
  - MANUALSCAN
```
public static final int MANUALSCAN
```
    Enumeration value for sonar scan mode
    
    See Also:
    
    Constant Field Values
  - TRACKSCAN
```
public static final int TRACKSCAN
```
    Enumeration value for sonar scan mode
    
    See Also:
    
    Constant Field Values
  - GPSSTART
```
public static final int GPSSTART
```
    Enumeration value for GPS fix status
    
    See Also:
    
    Constant Field Values
  - GPSINPROGRESS
```
public static final int GPSINPROGRESS
```
    Enumeration value for GPS fix status
    
    See Also:
    
    Constant Field Values
  - GPSCOMPLETE
```
public static final int GPSCOMPLETE
```
    Enumeration value for GPS fix status
    
    See Also:
    
    Constant Field Values
  - GPSFAIL
```
public static final int GPSFAIL
```
    Enumeration value for GPS fix status
    
    See Also:
    
    Constant Field Values
  - RELATIVEBEARING
```
public static final int RELATIVEBEARING
```
    Enumeration value for bearing type
    
    See Also:
    
    Constant Field Values
  - TRUEBEARING
```
public static final int TRUEBEARING
```
    Enumeration value for bearing type
    
    See Also:
    
    Constant Field Values
  - MAGNETICBEARING
```
public static final int MAGNETICBEARING
```
    Enumeration value for bearing type
    
    See Also:
    
    Constant Field Values
  - ALLPROPELLERS
```
public static final int ALLPROPELLERS
```
    Enumeration value for commanded propellers
    
    See Also:
    
    Constant Field Values
  - STBDPROPELLER
```
public static final int STBDPROPELLER
```
    Enumeration value for commanded propellers
    
    See Also:
    
    Constant Field Values
  - PORTPROPELLER
```
public static final int PORTPROPELLER
```
    Enumeration value for commanded propellers
    
    See Also:
    
    Constant Field Values
  - CENTERPROPELLER
```
public static final int CENTERPROPELLER
```
    Enumeration value for commanded propellers
    
    See Also:
    
    Constant Field Values
  - KNOTS
```
public static final int KNOTS
```
    Enumeration for type of speed units
    
    See Also:
    
    Constant Field Values
  - METERSPERSECOND
```
public static final int METERSPERSECOND
```
    Enumeration for type of speed units
    
    See Also:
    
    Constant Field Values
  - LATERALTHRUSTERS
```
public static final int LATERALTHRUSTERS
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - BOWLATERALTHRUSTER
```
public static final int BOWLATERALTHRUSTER
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - STERNLATERALTHRUSTER
```
public static final int STERNLATERALTHRUSTER
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - VERTICALTHRUSTERS
```
public static final int VERTICALTHRUSTERS
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - BOWVERTICALTHRUSTER
```
public static final int BOWVERTICALTHRUSTER
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - STERNVERTICALTHRUSTER
```
public static final int STERNVERTICALTHRUSTER
```
    Enumeration value for commanded body thrusters
    
    See Also:
    
    Constant Field Values
  - ALLPLANES
```
public static final int ALLPLANES
```
    Enumeration value for commanded plane surfaces
    
    See Also:
    
    Constant Field Values
  - BOWPLANES
```
public static final int BOWPLANES
```
    Enumeration value for commanded plane surfaces
    
    See Also:
    
    Constant Field Values
  - STERNPLANES
```
public static final int STERNPLANES
```
    Enumeration value for commanded plane surfaces
    
    See Also:
    
    Constant Field Values
  - ALLTRACKS
```
public static final int ALLTRACKS
```
    Enumeration value for ugv track type
    
    See Also:
    
    Constant Field Values
  - LEFTTRACK
```
public static final int LEFTTRACK
```
    Enumeration value for ugv track type
    
    See Also:
    
    Constant Field Values
  - RIGHTTRACK
```
public static final int RIGHTTRACK
```
    Enumeration value for ugv track type
    
    See Also:
    
    Constant Field Values
  - MSL
```
public static final int MSL
```
    Enumeration for commanded altitude type, Mean Sea Level
    
    See Also:
    
    Constant Field Values
  - AGL
```
public static final int AGL
```
    Enumeration for commanded altitude type, Above Ground Level
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    Enumeration for commanded turn direction
    
    See Also:
    
    Constant Field Values
  - STARBOARD
```
public static final int STARBOARD
```
    Enumeration for commanded turn direction
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    Enumeration for commanded turn direction
    
    See Also:
    
    Constant Field Values
  - PORT
```
public static final int PORT
```
    Enumeration for commanded turn direction
    
    See Also:
    
    Constant Field Values
  - DIRECTTO
```
public static final String DIRECTTO
```
    Enumeration for allowable homing/tracking mode used during waypoint navigation
    
    See Also:
    
    Constant Field Values
  - TRACKTO
```
public static final String TRACKTO
```
    Enumeration for allowable tracking mode used during waypoint navigation
    
    See Also:
    
    Constant Field Values
  - HERTZ
```
public static final int HERTZ
```
    Enumeration for allowable frequency units
    
    See Also:
    
    Constant Field Values
  - KILOHERTZ
```
public static final int KILOHERTZ
```
    Enumeration for allowable frequency units
    
    See Also:
    
    Constant Field Values
  - MEGAHERTZ
```
public static final int MEGAHERTZ
```
    Enumeration for allowable frequency units
    
    See Also:
    
    Constant Field Values
  - GIGAHERTZ
```
public static final int GIGAHERTZ
```
    Enumeration for allowable frequency units
    
    See Also:
    
    Constant Field Values
  - NUCLEAR
```
public static final int NUCLEAR
```
    Enumeration for contaminant type
    
    See Also:
    
    Constant Field Values
  - BIOLOGICAL
```
public static final int BIOLOGICAL
```
    Enumeration for contaminant type
    
    See Also:
    
    Constant Field Values
  - CHEMICAL
```
public static final int CHEMICAL
```
    Enumeration for contaminant type
    
    See Also:
    
    Constant Field Values
  - EXPLOSIVE
```
public static final int EXPLOSIVE
```
    Enumeration for contaminant type
    
    See Also:
    
    Constant Field Values
  - TOXIN
```
public static final int TOXIN
```
    Enumeration for contaminant type
    
    See Also:
    
    Constant Field Values
  - COMPOSITEWAYPOINT_COMMAND_UUV
```
public static final int COMPOSITEWAYPOINT_COMMAND_UUV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - COMPOSITEWAYPOINT_COMMAND_UGV
```
public static final int COMPOSITEWAYPOINT_COMMAND_UGV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - COMPOSITEWAYPOINT_COMMAND_USV
```
public static final int COMPOSITEWAYPOINT_COMMAND_USV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - COMPOSITEWAYPOINT_COMMAND_UAV
```
public static final int COMPOSITEWAYPOINT_COMMAND_UAV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - RECOVER_COMMAND
```
public static final int RECOVER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - FOLLOWBEACON_COMMAND
```
public static final int FOLLOWBEACON_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - GPSFIX_COMMAND
```
public static final int GPSFIX_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - HELP_COMMAND
```
public static final int HELP_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - HOVER_COMMAND
```
public static final int HOVER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEALTITUDE_COMMAND
```
public static final int MAKEALTITUDE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEALTITUDEAGL_COMMAND
```
public static final int MAKEALTITUDEAGL_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEALTITUDEMSL_COMMAND
```
public static final int MAKEALTITUDEMSL_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKECLIMBRATE_COMMAND
```
public static final int MAKECLIMBRATE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEDEPTH_COMMAND
```
public static final int MAKEDEPTH_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEHEADING_COMMAND
```
public static final int MAKEHEADING_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKEKNOTS_COMMAND
```
public static final int MAKEKNOTS_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKESPEED_COMMAND
```
public static final int MAKESPEED_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MAKETURNRATE_COMMAND
```
public static final int MAKETURNRATE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - META_COMMAND
```
public static final int META_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MISSIONSCRIPT_COMMAND
```
public static final int MISSIONSCRIPT_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MISSIONSCRIPTINLINE_COMMAND
```
public static final int MISSIONSCRIPTINLINE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MOVELATERAL_COMMAND
```
public static final int MOVELATERAL_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MOVEROTATE_COMMAND
```
public static final int MOVEROTATE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - POSITION_COMMAND_UUV
```
public static final int POSITION_COMMAND_UUV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - POSITION_COMMAND_UGV
```
public static final int POSITION_COMMAND_UGV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - POSITION_COMMAND_USV
```
public static final int POSITION_COMMAND_USV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - POSITION_COMMAND_UAV
```
public static final int POSITION_COMMAND_UAV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - QUIT_COMMAND
```
public static final int QUIT_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - REALTIME_COMMAND
```
public static final int REALTIME_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETTIME_COMMAND
```
public static final int SETTIME_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SENDMESSAGE_COMMAND
```
public static final int SENDMESSAGE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETAILERON_COMMAND
```
public static final int SETAILERON_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETELEVATOR_COMMAND
```
public static final int SETELEVATOR_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETPLANES_COMMAND
```
public static final int SETPLANES_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETPOWER_COMMAND
```
public static final int SETPOWER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETPROPELLER_COMMAND
```
public static final int SETPROPELLER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETRUDDER_COMMAND
```
public static final int SETRUDDER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETSONAR_COMMAND
```
public static final int SETSONAR_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETTHRUSTER_COMMAND
```
public static final int SETTHRUSTER_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETTRACKSPEED_COMMAND
```
public static final int SETTRACKSPEED_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETSTANDOFF_COMMAND
```
public static final int SETSTANDOFF_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - TAKESTATION_COMMAND
```
public static final int TAKESTATION_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - THRUSTERS_COMMAND
```
public static final int THRUSTERS_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - SETTIMESTEP_COMMAND
```
public static final int SETTIMESTEP_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - TRACE_COMMAND
```
public static final int TRACE_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAIT_COMMAND
```
public static final int WAIT_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAITUNTILTIME_COMMAND
```
public static final int WAITUNTILTIME_COMMAND
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAYPOINT_COMMAND_UUV
```
public static final int WAYPOINT_COMMAND_UUV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAYPOINT_COMMAND_UGV
```
public static final int WAYPOINT_COMMAND_UGV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAYPOINT_COMMAND_USV
```
public static final int WAYPOINT_COMMAND_USV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - WAYPOINT_COMMAND_UAV
```
public static final int WAYPOINT_COMMAND_UAV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - LOITER_COMMAND_UUV
```
public static final int LOITER_COMMAND_UUV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - LOITER_COMMAND_UGV
```
public static final int LOITER_COMMAND_UGV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - LOITER_COMMAND_USV
```
public static final int LOITER_COMMAND_USV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - LOITER_COMMAND_UAV
```
public static final int LOITER_COMMAND_UAV
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AGENDA_GOAL
```
public static final int AGENDA_GOAL
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AGENDA_AVOIDAREAELEMENT
```
public static final int AGENDA_AVOIDAREAELEMENT
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AGENDA_ROUTEELEMENT
```
public static final int AGENDA_ROUTEELEMENT
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AGENDA_LAUNCH_POSITION
```
public static final int AGENDA_LAUNCH_POSITION
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AGENDA_RECOVERY_POSITION
```
public static final int AGENDA_RECOVERY_POSITION
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MUNITION_LAUNCH_POSITION
```
public static final int MUNITION_LAUNCH_POSITION
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - MUNITION_AIM_POSITION
```
public static final int MUNITION_AIM_POSITION
```
    Enumeration value for allowed commandType
    
    See Also:
    
    Constant Field Values
  - AVCL_COMMAND_NAMES
```
public static final String[] AVCL_COMMAND_NAMES
```
    Enumeration values for allowed AVCL command names
  - PARALLELTRACK
```
public static final int PARALLELTRACK
```
    Enumeration value for type of composite waypoint command
    
    See Also:
    
    Constant Field Values
  - EXPANDINGSQUARE
```
public static final int EXPANDINGSQUARE
```
    Enumeration value for type of composite waypoint command
    
    See Also:
    
    Constant Field Values
  - SECTORPATTERN
```
public static final int SECTORPATTERN
```
    Enumeration value for type of composite waypoint command
    
    See Also:
    
    Constant Field Values
  - WAYPOINTLIST
```
public static final int WAYPOINTLIST
```
    Enumeration value for type of composite waypoint command
    
    See Also:
    
    Constant Field Values
  - UUV
```
public static final int UUV
```
    Enumeration for mission type: unmanned underwater vehicle
    
    See Also:
    
    Constant Field Values
  - UGV
```
public static final int UGV
```
    Enumeration for mission type: unmanned ground vehicle
    
    See Also:
    
    Constant Field Values
  - USV
```
public static final int USV
```
    Enumeration for mission type: unmanned surface vehicle
    
    See Also:
    
    Constant Field Values
  - UAV
```
public static final int UAV
```
    Enumeration for mission type: unmanned air vehicle
    
    See Also:
    
    Constant Field Values
  - MUNITION
```
public static final int MUNITION
```
    Enumeration for mission type: enhanced range munition
    
    See Also:
    
    Constant Field Values
  - AGENDA
```
public static final int AGENDA
```
    Enumeration for mission type: non-vehicle-specific agenda planning mission
    
    See Also:
    
    Constant Field Values
  - INITIAL_GOAL
```
public static final Color INITIAL_GOAL
```
    Enumeration color for rendering mission status: initial goal
  - CURRENT_GOAL
```
public static final Color CURRENT_GOAL
```
    Enumeration color for rendering mission status: current goal
  - PRIOR_GOAL
```
public static final Color PRIOR_GOAL
```
    Enumeration color for rendering mission status: prior goal
  - GOAL_ON_SUCCESS
```
public static final Color GOAL_ON_SUCCESS
```
    Enumeration color for rendering mission status: next goal on success
  - GOAL_ON_FAILURE
```
public static final Color GOAL_ON_FAILURE
```
    Enumeration color for rendering mission status: next goal on failure
  - head
```
protected AvclHeadType head
```
    Handle to AVCL head element
  - body
```
protected AvclBodyType body
```
    Handle to the AVCL body element
  - missionPreparation
```
protected MissionPreparationElementType missionPreparation
```
    Handle to the AVCL/body MissionPreparation element
  - missionResults
```
protected MissionResultsElementType missionResults
```
    Handle to the AVCL/body MissionResults element -- which might be null if not telemetry mission
  - resultsList
```
protected List<SampledResultsElementType> resultsList
```
    Handle to MissionResults sampledResults list -- maybe null if not telemetry mission
  - telemetryEventList
```
protected EventLogElementType telemetryEventList
```
    Handle to Telemetry event list
  - uuvCommandScript
```
protected UuvScriptCommandsType uuvCommandScript
```
    Handle to the mission script element for a UUV mission
  - ugvCommandScript
```
protected UgvScriptCommandsType ugvCommandScript
```
    Handle to the mission script element for a UGV mission
  - usvCommandScript
```
protected UsvScriptCommandsType usvCommandScript
```
    Handle to the mission script element for a USV mission
  - uavCommandScript
```
protected UavScriptCommandsType uavCommandScript
```
    Handle to the mission script element for a UUV mission
  - agendaMission
```
protected AgendaMissionElementType agendaMission
```
    Handle to the strategic-level agenda mission element
  - agendaGoalList
```
protected AgendaGoalListType agendaGoalList
```
    Handle to the list containing strategic-level agenda goals
  - agendaConstraintList
```
protected AgendaConstraintListType agendaConstraintList
```
    Handle to the list containing strategic-level agenda constraints
  - munitionMission
```
protected GuidedMunitionMissionElementType munitionMission
```
    Handle to the munition mission element for a munition mission
  - eventLog
```
protected EventLogElementType eventLog
```
    Handle to the Event Log element
  - eventLogItems
```
protected List<Object> eventLogItems
```
    Handle to the list of logged events
  - geoOrigin
```
protected GeoOriginElementType geoOrigin
```
    Handle to the GeoOrigin element
  - commandElementList
```
protected List<JAXBElement<?>> commandElementList
```
    Handle to the mission script command list
- Constructor Detail
  - AvclMission
```
public AvclMission(Object obj)
```
    Alternate constructor
    
    Parameters:
    
    obj - either an Integer, String, File or InputStream object used to determine how to load a given mission
  - AvclMission
```
public AvclMission(int vehicle)
```
    Constructor for a specific vehicle AvclMission
    
    Parameters:
    
    vehicle -
- Method Detail
  - instance
```
public static AvclMission instance()
```
    Only need one instance for static usages
    
    Returns:
    
    only one new instance of default AvclMission
  - getXMLValidationTool
```
public XMLValidationTool getXMLValidationTool()
```
    Returns:
    
    an instance of XMLValidationTool for this Mission
  - getJAXBContext
```
public JAXBContext getJAXBContext()
```
    Provide the JAXBContext for the current AVCL mission, which is JAXB binding framework for unmarshal, marshal and validate operations
    
    Returns:
    
    JAXBContext
  - getObjectFactory
```
public ObjectFactory getObjectFactory()
```
    Object factory is used to generate content nodes defined during editing
    
    Returns:
    
    ObjectFactory
  - getJAXBIntrospector
```
public JAXBIntrospector getJAXBIntrospector()
```
    JAXB Introspector is used to invoke JAXBElement objects
    
    Returns:
    
    JAXBIntrospector
  - getTelemetryList
```
public List<SampledResultsElementType> getTelemetryList()
```
    Returns:
    
    the telemetry results list, may be null if not telemetry replay mission
  - getEventLog
```
public List<?> getEventLog()
```
    Returns:
    
    the telemetry event log, may be null if not telemetry replay mission
  - setMissionFilename
```
public final void setMissionFilename(String name)
```
    Sets the name of a newly created, or existing mission file
    
    Parameters:
    
    name - the name to set
  - getMissionFile
```
public File getMissionFile()
```
    Returns:
    
    the mission file object
  - isAgendaMission
```
public boolean isAgendaMission()
```
    Returns:
    
    if this mission is an agenda mission
  - isTelemetryReplayMission
```
public boolean isTelemetryReplayMission()
```
    TODO: This needs to be a better check. Seems to return true if not a telemetry replay mission.
    
    Returns:
    
    if this mission is a replay/canned mission based on telemetry data included in file
  - isValidXMLDocument
```
public boolean isValidXMLDocument()
```
    Returns:
    
    true iif the current object is valid against the schema
  - isMunitionMission
```
public boolean isMunitionMission()
```
    Returns:
    
    if mission is extended-range-munition type
  - isEditable
```
public boolean isEditable()
```
    Returns:
    
    true if the current object is capable of being edited, i.e. it contains a valid AVCL mission object
  - isEditableAgenda
```
public boolean isEditableAgenda()
```
    Returns:
    
    true if the current object is capable of being edited (contains a valid AVCL object)
  - checkMetaElements
```
public boolean checkMetaElements(AVCL result)
```
    Checks AVCL meta elements for proper entries and generates default elements if required
    
    Parameters:
    
    result - the AVCL to parse for meta element information
    
    Returns:
    
    true if any meta elements are added or changed
  - getVehicleType
```
public int getVehicleType()
```
    Returns:
    
    the enumeration of the vehicle type for this mission: UUV, UGV, USV, UAV, MUNITION, or AGENDA
  - setVehicleType
```
public void setVehicleType(int vehicleType)
```
    Parameters:
    
    vehicleType - the vehicleType to set: UUV, UGV, USV, UAV, MUNITION, or AGENDA
  - marshal
```
public void marshal()
```
    Writes an XML (AVCL) to the default location (probably the file from which it was loaded)
  - marshal
```
public void marshal(String outFile)
```
    Writes an XML (AVCL) to a designated file
    
    Parameters:
    
    outFile - filename and path to which output is to be directed
  - marshal
```
public void marshal(File outFile)
```
    Writes XML (AVCL) to a designated file
    
    Parameters:
    
    outFile - filename and path to which output is to be directed
  - marshal
```
public void marshal(OutputStream stream)
```
    Writes XML (AVCL) to a designated output stream
    
    Parameters:
    
    stream - OutputStream to which output is to be directed
  - marshalToString
```
public String marshalToString()
```
    Writes an XML (AVCL) object to a String (not used)
    
    Returns:
    
    the string
  - marshalNoHeader
```
public void marshalNoHeader(Object fragment,
                            String outFile)
```
    Writes an XML (AVCL) to a designated file, but without the XML header
    
    Parameters:
    
    fragment - AVCL document fragment that is to be marshaled
    
    outFile - filename and path to which output is to be directed
  - marshalNoHeader
```
public void marshalNoHeader(Object fragment,
                            File outFile)
```
    Writes an XML (AVCL) to a designated file, but without the XML header
    
    Parameters:
    
    fragment - AVCL document fragment that is to be marshaled
    
    outFile - filename and path to which output is to be directed
  - marshalNoHeader
```
public void marshalNoHeader(Object fragment,
                            OutputStream stream)
```
    Writes an XML (AVCL) to a designated output stream, but without the XML header
    
    Parameters:
    
    fragment - AVCL document fragment that is to be marshaled
    
    stream - OutputStream to which output is to be directed
  - marshalNoHeader
```
public void marshalNoHeader(Object fragment,
                            PrintStream writer)
```
    Writes an XML (AVCL) to a designated output stream, but without the XML header
    
    Parameters:
    
    fragment - AVCL document fragment that is to be marshaled
    
    writer - PrintStream to which output is to be directed
  - marshalNoHeader
```
public void marshalNoHeader(Object fragment,
                            PrintWriter writer)
```
    Writes an XML (AVCL) to a designated output stream, but without the XML header
    
    Parameters:
    
    fragment - AVCL document fragment that is to be marshaled
    
    writer - PrintWriter to which output is to be directed
  - getCommandTypeElement
```
public JAXBElement<?> getCommandTypeElement(Object cmd)
```
    Parameters:
    
    cmd - the vehicle-specific command, either in object form or element form
    
    Returns:
    
    a new vehicle specific command type as a typed JAXBElement<?>
  - getConfiguration
```
public ConfigurationElementType getConfiguration()
```
    Returns the current Configuration element
    
    Returns:
    
    Object units of measure element
  - getUnitsOfMeasure
```
public UnitsOfMeasureElementType getUnitsOfMeasure()
```
    Returns the current Units of Measure element
    
    Returns:
    
    the units of measure type element
  - getUnitsOfMeasureAngle
```
public String getUnitsOfMeasureAngle(Object uom)
```
    Parameters:
    
    uom - (does nothing)
    
    Returns:
    
    the angle attribute of a units of measure type element
  - getUnitsOfMeasureDistance
```
public String getUnitsOfMeasureDistance(Object uom)
```
    Parameters:
    
    uom - (does nothing)
    
    Returns:
    
    the distance attribute of a units of measure type element
  - getUnitsOfMeasureTime
```
public String getUnitsOfMeasureTime(Object uom)
```
    Parameters:
    
    uom - (does nothing)
    
    Returns:
    
    the time attribute of a units of measure type element
  - addAgendaGoalElement
```
public void addAgendaGoalElement(JAXBElement<?> element)
```
    Adds an Agenda Goal Element to the end of the goal list
    
    Parameters:
    
    element - element to add to the end of the element list
  - addAgendaGoalElement
```
public void addAgendaGoalElement(int index,
                                 JAXBElement<?> element)
```
    Inserts an Agenda Goal Element at the specified location of the command list, current Agenda Goal Element is shifted down. If specified position is less than zero, Agenda Goal Element is inserted at front. If specified position is past the end, Agenda Goal Element is added to end.
    
    Parameters:
    
    index - position in the Agenda Element list for the new Agenda Element
    
    element - element to be added at the specified location of the element list
  - addCommandElement
```
public void addCommandElement(JAXBElement<?> commandElement)
```
    Adds a command element to the end of the command list
    
    Parameters:
    
    commandElement - command to be added (JAXBElement<?> type to support all possible)
  - addCommandElement
```
public void addCommandElement(int index,
                              JAXBElement<?> commandElement)
```
    Inserts a command at the specified location of the command list, current element is shifted down. If specified position is less than zero, command is inserted at front. If specified position is past the end, command is added to end.
    
    Parameters:
    
    index - position in command list for new command, original and subsequent commands (if any) are moved to follow
    
    commandElement - command to be added (JAXBElement<?> type to support all possible)
  - replaceCommand
```
public void replaceCommand(int index,
                           JAXBElement<?> commandElement)
```
    Replaces a command at the specified location of the command list
    
    Parameters:
    
    index - position in command list for replacement command
    
    commandElement - command to replace an existing command (JAXBElement<?> type to support all possible)
  - getLength
```
public double getLength()
```
    TODO: Implement this
    
    Returns:
    
    the computed length of the mission (meters)
  - getMissionPreparationElement
```
public MissionPreparationElementType getMissionPreparationElement()
```
    Returns:
    
    the current mission preparation element
  - getCommandElementList
```
public List<JAXBElement<?>> getCommandElementList()
```
    Returns a reference to the script command elements list
    
    Returns:
    
    a List reference to the sequenced commands
  - getMunitionAimPosition
```
public MunitionAimPointElementType getMunitionAimPosition()
```
    Returns:
    
    MunitionAimPointElementType
  - getMunitionLaunchPosition
```
public MunitionLaunchPointElementType getMunitionLaunchPosition()
```
    Returns:
    
    MunitionLaunchPointElementType
  - setMunitionAimPosition
```
public void setMunitionAimPosition(MunitionAimPointElementType obj)
```
    Parameters:
    
    obj -
  - setMunitionLaunchPosition
```
public void setMunitionLaunchPosition(MunitionLaunchPointElementType obj)
```
    Parameters:
    
    obj -
  - getAgendaMissionElement
```
public AgendaMissionElementType getAgendaMissionElement()
```
    Returns the agenda mission element
    
    Returns:
    
    AgendaMissionElementType
  - getMunitionMissionElement
```
public GuidedMunitionMissionElementType getMunitionMissionElement()
```
    Returns the munition mission element
    
    Returns:
    
    AgendaMissionElementType
  - getAgendaLaunchPosition
```
public AbsoluteHorizontalPositionElementType getAgendaLaunchPosition()
```
    Returns a reference to the launch position element of an agenda mission
    
    Returns:
    
    reference to the launch position element of an agenda mission
  - setAgendaLaunchPosition
```
public void setAgendaLaunchPosition(AbsoluteHorizontalPositionElementType ahpt)
```
    Parameters:
    
    ahpt -
  - getAgendaRecoveryPosition
```
public AbsoluteHorizontalPositionElementType getAgendaRecoveryPosition()
```
    Returns a reference to the recovery position element of an agenda mission
    
    Returns:
    
    reference to the recovery position element of an agenda mission
  - setAgendaRecoveryPosition
```
public void setAgendaRecoveryPosition(AbsoluteHorizontalPositionElementType ahpt)
```
    Parameters:
    
    ahpt -
  - getAgendaGoals
```
public AgendaGoalListType getAgendaGoals()
```
    Returns a reference to the agenda mission goals
    
    Returns:
    
    Object reference to the element element
  - getAgendaGoalList
```
public List<AgendaGoalElementType> getAgendaGoalList()
```
    Returns a reference to the agenda mission goals
    
    Returns:
    
    Object reference to the element element
  - getAgendaConstraintList
```
public AgendaConstraintListType getAgendaConstraintList()
```
    Returns a reference to the strategic-level agenda mission goals
    
    Returns:
    
    AgendaConstraintListType object reference to the constraints element of the strategic-level agenda mission goals
  - getAgendaConstraintListAvoidAreas
```
public List<AreaElementType> getAgendaConstraintListAvoidAreas()
```
    Retrieve all agenda constraints
    
    Returns:
    
    list of all agenda constraints
  - getAgendaConstraintsIngressRouting
```
public RouteElementType getAgendaConstraintsIngressRouting()
```
    Returns:
    
    RouteElementType
  - getAgendaConstraintsEgressRouting
```
public RouteElementType getAgendaConstraintsEgressRouting()
```
    Returns:
    
    RouteElementType
  - getCommandListSize
```
public int getCommandListSize()
```
    Returns the number of commands in the script
    
    Returns:
    
    the number of commands in the script
  - getCommandElement
```
public JAXBElement<?> getCommandElement(int index)
```
    Returns the command at a specified location in the list. If specified position is less than zero or past the end, returns null
    
    Parameters:
    
    index - index to the command that is to be retrieved
    
    Returns:
    
    Object command retrieved from list
  - removeCommand
```
public Object removeCommand(int index)
```
    Removes the command at a specified location in the list. If specified position is less than zero or past the end, no action is taken
    
    Parameters:
    
    index - an index of the command that is to be removed
    
    Returns:
    
    the specified command removed from list
  - removeAgendaElement
```
public Object removeAgendaElement(int index)
```
    Removes an Agenda Goal at a specified location in the list. If specified position is less than zero or past the end, no action is taken
    
    Parameters:
    
    index - an index of the element that is to be removed
    
    Returns:
    
    element removed from list
  - copyCommandElement
```
public JAXBElement<?> copyCommandElement(int index)
```
    Retrieves a command at a specified location in the list. If specified position is less than zero or past the end, no action is taken
    
    Parameters:
    
    index - an index of the command that is to be copied
    
    Returns:
    
    command retrieved from list
  - getAgendaGoal
```
public AgendaGoalElementType getAgendaGoal(int index)
```
    Parameters:
    
    index - of goal in agendaGoalList
    
    Returns:
    
    AgendaGoalElementType
  - getAgendaAvoidArea
```
public AreaElementType getAgendaAvoidArea(int index)
```
    Parameters:
    
    index - of avoidance area in agendaConstraintList
    
    Returns:
    
    AreaElementType
  - addAgendaAvoidArea
```
public void addAgendaAvoidArea(AreaElementType obj)
```
  - addAgendaAvoidArea
```
public void addAgendaAvoidArea(int index,
                               AreaElementType avoidArea)
```
    Parameters:
    
    index - of new avoidance area to add to agendaConstraintList
    
    avoidArea - new AreaElementType AvoidArea element to add
  - addAgendaAvoidAreaElement
```
public void addAgendaAvoidAreaElement(int index,
                                      JAXBElement<?> element)
```
    Inserts an Agenda Goal Element at the specified location of the command list, current Agenda Goal Element is shifted down. If specified position is less than zero, Agenda Goal Element is inserted at front. If specified position is past the end, Agenda Goal Element is added to end.
    
    Parameters:
    
    index - position in the Agenda Element list for the new Agenda Element
    
    element - element to be added at the specified location of the element list
  - addAgendaGoal
```
public void addAgendaGoal(AgendaGoalElementType aget)
```
  - addAgendaGoal
```
public void addAgendaGoal(int index,
                          AgendaGoalElementType aget)
```
    Parameters:
    
    index - index of goal of interest
    
    aget - AgendaGoalElementType
  - addAgendaRecoveryPosition
```
public void addAgendaRecoveryPosition(Object obj)
```
    Sets the designated recovery position for an agenda mission
    
    Parameters:
    
    obj - recovery position
  - addAgendaLaunchPosition
```
public void addAgendaLaunchPosition(Object obj)
```
    Parameters:
    
    obj -
  - removeAgendaLaunchPosition
```
public void removeAgendaLaunchPosition()
```
    Deletes the agenda-specified launch position
  - removeAgendaRecoveryPosition
```
public void removeAgendaRecoveryPosition()
```
    Deletes the agenda-specified
  - removeAgendaGoal
```
public void removeAgendaGoal(int index)
```
    Remove an agenda goal from the mission
    
    Parameters:
    
    index - of AgendaGoalElementType goal to remove from list
  - removeAgendaAvoidArea
```
public void removeAgendaAvoidArea(int index)
```
    Remove an agenda avoidance area from the mission
    
    Parameters:
    
    index - of AreaElementType avoidance area to remove from list
  - removeMunitionElement
```
public void removeMunitionElement(int index)
```
    Parameters:
    
    index -
  - addMunitionLaunchPosition
```
public void addMunitionLaunchPosition(Object obj)
```
    Parameters:
    
    obj -
  - addMunitionAimPosition
```
public void addMunitionAimPosition(Object obj)
```
    Parameters:
    
    obj -
  - commandType
```
public int commandType(int index)
```
    Returns an integer enumeration for the type of command at a specified location in the list
    
    Parameters:
    
    index - in the command list of the command to identify
    
    Returns:
    
    UUV, UGV, USV or UAV but not MUNITION or AGENDA
  - getVehicleNameParameter
```
public String getVehicleNameParameter()
```
    Gets the vehicle name attribute
    
    Returns:
    
    the string name of the vehicle for this mission
  - getVehicleTypeParameter
```
public String getVehicleTypeParameter()
```
    Gets the vehicle type attribute
    
    Returns:
    
    the string name of the vehicle type for this mission: UUV, UGV, USV, UAV, MUNITION, or AGENDA
  - getVehicleIDParameter
```
public int getVehicleIDParameter()
```
    Sets the vehicle ID attribute
    
    Returns:
    
    a specific vehicle ID
  - setVehicleNameParameter
```
public void setVehicleNameParameter(String newName)
```
    Sets the vehicle name attribute
    
    Parameters:
    
    newName -
  - setVehicleIDParameter
```
public void setVehicleIDParameter(int id)
```
    Sets the vehicle ID attribute
    
    Parameters:
    
    id -
  - createHeadElement
```
public void createHeadElement()
```
    Generates a new head element and adds it to the mission
  - createMetaElement
```
public void createMetaElement(String name,
                              String content)
```
    Generates a new meta element and adds it to the mission head section
    
    Parameters:
    
    name - of the meta element
    
    content - of the meta element
  - clearMetaElements
```
public void clearMetaElements()
```
    Clears (deletes) all meta elements in the document head section
  - getMetaElementList
```
public List<MetaType> getMetaElementList()
```
    Returns:
    
    only existing metadata elements in the document head section
  - getMetaElementName
```
public static String getMetaElementName(JAXBElement<?> meta)
```
    Parameters:
    
    meta - tag for which the name attribute is being returned
    
    Returns:
    
    the name attribute value of the meta element in the document head section
  - getMetaElementContent
```
public static String getMetaElementContent(JAXBElement<?> meta)
```
    Parameters:
    
    meta - tag for which the content attribute is being returned
    
    Returns:
    
    the content attribute value of the meta element in the document head section
  - getMetaElementDescription
```
public static String getMetaElementDescription(JAXBElement<?> meta)
```
    Parameters:
    
    meta - tag for which the content attribute is being returned
    
    Returns:
    
    the description attribute value of the meta element in the document head section
  - createCurrentDateTimeGroupElement
```
public static DateTimeGroupElementType createCurrentDateTimeGroupElement(String description)
```
    Creates a date time group element corresponding to the current time
    
    Parameters:
    
    description - description
    
    Returns:
    
    a date time group element corresponding to the current time
  - setVehicleType
```
public void setVehicleType(String vehicleType)
```
    Sets the vehicle type attribute
    
    Parameters:
    
    vehicleType - vehicle type
  - createGeoOrigin
```
public void createGeoOrigin(double latitude,
                            double longitude,
                            double radius,
                            String description)
```
    Generates a new GeoOrigin element and assigns it to the mission
    
    Parameters:
    
    latitude - in the range of [-90, 90] with negative latitudes being in the southern hemisphere
    
    longitude - in the range of [-180, 180] with negative longitudes being in the western hemisphere
    
    radius - the radius around the origin with which the mission is concerned
    
    description - to be assigned to the GeoOrigin element
  - getGeoOrigin
```
public GeoOriginElementType getGeoOrigin()
```
    Returns:
    
    the current GeoOrigin object (or null)
  - getGeoOriginLatitude
```
public static double getGeoOriginLatitude(GeoOriginElementType go)
```
    Parameters:
    
    go - the GeoOrigin element whose latitude is to be determined
    
    Returns:
    
    the latitude portion of the GeoOrigin element
  - getGeoOriginLongitude
```
public static double getGeoOriginLongitude(GeoOriginElementType go)
```
    Parameters:
    
    go - the GeoOrigin element whose longitude is to be determined
    
    Returns:
    
    the latitude portion of the GeoOrigin element
  - getGeoOriginRadius
```
public static double getGeoOriginRadius(GeoOriginElementType go)
```
    Parameters:
    
    go - the GeoOrigin element whose radius is to be determined
    
    Returns:
    
    the radius portion of the GeoOrigin element
  - setGeoOriginLongitude
```
public void setGeoOriginLongitude(double newLongitude)
```
    Sets the longitude portion of the GeoOrigin element
    
    Parameters:
    
    newLongitude - the new longitude for the GeoOrigin
  - setMissionOffsetDelta
```
public void setMissionOffsetDelta(String northing,
                                  String easting)
```
    Set the mission area offset from a central geographical (Lat/Long) point
    
    Parameters:
    
    northing - the offset along the Z (GeoLocation) axis
    
    easting - the offset along the X (GeoLocation) axis
  - setGeoOriginLatitude
```
public void setGeoOriginLatitude(double newLatitude)
```
    Sets the latitude portion of the GeoOrigin element
    
    Parameters:
    
    newLatitude - the new latitude for the GeoOrigin
  - setGeoOriginRadius
```
public void setGeoOriginRadius(double newRadius)
```
    Sets the radius portion of the GeoOrigin element
    
    Parameters:
    
    newRadius - the new radius for the GeoOrigin
  - clearCommandList
```
public void clearCommandList()
```
    Clears (deletes) all commands from the command list
  - clearGeoOrigin
```
public void clearGeoOrigin()
```
    Clears the GeoOrigin element and deletes it without replacement
  - addSampledResult
```
public void addSampledResult(SampledResultsElementType newResult)
```
    Adds a sampled result element to the mission results section of the object
    
    Parameters:
    
    newResult - sampled result element to be added
  - createSampledResultElement
```
public static SampledResultsElementType createSampledResultElement(double time,
                                                                   String description)
```
    Parameters:
    
    time - SampledResult element timestamp
    
    description - description
    
    Returns:
    
    a SampledResult element
  - getSampledResultTime
```
public static double getSampledResultTime(SampledResultsElementType result)
```
    Parameters:
    
    result - the sampled result element object to be timestamped
    
    Returns:
    
    the timestamp of a sampled result element
  - getSampledResultDescription
```
public static String getSampledResultDescription(SampledResultsElementType result)
```
    Parameters:
    
    result - the sampled result element object to be timestamped
    
    Returns:
    
    the description of a sampled result element
  - setSampledResultTime
```
public static void setSampledResultTime(SampledResultsElementType result,
                                        double time)
```
    Sets the timestamp of a sampled result element
    
    Parameters:
    
    result - the sampled result element object to be timestamped
    
    time - value for the timestamp
  - setSampledResultDescription
```
public static void setSampledResultDescription(SampledResultsElementType result,
                                               String description)
```
    Sets the description of a sampled result element
    
    Parameters:
    
    result - the sampled result element object to be timestamped
    
    description - value for the description attribute
  - commandType
```
public static int commandType(Object command)
```
    Parameters:
    
    command - AVCL object being identified, either as JAXBElement or as an directly typed object
    
    Returns:
    
    an integer enumeration identifying the type of command contained in an Object
  - isPartialControlCommand
```
public static boolean isPartialControlCommand(JAXBElement<?> commandElement)
```
    Parameters:
    
    commandElement -
    
    Returns:
    
    true if the behavior controls one but not all control modes.
  - isTerminatingCommand
```
public static boolean isTerminatingCommand(JAXBElement<?> commandElement)
```
    Parameters:
    
    commandElement - AVCL command to be tested
    
    Returns:
    
    true if the behavior has defined termination criteria.
  - isPlottable
```
public static boolean isPlottable(int cmdType)
```
    Returns whether the command occupies a place on any of the visual displays
    
    Parameters:
    
    cmdType - an enumeration of a command type
    
    Returns:
    
    true = yes, has a position
  - getDescription
```
public static String getDescription(Object element)
```
    Parameters:
    
    element - the JAXBElement to parse
    
    Returns:
    
    the text description of this JAXBElement
  - setTimeStamp
```
public static void setTimeStamp(Object element,
                                double newValue)
```
    TimeStamp marshaling method
    
    Parameters:
    
    element - the JAXBElement node to set a timeStamp to
    
    newValue - the value of the timeStamp formatted to one decimal place
  - getTimeStamp
```
public static double getTimeStamp(Object element)
```
    Retrieve via introspection, the value of an element's timeStamp attribute
    
    Parameters:
    
    element - the JAXBElement element containing a timeStamp value
    
    Returns:
    
    the value of an element's timeStamp attribute
  - generateUgvConfigurationElement
```
public void generateUgvConfigurationElement()
```
    Generates a vehicle configuration element containing minimum unmanned ground vehicle configuration requirements to successfully execute the currently defined mission
  - generateUsvConfigurationElement
```
public void generateUsvConfigurationElement()
```
    Generates a vehicle configuration element containing minimum unmanned surface vehicle configuration requirements to successfully execute the currently defined mission
  - generateUavConfigurationElement
```
public void generateUavConfigurationElement()
```
    Generates a vehicle configuration element containing minimum unmanned ground vehicle configuration requirements to successfully execute the currently defined mission
  - generateMunitionConfigurationElement
```
public void generateMunitionConfigurationElement()
```
    Generates a vehicle configuration element containing minimum unmanned vehicle configuration requirements to successfully execute the currently defined mission
  - generateAgendaConfigurationElement
```
public void generateAgendaConfigurationElement()
```
    Generates a vehicle configuration element containing minimum unmanned vehicle configuration requirements to successfully execute the currently defined mission
  - createVehicleCharacteristicsElement
```
public static Object createVehicleCharacteristicsElement(int vehicleType)
```
    Creates a vehicle characteristics element element for the specified type of vehicle
    
    Parameters:
    
    vehicleType -
    
    Returns:
    
    a VehicleCharacteristicsElement from AVCL
  - generateEventLog
```
public void generateEventLog()
```
    Adds an EventLog element to the mission
  - clearEventLog
```
public void clearEventLog()
```
    Clears all items from the event log
  - logEvent
```
public void logEvent(Object event)
```
    Adds an event to the event log
    
    Parameters:
    
    event -
  - getVehicleNumCapabilities
```
public static int getVehicleNumCapabilities(Object charEl)
```
    Parameters:
    
    charEl -
    
    Returns:
    
    the number of capabilities listed for a the vehicle
  - getVehicleCapability
```
public static Object getVehicleCapability(Object charEl,
                                          int index)
```
    Parameters:
    
    charEl -
    
    index -
    
    Returns:
    
    the capability specified by the index
  - removeVehicleCapability
```
public static Object removeVehicleCapability(Object charEl,
                                             int index)
```
    Parameters:
    
    charEl -
    
    index -
    
    Returns:
    
    the capability specified by the index and removes it from the list
  - addVehicleCapability
```
public static void addVehicleCapability(Object charEl,
                                        String capability)
```
    Adds a capability to the vehicle's capability list
    
    Parameters:
    
    charEl -
    
    capability -
  - getMissionJaxb
```
public AVCL getMissionJaxb()
```
    Returns:
    
    the missionJaxb
  - setMissionJaxb
```
public void setMissionJaxb(AVCL missionJaxb)
```
    Parameters:
    
    missionJaxb - the missionJaxb to set
  - isValid
```
public boolean isValid()
```
    Returns:
    
    whether valid JAXB data
  - setValid
```
public void setValid(boolean valid)
```
    Parameters:
    
    valid - missionJaxb validity

Class AvclMission

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOVALUE

XYPOSITION

RELATIVEXYPOSITION

LATLONGPOSITION

DEPTHCONTROL

ALTITUDECONTROL

DEFAULTZCONTROL

MEANSEALEVELCONTROL

ABOVEGROUNDLEVELCONTROL

ABSOLUTE_TIMING

DURATION_TIMING

NUMBER_GOAL_TYPES

ATTACK

DECONTAMINATE

DEMOLISH

ILLUMINATE

JAM

MARK

MONITORTRANSMISSIONS

PATROL

RENDEZVOUS

REPOSITION

SAMPLEENVIRONMENT

SEARCH

GOAL_NAMES

DEPTH

ALTITUDE_ABV_BTM

ALTITUDE_MSL

ALTITUDE_AGL

DEPTH_BLK

DEPTH_ALTITUDE_ABV_BTM_BLK

ALTITUDE_ABV_BTM_BLK

ALTITUDE_AGL_BLK

ALTITUDE_MSL_BLK

ALTITUDE_AGL_MSL_BLK

POINT

CIRCLE

RECTANGLE

POLYGON

LIMITING_LINE

INGRESS_ROUTE

EGRESS_ROUTE

TARGETSCAN

EDGESCAN

FORWARDSCAN

MANUALSCAN

TRACKSCAN

GPSSTART

GPSINPROGRESS

GPSCOMPLETE

GPSFAIL

RELATIVEBEARING

TRUEBEARING

MAGNETICBEARING

ALLPROPELLERS

STBDPROPELLER

PORTPROPELLER

CENTERPROPELLER

KNOTS

METERSPERSECOND

LATERALTHRUSTERS

BOWLATERALTHRUSTER

STERNLATERALTHRUSTER

VERTICALTHRUSTERS

BOWVERTICALTHRUSTER

STERNVERTICALTHRUSTER

ALLPLANES

BOWPLANES

STERNPLANES

ALLTRACKS

LEFTTRACK

RIGHTTRACK

MSL

AGL