avcl

Class UavMissionResults

java.lang.Object

avcl.UavMissionResults

public class UavMissionResults
extends Object

Contains static utility functions to interface with JAXB-derived classes representing AVCL UAV mission results. This class is used to generate new instances of individual mission result elements and alter the values of existing commands. Public methods take Object parameters so that invoking objects can utilize them without any knowledge of the JAXB-derived classes. All direct manipulation of the JAXB-developed classes should be handled by this or other classes in this package.

Since:

June 13, 2005, 9:12 AM

Version:

$Id: UavMissionResults.java 8671 2012-12-16 04:35:02Z brutzman $

Author:

dtdavis

Constructor Summary

Constructors

Constructor and Description
UavMissionResults()

Method Summary

Methods

Modifier and Type	Method and Description
static ContactRecordElementType	createContactRecordEvent(int contactID, String name, int pType, double x, double y, double heading, double velocity, int vType, double v1, double v2, String description) Creates a GoalStatus loggable event element
static ContaminantRecordElementType	createContaminantRecordEvent(int contaminant, int pType, double x, double y, int vType, double v1, double v2, String description) Creates a Contaminant loggable event element
static UavControlOrdersElementType	createControlOrderElement(double eng1, double eng2, double rudder, double aileron, double elevator, String description) Creates a UAV Orders element with enine power, rudder, aileron, and elevator settings
static GoalStatusUpdateElementType	createGoalStatusEvent(Object goal, String status, String description) Creates a GoalStatus loggable event element
static FrequencyRecordElementType	createSignalOfInterestRecordEvent(double frequency, int units, String content, String description) Creates a SignalOfInterest loggable event element
static UavTelemetryElementType	createTelemetryElement(int positType, double x, double y, double mslAlt, double phi, double theta, double psi, double u, double v, double w, double p, double q, double r, String description) Creates a UAV Telemetry element with position, orientation, and body coordinate velocity
static VehicleStatusUpdateElementType	createVehicleStatusEvent(String system, String status, String description) Creates a VehicleStatus loggable event element
static String	getControlOrderElementDescription(Object order) Returns the description of a control order element
static UavLoggableEventType	getEventWithContent(Object content, double time) Creates a UAV event log object and sets the content
static double	getTelemetryElementAltitudeAGL(Object tel) Returns the Above Ground Level (AGL) altitude of a telemetry element
static double	getTelemetryElementAltitudeMSL(Object tel) Returns the Mean Sea Level (MSL) altitude of a telemetry element
static String	getTelemetryElementDescription(Object tel) Returns the description of a telemetry element
static double	getTelemetryElementPhiDot(Object tel) Returns the phiDot (roll rate) of the telemetry element
static double	getTelemetryElementPsiDot(Object tel) Returns the psiDot (yaw rate) of the telemetry element
static double	getTelemetryElementRemainingPower(Object tel) Returns the remaining power value of the telemetry element
static double	getTelemetryElementSOGU(Object tel) Returns the forward speed over ground of the telemetry element
static double	getTelemetryElementSOGV(Object tel) Returns the lateral speed over ground of the telemetry element
static double	getTelemetryElementSTAU(Object tel) Returns the forward speed through the air of the telemetry element
static double	getTelemetryElementSTAV(Object tel) Returns the lateral speed through the air of the telemetry element
static double	getTelemetryElementThetaDot(Object tel) Returns the thetaDot (pitch rate) of the telemetry element
static double	getTelemetryElementXDot(Object tel) Returns the xDot (world coordinate north-south speed) of the telemetry element
static double	getTelemetryElementYDot(Object tel) Returns the yDot (world coordinate east-west speed) of the telemetry element
static double	getTelemetryElementZDot(Object tel) Returns the zDot (world coordinate up-down speed) of the telemetry element
static void	setControlOrderElementAileron(Object order, double aileron) Sets the aileron portion of the control orders element
static void	setControlOrderElementDescription(Object order, String description) Sets the description of a orders element
static void	setControlOrderElementElevator(Object order, double elevator) Sets the elevator portion of the control orders element
static void	setControlOrderElementEngine(Object order, double e1, double e2) Sets the engine order element
static void	setControlOrderElementRudder(Object order, double rudder) Sets the rudder portion of the control orders element
static void	setSampledResultsControlOrder(Object results, Object orders) Sets the control orders element of a SampledResults element object
static void	setSampledResultsTelemetry(Object results, Object telemetry) Sets the telemetry element of a SampledResults element object
static void	setTelemetryElementAltitudeAGL(Object tel, double altitude) Sets the AGL altitude of a sampled result element
static void	setTelemetryElementAltitudeMSL(Object tel, double altitude) Sets the MSL altitude of a sampled result element
static void	setTelemetryElementDescription(Object tel, String description) Sets the description of a sampled result element
static void	setTelemetryElementDopplerVelocity(Object tel, double sogU, double sogV, double staU, double staV) Sets the world coordinate velocities of a telemetry element
static void	setTelemetryElementRemainingPower(Object tel, double power) Sets the remaining battery power value of a sampled result element
static void	setTelemetryElementWorldVelocity(Object tel, double xDot, double yDot, double zDot, double phiDot, double thetaDot, double psiDot) Sets the world coordinate velocities of a telemetry element

