execution.mission

Class AvclMissionResults

java.lang.Object

execution.mission.AvclMissionResults

Direct Known Subclasses:

MunitionAvclMissionResults, UavAvclMissionResults, UgvAvclMissionResults, UsvAvclMissionResults, UuvAvclMissionResults

public abstract class AvclMissionResults
extends Object

Opens a text file for output of XML telemetry, command, and orders elements. A telemetry and orders element will be written each cycle. A command element is written each time a new command is parsed. The XML header and root element are generated by the class constructor. The end tag for the root element is generated by the closeDataFile method

Since:

21 April 2004

Version:

$Id: AvclMissionResults.java 8634 2012-12-02 21:40:33Z brutzman $ Description: Creates and maintains an XML (AVCL) mission results file for a single mission. Abstract class must be extended to implement vehicle-type-specific results. Code adapted from version written for previous java-based AUV execution code originally authored by Miguel Ayala

Author:

Duane Davis

Field Summary

Fields

Modifier and Type	Field and Description
protected String	avclTelemetryFileName name of output XML file
protected boolean	eventLogged set to true if an event has been logged in the current timestep
protected PrintWriter	fileOut writer to output file
protected Object	logElement JAXB object for maintaining mission log (commands) information
protected boolean	metricDistances
protected Document	newResultsDomDocument XML mission results (telemetry, orders, etc.)
protected Element	ordersElement Dom element for maintaining control order information
protected boolean	radianAngles
protected Element	sensorData DOM Element for sensorData
protected Element	telemetryElement DOM element for maintaining telemetry information
protected Execution	vehicle reference to vehicle object to which this mission applies
protected Element	weaponData DOM Element for weapons data

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AvclMissionResults(Execution execution, Mission msnObject) Creates a new instance of AvclMissionResults

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeDataFile() Adds the end tag and closes the data output file
protected void	endRecordTag() Manually inserts the DiscreteResults end tag
protected String	getOutputFilePath()
protected void	logMissionEvent(Object event) Repeats a mission script element in the telemetry file to allow playback
protected boolean	readyToWriteData() This will be called every time-slice.
void	setMission(AvclMission newMission)
protected void	standardUnitsOfMeasureElement()
protected void	startRecordTag() Manually inserts the DiscreteResults start tag
void	startResultsElement() Closes out mission MissionPreparation element and opens MissionResults element
protected void	writeElement(Element el) Writes an element to the XML telemetry file
protected void	writeElement(Object el) Writes an element (JAXB object) to the XML telemetry file
protected abstract void	writeOrders() Generates an vehicle control orders element and writes it to the XML telemetry file
protected abstract void	writeSensorData() Writes out sensor data elements as required to the XML telemetry file
protected abstract void	writeTelemetry() Constructs a telemetry element and writes it to the XML telemetry file
protected abstract void	writeWeaponData() Writes out weapon data elements as required to the XML telemetry file

Methods inherited from class java.lang.Object

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

Field Detail

vehicle

protected Execution vehicle

reference to vehicle object to which this mission applies

newResultsDomDocument

protected Document newResultsDomDocument

XML mission results (telemetry, orders, etc.)

telemetryElement

protected Element telemetryElement

DOM element for maintaining telemetry information

ordersElement

protected Element ordersElement

Dom element for maintaining control order information

weaponData

protected Element weaponData

DOM Element for weapons data

sensorData

protected Element sensorData

DOM Element for sensorData

logElement

protected Object logElement

JAXB object for maintaining mission log (commands) information

fileOut

protected PrintWriter fileOut

writer to output file

radianAngles

protected boolean radianAngles

metricDistances

protected boolean metricDistances

eventLogged

protected boolean eventLogged

set to true if an event has been logged in the current timestep

avclTelemetryFileName

protected String avclTelemetryFileName

name of output XML file

Constructor Detail

AvclMissionResults

protected AvclMissionResults(Execution execution,
                  Mission msnObject)

Creates a new instance of AvclMissionResults

Parameters:

execution - instance of Execution object

Method Detail

standardUnitsOfMeasureElement

protected void standardUnitsOfMeasureElement()

startResultsElement

public void startResultsElement()

Closes out mission MissionPreparation element and opens MissionResults element

closeDataFile

protected void closeDataFile()

Adds the end tag and closes the data output file

getOutputFilePath

protected String getOutputFilePath()

startRecordTag

protected void startRecordTag()

Manually inserts the DiscreteResults start tag

endRecordTag

protected void endRecordTag()

Manually inserts the DiscreteResults end tag

writeElement

protected void writeElement(Element el)

Writes an element to the XML telemetry file

Parameters:

el - serializable element to be written

writeElement

protected void writeElement(Object el)

Writes an element (JAXB object) to the XML telemetry file

Parameters:

el - JAXB object to be written

logMissionEvent

protected void logMissionEvent(Object event)

Repeats a mission script element in the telemetry file to allow playback

Parameters:

event - the original mission script to log

writeTelemetry

protected abstract void writeTelemetry()

Constructs a telemetry element and writes it to the XML telemetry file

writeOrders

protected abstract void writeOrders()

Generates an vehicle control orders element and writes it to the XML telemetry file

writeSensorData

protected abstract void writeSensorData()

Writes out sensor data elements as required to the XML telemetry file

writeWeaponData

protected abstract void writeWeaponData()

Writes out weapon data elements as required to the XML telemetry file

readyToWriteData

protected boolean readyToWriteData()

This will be called every time-slice. If a particular subclass wants to skip 19 out of 20, they can override.

Returns:

true if a "sampled data" element should be written

setMission

public void setMission(AvclMission newMission)

Parameters:

newMission - the mission to set