MissionResultsElements (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.MissionResultsElements

public class MissionResultsElements
extends Object

Author:: dtdavis

Constructor Summary

Constructors
Constructor and Description

MissionResultsElements()

Constructors
Constructor and Description
`MissionResultsElements()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addMissionResultsSampledResult(Object results, Object sample)` Adds a sampled results element to the results element
`static void`	`addMissionResultsSampledResult(Object results, Object sample, int index)` Adds a sampled results element to the results element
`static Object`	`createControlOrderElement(int vehicleType, String description)` Creates an empty control order element
`static EventLogElementType`	`createEventLogElement(String description)` Creates an event log element
`static Object`	`createLogableEventElement(Object event, int vehicleType, double time)` Creates a loggable event element
`static MissionResultsElementType`	`createMissionResultsElement(String description)` Creates a mission results element
`static SampledResultsElementType`	`createSampledResultElement(String description)` Creates a sampled results element
`static Object`	`createTelemetryElement(int vehicleType, String description)` Creates an empty telemetry element
`static double`	`getBodyCoordinateVelocityP(Object velocity)` Returns the p (roll velocity)
`static double`	`getBodyCoordinateVelocityQ(Object velocity)` Returns the q (pitch velocity)
`static double`	`getBodyCoordinateVelocityR(Object velocity)` Returns the r (yaw velocity)
`static double`	`getBodyCoordinateVelocityU(Object velocity)` Returns the u (forward velocity)
`static double`	`getBodyCoordinateVelocityV(Object velocity)` Returns the v (lateral velocity)
`static double`	`getBodyCoordinateVelocityW(Object velocity)` Returns the w (vertical velocity)
`static double`	`getDopplerVelocitySOGU(Object velocity)` Returns the forward speed over the ground
`static double`	`getDopplerVelocitySOGV(Object velocity)` Returns the lateral speed over the ground
`static double`	`getDopplerVelocitySTMU(Object velocity)` Returns the forward speed through the medium (water or air)
`static double`	`getDopplerVelocitySTMV(Object velocity)` Returns the lateral speed through the medium (water or air)
`static String`	`getEventLogElementDescription(Object log)` Returns the description attribute of the event log element
`static String`	`getMissionResultsDescription(Object results)` Returns the description attribute of the mission results element
`static SampledResultsElementType`	`getMissionResultsSampledResult(Object results, int index)` Returns the sampled result specified by the index
`static int`	`getMissionResultsSampledResultIndex(Object results, Object sample)` Returns the index of a specific sampled results object
`static double`	`getOrientationElementPhi(Object posture)` Returns the value of phi (roll)
`static double`	`getOrientationElementPsi(Object posture)` Returns the value of psi (yaw)
`static double`	`getOrientationElementTheta(Object posture)` Returns the value of theta (pitch)
`static Object`	`getSampledResultControlOrder(Object sample)` Returns the control order element (if present) of the sampled results element
`static int`	`getSampledResultControlOrderType(Object sample)` Returns the telemetry element (if present) of the sampled results element
`static String`	`getSampledResultsDescription(Object sample)` Returns the description attribute of the sampled results element
`static Object`	`getSampledResultTelemetry(Object sample)` Returns the telemetry element (if present) of the sampled results element
`static int`	`getSampledResultTelemetryType(Object sample)` Returns the telemetry element (if present) of the sampled results element
`static Object`	`getTelemetryElementBodyCoordinateVelocity(Object newTelemetry)` Returns the body coordinate velocity element of the telemetry
`static String`	`getTelemetryElementDescription(Object newTelemetry)` Returns the description attribute of the telemetry element
`static Object`	`getTelemetryElementDopplerVelocity(Object newTelemetry)` Returns the world coordinate velocity element of the telemetry
`static Object`	`getTelemetryElementGeography(Object newTelemetry)` Returns the geographic position element of the telemetry
`static Object`	`getTelemetryElementOrientation(Object newTelemetry)` Returns the orientation element of the telemetry
`static int`	`getTelemetryElementVehicleType(Object newTelemetry)` Returns an enumeration for the type of vehicle the telemetry element pertains to
`static Object`	`getTelemetryElementVertical(Object newTelemetry)` Returns the vertical position element of the telemetry
`static Object`	`getTelemetryElementWorldCoordinateVelocity(Object newTelemetry)` Returns the world coordinate velocity element of the telemetry
`static double`	`getTelemetryVerticalElementValue1(Object newVerticalPositionElement)` Returns the first vertical value of the vertical position element
`static double`	`getTelemetryVerticalElementValue2(Object newVerticalPositionElement)` Returns the second vertical value of the vertical position element
`static JAXBElement<?>`	`getUavLoggableEventType(Object event)`
`static JAXBElement<?>`	`getUgvLoggableEventType(Object event)`
`static JAXBElement<?>`	`getUsvLoggableEventType(Object event)`
`static JAXBElement<?>`	`getUuvLoggableEventType(Object event)`
`static double`	`getWorldCoordinateVelocityPhiDot(Object velocity)` Returns the phi-dot (roll velocity)
`static double`	`getWorldCoordinateVelocityPsiDot(Object velocity)` Returns the psi-dot (yaw velocity)
`static double`	`getWorldCoordinateVelocityThetaDot(Object velocity)` Returns the theta-dot (pitch velocity)
`static double`	`getWorldCoordinateVelocityXDot(Object velocity)` Returns the x-dot (forward velocity)
`static double`	`getWorldCoordinateVelocityYDot(Object velocity)` Returns the y-dot (lateral velocity)
`static double`	`getWorldCoordinateVelocityZDot(Object velocity)` Returns the z-dot (vertical velocity)
`static void`	`logMissionEvent(Object log, Object newEvent, int vehicleType, double time)` Repeats a mission script element in the telemetry file to allow playback
`static void`	`removeMissionResultsSampledResult(Object results, int index)` Removes a sampled results element from the results element
`static void`	`removeMissionResultsSampledResult(Object results, Object sample)` Removes a sampled results element from the results element
`static void`	`setControlOrderElementDescription(Object newOrder, String description)` Sets the description attribute of a ControlOrder element
`static void`	`setEventLogElementDescription(Object log, String description)` Sets the description attribute of the event log element
`static void`	`setMissionResultsDescription(Object results, String description)` Sets the description attribute of the mission results element
`static void`	`setSampledResultControlOrders(Object sample, Object telemetry)` Sets the sampled results control order as appropriate
`static void`	`setSampledResultDescription(Object sample, String description)` Sets the description attribute of the sampled results element
`static void`	`setSampledResultTelemetry(Object sample, Object telemetry)` Sets the sampled results telemetry as appropriate
`static void`	`setTelemetryElementBodyVelocity(Object newTelemetry, double u, double v, double w, double p, double q, double r)` Sets the telemetry element body coordinate velocity element
`static void`	`setTelemetryElementDescription(Object newTelemetry, String description)` Sets the description attribute of a telemetry element
`static void`	`setTelemetryElementDopplerVelocity(Object newTelemetry, double sogU, double sogV, double stmU, double stmV)` Sets the telemetry element doppler velocity element
`static void`	`setTelemetryElementGeography(Object newTelemetry, int positType, double x, double y)` Sets the telemetry element geographic position element
`static void`	`setTelemetryElementOrientation(Object newTelemetry, double phi, double theta, double psi)` Sets the telemetry element orientation element
`static void`	`setTelemetryElementVertical(Object newTelemetry, double vert1, double vert2)` Sets the vertical position element of the telemetry
`static void`	`setTelemetryElementWorldVelocity(Object newTelemetry, double xDot, double yDot, double zDot, double phiDot, double thetaDot, double psiDot)` Sets the telemetry element world coordinate velocity element

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

- Constructor Detail
  - MissionResultsElements
```
public MissionResultsElements()
```
- Method Detail
  - createMissionResultsElement
```
public static MissionResultsElementType createMissionResultsElement(String description)
```
    Creates a mission results element
    
    Parameters:
    
    description -
    
    Returns:
    
    a mission results element
  - getMissionResultsSampledResult
```
public static SampledResultsElementType getMissionResultsSampledResult(Object results,
                                                                       int index)
```
    Returns the sampled result specified by the index
    
    Parameters:
    
    results -
    
    index -
    
    Returns:
    
    the sampled result specified by the index
  - getMissionResultsSampledResultIndex
```
public static int getMissionResultsSampledResultIndex(Object results,
                                                      Object sample)
```
    Returns the index of a specific sampled results object
    
    Parameters:
    
    results -
    
    sample -
    
    Returns:
    
    the index of a specific sampled results object
  - getMissionResultsDescription
```
public static String getMissionResultsDescription(Object results)
```
    Returns the description attribute of the mission results element
    
    Parameters:
    
    results -
    
    Returns:
    
    the description attribute of the mission results element
  - setMissionResultsDescription
```
public static void setMissionResultsDescription(Object results,
                                                String description)
```
    Sets the description attribute of the mission results element
    
    Parameters:
    
    results -
    
    description -
  - addMissionResultsSampledResult
```
public static void addMissionResultsSampledResult(Object results,
                                                  Object sample)
```
    Adds a sampled results element to the results element
    
    Parameters:
    
    results -
    
    sample -
  - addMissionResultsSampledResult
```
public static void addMissionResultsSampledResult(Object results,
                                                  Object sample,
                                                  int index)
```
    Adds a sampled results element to the results element
    
    Parameters:
    
    results -
    
    sample -
    
    index -
  - removeMissionResultsSampledResult
```
public static void removeMissionResultsSampledResult(Object results,
                                                     int index)
```
    Removes a sampled results element from the results element
    
    Parameters:
    
    results -
    
    index -
  - removeMissionResultsSampledResult
```
public static void removeMissionResultsSampledResult(Object results,
                                                     Object sample)
```
    Removes a sampled results element from the results element
    
    Parameters:
    
    results -
    
    sample -
  - createSampledResultElement
```
public static SampledResultsElementType createSampledResultElement(String description)
```
    Creates a sampled results element
    
    Parameters:
    
    description -
    
    Returns:
    
    a sampled results element
  - getSampledResultTelemetry
```
public static Object getSampledResultTelemetry(Object sample)
```
    Returns the telemetry element (if present) of the sampled results element
    
    Parameters:
    
    sample -
    
    Returns:
    
    the telemetry element (if present) of the sampled results element
  - getSampledResultTelemetryType
```
public static int getSampledResultTelemetryType(Object sample)
```
    Returns the telemetry element (if present) of the sampled results element
    
    Parameters:
    
    sample -
    
    Returns:
    
    the telemetry element (if present) of the sampled results element
  - getSampledResultControlOrder
```
public static Object getSampledResultControlOrder(Object sample)
```
    Returns the control order element (if present) of the sampled results element
    
    Parameters:
    
    sample -
    
    Returns:
    
    the control order element (if present) of the sampled results element
  - getSampledResultControlOrderType
```
public static int getSampledResultControlOrderType(Object sample)
```
    Returns the telemetry element (if present) of the sampled results element
    
    Parameters:
    
    sample -
    
    Returns:
    
    the telemetry element (if present) of the sampled results element
  - getSampledResultsDescription
```
public static String getSampledResultsDescription(Object sample)
```
    Returns the description attribute of the sampled results element
    
    Parameters:
    
    sample -
    
    Returns:
    
    the description attribute of the sampled results element
  - setSampledResultTelemetry
```
public static void setSampledResultTelemetry(Object sample,
                                             Object telemetry)
```
    Sets the sampled results telemetry as appropriate
    
    Parameters:
    
    sample -
    
    telemetry -
  - setSampledResultControlOrders
```
public static void setSampledResultControlOrders(Object sample,
                                                 Object telemetry)
```
    Sets the sampled results control order as appropriate
    
    Parameters:
    
    sample -
    
    telemetry -
  - setSampledResultDescription
```
public static void setSampledResultDescription(Object sample,
                                               String description)
```
    Sets the description attribute of the sampled results element
    
    Parameters:
    
    sample -
    
    description -
  - createTelemetryElement
```
public static Object createTelemetryElement(int vehicleType,
                                            String description)
```
    Creates an empty telemetry element
    
    Parameters:
    
    vehicleType - integer enumeration for the type of vehicle
    
    description -
    
    Returns:
    
    an empty telemetry element
  - getTelemetryElementVehicleType
```
public static int getTelemetryElementVehicleType(Object newTelemetry)
```
    Returns an enumeration for the type of vehicle the telemetry element pertains to
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    an enumeration for the type of vehicle the telemetry element pertains to. AvclMission.UAV, AvclMission.UGV, AvclMission.USV, AvclMission.UUV, AvclMission.NOVALUE,
  - getTelemetryElementGeography
```
public static Object getTelemetryElementGeography(Object newTelemetry)
```
    Returns the geographic position element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the geographic position element of the telemetry
  - getTelemetryElementVertical
```
public static Object getTelemetryElementVertical(Object newTelemetry)
```
    Returns the vertical position element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the vertical position element of the telemetry
  - getTelemetryElementOrientation
```
public static Object getTelemetryElementOrientation(Object newTelemetry)
```
    Returns the orientation element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the orientation element of the telemetry
  - getTelemetryElementBodyCoordinateVelocity
```
public static Object getTelemetryElementBodyCoordinateVelocity(Object newTelemetry)
```
    Returns the body coordinate velocity element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the body coordinate velocity element of the telemetry
  - getTelemetryElementWorldCoordinateVelocity
```
public static Object getTelemetryElementWorldCoordinateVelocity(Object newTelemetry)
```
    Returns the world coordinate velocity element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the world coordinate velocity element of the telemetry
  - getTelemetryElementDopplerVelocity
```
public static Object getTelemetryElementDopplerVelocity(Object newTelemetry)
```
    Returns the world coordinate velocity element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    DopplerVelocityElementType
  - getTelemetryElementDescription
```
public static String getTelemetryElementDescription(Object newTelemetry)
```
    Returns the description attribute of the telemetry element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    Returns:
    
    the description attribute of the telemetry element
  - setTelemetryElementGeography
```
public static void setTelemetryElementGeography(Object newTelemetry,
                                                int positType,
                                                double x,
                                                double y)
```
    Sets the telemetry element geographic position element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    positType -
    
    x -
    
    y -
  - setTelemetryElementVertical
```
public static void setTelemetryElementVertical(Object newTelemetry,
                                               double vert1,
                                               double vert2)
```
    Sets the vertical position element of the telemetry
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    vert2 -
    
    vert1 -
  - setTelemetryElementOrientation
```
public static void setTelemetryElementOrientation(Object newTelemetry,
                                                  double phi,
                                                  double theta,
                                                  double psi)
```
    Sets the telemetry element orientation element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    psi -
    
    theta -
    
    phi -
  - setTelemetryElementBodyVelocity
```
public static void setTelemetryElementBodyVelocity(Object newTelemetry,
                                                   double u,
                                                   double v,
                                                   double w,
                                                   double p,
                                                   double q,
                                                   double r)
```
    Sets the telemetry element body coordinate velocity element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    r -
    
    u -
    
    v -
    
    p -
    
    w -
    
    q -
  - setTelemetryElementWorldVelocity
```
public static void setTelemetryElementWorldVelocity(Object newTelemetry,
                                                    double xDot,
                                                    double yDot,
                                                    double zDot,
                                                    double phiDot,
                                                    double thetaDot,
                                                    double psiDot)
```
    Sets the telemetry element world coordinate velocity element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    xDot -
    
    thetaDot -
    
    psiDot -
    
    zDot -
    
    yDot -
    
    phiDot -
  - setTelemetryElementDopplerVelocity
```
public static void setTelemetryElementDopplerVelocity(Object newTelemetry,
                                                      double sogU,
                                                      double sogV,
                                                      double stmU,
                                                      double stmV)
```
    Sets the telemetry element doppler velocity element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    sogU -
    
    sogV -
    
    stmV -
    
    stmU -
  - setTelemetryElementDescription
```
public static void setTelemetryElementDescription(Object newTelemetry,
                                                  String description)
```
    Sets the description attribute of a telemetry element
    
    Parameters:
    
    newTelemetry - UavTelemetryElementType, UgvTelemetryElementType, UsvTelemetryElementType, UuvTelemetryElementType
    
    description -
  - createControlOrderElement
```
public static Object createControlOrderElement(int vehicleType,
                                               String description)
```
    Creates an empty control order element
    
    Parameters:
    
    vehicleType - integer enumeration for the type of vehicle: AvclMission.UUV, AvclMission.UGV, AvclMission.USV or AvclMission.UAV
    
    description -
    
    Returns:
    
    an empty control order element
  - setControlOrderElementDescription
```
public static void setControlOrderElementDescription(Object newOrder,
                                                     String description)
```
    Sets the description attribute of a ControlOrder element
    
    Parameters:
    
    newOrder -
    
    description -
  - getTelemetryVerticalElementValue1
```
public static double getTelemetryVerticalElementValue1(Object newVerticalPositionElement)
```
    Returns the first vertical value of the vertical position element
    
    Parameters:
    
    newVerticalPositionElement -
    
    Returns:
    
    the first vertical value of the vertical position element
  - getTelemetryVerticalElementValue2
```
public static double getTelemetryVerticalElementValue2(Object newVerticalPositionElement)
```
    Returns the second vertical value of the vertical position element
    
    Parameters:
    
    newVerticalPositionElement -
    
    Returns:
    
    altitude value
  - getOrientationElementPhi
```
public static double getOrientationElementPhi(Object posture)
```
    Returns the value of phi (roll)
    
    Parameters:
    
    posture -
    
    Returns:
    
    the value of phi (roll)
  - getOrientationElementTheta
```
public static double getOrientationElementTheta(Object posture)
```
    Returns the value of theta (pitch)
    
    Parameters:
    
    posture -
    
    Returns:
    
    the value of theta (pitch)
  - getOrientationElementPsi
```
public static double getOrientationElementPsi(Object posture)
```
    Returns the value of psi (yaw)
    
    Parameters:
    
    posture -
    
    Returns:
    
    the value of psi (yaw)
  - getBodyCoordinateVelocityU
```
public static double getBodyCoordinateVelocityU(Object velocity)
```
    Returns the u (forward velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the u (forward velocity)
  - getBodyCoordinateVelocityV
```
public static double getBodyCoordinateVelocityV(Object velocity)
```
    Returns the v (lateral velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the v (lateral velocity)
  - getBodyCoordinateVelocityW
```
public static double getBodyCoordinateVelocityW(Object velocity)
```
    Returns the w (vertical velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the w (vertical velocity)
  - getBodyCoordinateVelocityP
```
public static double getBodyCoordinateVelocityP(Object velocity)
```
    Returns the p (roll velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the p (roll velocity)
  - getBodyCoordinateVelocityQ
```
public static double getBodyCoordinateVelocityQ(Object velocity)
```
    Returns the q (pitch velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the q (pitch velocity)
  - getBodyCoordinateVelocityR
```
public static double getBodyCoordinateVelocityR(Object velocity)
```
    Returns the r (yaw velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the r (yaw velocity)
  - getWorldCoordinateVelocityXDot
```
public static double getWorldCoordinateVelocityXDot(Object velocity)
```
    Returns the x-dot (forward velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the x-dot (forward velocity)
  - getWorldCoordinateVelocityYDot
```
public static double getWorldCoordinateVelocityYDot(Object velocity)
```
    Returns the y-dot (lateral velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the y-dot (lateral velocity)
  - getWorldCoordinateVelocityZDot
```
public static double getWorldCoordinateVelocityZDot(Object velocity)
```
    Returns the z-dot (vertical velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the z-dot (vertical velocity)
  - getWorldCoordinateVelocityPhiDot
```
public static double getWorldCoordinateVelocityPhiDot(Object velocity)
```
    Returns the phi-dot (roll velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the phi-dot (roll velocity)
  - getWorldCoordinateVelocityThetaDot
```
public static double getWorldCoordinateVelocityThetaDot(Object velocity)
```
    Returns the theta-dot (pitch velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the theta-dot (pitch velocity)
  - getWorldCoordinateVelocityPsiDot
```
public static double getWorldCoordinateVelocityPsiDot(Object velocity)
```
    Returns the psi-dot (yaw velocity)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    the psi-dot (yaw velocity)
  - getDopplerVelocitySOGU
```
public static double getDopplerVelocitySOGU(Object velocity)
```
    Returns the forward speed over the ground
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    forward speed over the ground
  - getDopplerVelocitySOGV
```
public static double getDopplerVelocitySOGV(Object velocity)
```
    Returns the lateral speed over the ground
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    lateral speed over the ground
  - getDopplerVelocitySTMU
```
public static double getDopplerVelocitySTMU(Object velocity)
```
    Returns the forward speed through the medium (water or air)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    forward speed through the medium (water or air)
  - getDopplerVelocitySTMV
```
public static double getDopplerVelocitySTMV(Object velocity)
```
    Returns the lateral speed through the medium (water or air)
    
    Parameters:
    
    velocity - Vehicle velocity vector
    
    Returns:
    
    lateral speed through the medium (water or air)
  - createEventLogElement
```
public static EventLogElementType createEventLogElement(String description)
```
    Creates an event log element
    
    Parameters:
    
    description -
    
    Returns:
    
    an event log element
  - getEventLogElementDescription
```
public static String getEventLogElementDescription(Object log)
```
    Returns the description attribute of the event log element
    
    Parameters:
    
    log -
    
    Returns:
    
    the description attribute of the event log element
  - setEventLogElementDescription
```
public static void setEventLogElementDescription(Object log,
                                                 String description)
```
    Sets the description attribute of the event log element
    
    Parameters:
    
    log -
    
    description -
  - createLogableEventElement
```
public static Object createLogableEventElement(Object event,
                                               int vehicleType,
                                               double time)
```
    Creates a loggable event element
    
    Parameters:
    
    event -
    
    time -
    
    vehicleType -
    
    Returns:
    
    a loggable event element
  - logMissionEvent
```
public static void logMissionEvent(Object log,
                                   Object newEvent,
                                   int vehicleType,
                                   double time)
```
    Repeats a mission script element in the telemetry file to allow playback
    
    Parameters:
    
    log - the wrapper shell of the mission script to log
    
    time - the simulation time of the event
    
    newEvent - the original mission script to log
    
    vehicleType - the type vehicle running a mission
  - getUuvLoggableEventType
```
public static JAXBElement<?> getUuvLoggableEventType(Object event)
```
    Parameters:
    
    event - the event to parse for relationship to a UuvLoggableEventType
    
    Returns:
    
    a JAXBElement<UuvLoggableEventType> created from a parsed object of that type
  - getUavLoggableEventType
```
public static JAXBElement<?> getUavLoggableEventType(Object event)
```
    Parameters:
    
    event - the event to parse for relationship to a UavLoggableEventType
    
    Returns:
    
    a JAXBElement<UavLoggableEventType> created from a parsed object of that type
  - getUsvLoggableEventType
```
public static JAXBElement<?> getUsvLoggableEventType(Object event)
```
    Parameters:
    
    event - the event to parse for relationship to a UsvLoggableEventType
    
    Returns:
    
    a JAXBElement<UsvLoggableEventType> created from a parsed object of that type
  - getUgvLoggableEventType
```
public static JAXBElement<?> getUgvLoggableEventType(Object event)
```
    Parameters:
    
    event - the event to parse for relationship to a UgvLoggableEventType
    
    Returns:
    
    a JAXBElement<UgvLoggableEventType> created from a parsed object of that type

Class MissionResultsElements

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MissionResultsElements

Method Detail

createMissionResultsElement

getMissionResultsSampledResult

getMissionResultsSampledResultIndex

getMissionResultsDescription

setMissionResultsDescription

addMissionResultsSampledResult

addMissionResultsSampledResult

removeMissionResultsSampledResult

removeMissionResultsSampledResult

createSampledResultElement

getSampledResultTelemetry

getSampledResultTelemetryType

getSampledResultControlOrder

getSampledResultControlOrderType

getSampledResultsDescription

setSampledResultTelemetry

setSampledResultControlOrders

setSampledResultDescription

createTelemetryElement

getTelemetryElementVehicleType

getTelemetryElementGeography

getTelemetryElementVertical

getTelemetryElementOrientation

getTelemetryElementBodyCoordinateVelocity

getTelemetryElementWorldCoordinateVelocity

getTelemetryElementDopplerVelocity

getTelemetryElementDescription

setTelemetryElementGeography

setTelemetryElementVertical

setTelemetryElementOrientation

setTelemetryElementBodyVelocity

setTelemetryElementWorldVelocity

setTelemetryElementDopplerVelocity

setTelemetryElementDescription

createControlOrderElement

setControlOrderElementDescription

getTelemetryVerticalElementValue1

getTelemetryVerticalElementValue2

getOrientationElementPhi

getOrientationElementTheta

getOrientationElementPsi

getBodyCoordinateVelocityU

getBodyCoordinateVelocityV

getBodyCoordinateVelocityW

getBodyCoordinateVelocityP

getBodyCoordinateVelocityQ

getBodyCoordinateVelocityR

getWorldCoordinateVelocityXDot

getWorldCoordinateVelocityYDot

getWorldCoordinateVelocityZDot

getWorldCoordinateVelocityPhiDot

getWorldCoordinateVelocityThetaDot

getWorldCoordinateVelocityPsiDot

getDopplerVelocitySOGU

getDopplerVelocitySOGV

getDopplerVelocitySTMU

getDopplerVelocitySTMV

createEventLogElement

getEventLogElementDescription

setEventLogElementDescription

createLogableEventElement

logMissionEvent

getUuvLoggableEventType

getUavLoggableEventType

getUsvLoggableEventType

getUgvLoggableEventType