Methods inherited from class java.lang.Object

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

Constructor Detail

UavMissionResults

public UavMissionResults()

Method Detail

setSampledResultsTelemetry

public static void setSampledResultsTelemetry(Object results,
                              Object telemetry)

Sets the telemetry element of a SampledResults element object

Parameters:

results - sampled results element object

telemetry - telemetry object

setSampledResultsControlOrder

public static void setSampledResultsControlOrder(Object results,
                                 Object orders)

Sets the control orders element of a SampledResults element object

Parameters:

results - sampled results element object

orders - control orders element object

createTelemetryElement

public static UavTelemetryElementType createTelemetryElement(int positType,
                                             double x,
                                             double y,
                                             double mslAlt,
                                             double phi,
                                             double theta,
                                             double psi,
                                             double u,
                                             double v,
                                             double w,
                                             double p,
                                             double q,
                                             double r,
                                             String description)

Creates a UAV Telemetry element with position, orientation, and body coordinate velocity

Parameters:

positType - enumeration indicating latitude-longitude or X-Y position

x -

y -

mslAlt -

phi -

theta -

psi -

u -

v -

w -

p -

q -

r -

description -

Returns:

a UavTelemetryElementType

getTelemetryElementAltitudeMSL

public static double getTelemetryElementAltitudeMSL(Object tel)

Returns the Mean Sea Level (MSL) altitude of a telemetry element

Parameters:

tel - the telemetry element object

Returns:

double MSL altitude

getTelemetryElementAltitudeAGL

public static double getTelemetryElementAltitudeAGL(Object tel)

Returns the Above Ground Level (AGL) altitude of a telemetry element

Parameters:

tel - the telemetry element object

Returns:

double AGL altitude

getTelemetryElementXDot

public static double getTelemetryElementXDot(Object tel)

Returns the xDot (world coordinate north-south speed) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision xDot (world coordinate north-south speed)

getTelemetryElementYDot

public static double getTelemetryElementYDot(Object tel)

Returns the yDot (world coordinate east-west speed) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision yDot (world coordinate east-west speed)

getTelemetryElementZDot

public static double getTelemetryElementZDot(Object tel)

Returns the zDot (world coordinate up-down speed) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision zDot (world coordinate up-down speed)

getTelemetryElementPhiDot

public static double getTelemetryElementPhiDot(Object tel)

Returns the phiDot (roll rate) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision phiDot (roll rate)

getTelemetryElementThetaDot

public static double getTelemetryElementThetaDot(Object tel)

Returns the thetaDot (pitch rate) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision thetaDot (pitch rate)

getTelemetryElementPsiDot

public static double getTelemetryElementPsiDot(Object tel)

Returns the psiDot (yaw rate) of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision psiDot (yaw rate)

getTelemetryElementSOGU

public static double getTelemetryElementSOGU(Object tel)

Returns the forward speed over ground of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision Speed Over Ground, u-vector forward direction

getTelemetryElementSOGV

public static double getTelemetryElementSOGV(Object tel)

Returns the lateral speed over ground of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision Speed Over Ground, v-vector lateral direction

getTelemetryElementSTAU

public static double getTelemetryElementSTAU(Object tel)

Returns the forward speed through the air of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision Speed Through the Air, u-vector forward direction

getTelemetryElementSTAV

public static double getTelemetryElementSTAV(Object tel)

Returns the lateral speed through the air of the telemetry element

Parameters:

tel - the telemetry element object

Returns:

double-precision Speed Through the Air, v-vector lateral direction

getTelemetryElementRemainingPower

public static double getTelemetryElementRemainingPower(Object tel)

Returns the remaining power value of the telemetry element

Parameters:

tel - the telemetry element object whose remaining power value is returned

Returns:

double-precision remaining power

getTelemetryElementDescription

public static String getTelemetryElementDescription(Object tel)

Returns the description of a telemetry element

Parameters:

tel - the telemetry element object to be timestamped

Returns:

telemetry element description

setTelemetryElementWorldVelocity

public static void setTelemetryElementWorldVelocity(Object tel,
                                    double xDot,
                                    double yDot,
                                    double zDot,
                                    double phiDot,
                                    double thetaDot,
                                    double psiDot)

Sets the world coordinate velocities of a telemetry element

Parameters:

tel - the telemetry element object

xDot -

yDot -

zDot -

phiDot -

thetaDot -

psiDot -

setTelemetryElementDopplerVelocity

public static void setTelemetryElementDopplerVelocity(Object tel,
                                      double sogU,
                                      double sogV,
                                      double staU,
                                      double staV)

Sets the world coordinate velocities of a telemetry element

Parameters:

tel - the telemetry element object

sogU - forward speed over ground

sogV - lateral speed over ground

staU - forward speed through air

staV - lateral speed through air

setTelemetryElementAltitudeMSL

public static void setTelemetryElementAltitudeMSL(Object tel,
                                  double altitude)

Sets the MSL altitude of a sampled result element

Parameters:

tel - the telemetry element object

altitude - value for the altitude attribute

setTelemetryElementAltitudeAGL

public static void setTelemetryElementAltitudeAGL(Object tel,
                                  double altitude)

Sets the AGL altitude of a sampled result element

Parameters:

tel - the telemetry element object

altitude - value for the altitude attribute

setTelemetryElementRemainingPower

public static void setTelemetryElementRemainingPower(Object tel,
                                     double power)

Sets the remaining battery power value of a sampled result element

Parameters:

tel - the telemetry element object

power - capacity value 0-100%

setTelemetryElementDescription

public static void setTelemetryElementDescription(Object tel,
                                  String description)

Sets the description of a sampled result element

Parameters:

tel - the telemetry element object to be timestamped

description - value for the description attribute

createControlOrderElement

public static UavControlOrdersElementType createControlOrderElement(double eng1,
                                                    double eng2,
                                                    double rudder,
                                                    double aileron,
                                                    double elevator,
                                                    String description)

Creates a UAV Orders element with enine power, rudder, aileron, and elevator settings

Parameters:

eng1 - commanded engine 1 setting

eng2 - commanded engine 2 setting

rudder - commanded rudder setting

aileron - commanded aileron setting

elevator - commanded elevator setting

description -

Returns:

UavControlOrdersElementType

getControlOrderElementDescription

public static String getControlOrderElementDescription(Object order)

Returns the description of a control order element

Parameters:

order - the control order element object to be timestamped

Returns:

description string

setControlOrderElementEngine

public static void setControlOrderElementEngine(Object order,
                                double e1,
                                double e2)

Sets the engine order element

Parameters:

order - control order element

e1 - engine 1 power setting

e2 - engine 2 power setting

setControlOrderElementRudder

public static void setControlOrderElementRudder(Object order,
                                double rudder)

Sets the rudder portion of the control orders element

Parameters:

order - control order element

rudder - commanded rudder deflection

setControlOrderElementAileron

public static void setControlOrderElementAileron(Object order,
                                 double aileron)

Sets the aileron portion of the control orders element

Parameters:

order - control order element

aileron - commanded rudder deflection

setControlOrderElementElevator

public static void setControlOrderElementElevator(Object order,
                                  double elevator)

Sets the elevator portion of the control orders element

Parameters:

order - control order element

elevator - commanded rudder deflection

setControlOrderElementDescription

public static void setControlOrderElementDescription(Object order,
                                     String description)

Sets the description of a orders element

Parameters:

order - the order element object to be timestamped

description - value for the description attribute

getEventWithContent

public static UavLoggableEventType getEventWithContent(Object content,
                                       double time)

Creates a UAV event log object and sets the content

Parameters:

content - is the event Object

time - of event

Returns:

UavLoggableEventType

createGoalStatusEvent

public static GoalStatusUpdateElementType createGoalStatusEvent(Object goal,
                                                String status,
                                                String description)

Creates a GoalStatus loggable event element

Parameters:

goal -

status -

description -

Returns:

GoalStatusUpdateElementType

createVehicleStatusEvent

public static VehicleStatusUpdateElementType createVehicleStatusEvent(String system,
                                                      String status,
                                                      String description)

Creates a VehicleStatus loggable event element

Parameters:

system -

status -

description -

Returns:

VehicleStatusUpdateElementType

createSignalOfInterestRecordEvent

public static FrequencyRecordElementType createSignalOfInterestRecordEvent(double frequency,
                                                           int units,
                                                           String content,
                                                           String description)

Creates a SignalOfInterest loggable event element

Parameters:

frequency -

units -

content -

description -

Returns:

FrequencyRecordElementType

createContactRecordEvent

public static ContactRecordElementType createContactRecordEvent(int contactID,
                                                String name,
                                                int pType,
                                                double x,
                                                double y,
                                                double heading,
                                                double velocity,
                                                int vType,
                                                double v1,
                                                double v2,
                                                String description)

Creates a GoalStatus loggable event element

Parameters:

contactID -

name -

velocity -

pType -

heading -

x -

y -

v1 -

vType -

description -

v2 -

Returns:

ContactRecordElementType

createContaminantRecordEvent

public static ContaminantRecordElementType createContaminantRecordEvent(int contaminant,
                                                        int pType,
                                                        double x,
                                                        double y,
                                                        int vType,
                                                        double v1,
                                                        double v2,
                                                        String description)

Creates a Contaminant loggable event element

Parameters:

contaminant -

pType -

v2 -

x -

y -

vType -

v1 -

description -

Returns:

ContaminantRecordElementType