TelemetryFileTranslator (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.translate.TelemetryFileTranslator

All Implemented Interfaces:

TelemetryTranslatorInterface

Direct Known Subclasses:

AMN, Capsule, EMATT, GpggaParser, HX90, Missile, Rascal, Remus, ScanEagle, SeaFox, SolarAuv, TW09Track, TW10TrackStick
```
public abstract class TelemetryFileTranslator
extends Object
implements TelemetryTranslatorInterface
```
Superclass for most robot telemetry parsers that produces AVCL telemetry. The TelemetryTranslatorInterface is the interface, but doesn't reuse code. This class is a useful place for storing some common utility methods and instance variables

Version:

$Id: TelemetryFileTranslator.java 8709 2012-12-17 05:57:37Z brutzman $

Author:

mcgredo

Field Summary

Fields
Modifier and Type	Field and Description
`protected AVCL`	`avclDocument`
`protected GeodeticToUTMConverter`	`centerCoordUTM`
`protected ObjectFactory`	`factory` Creates new JAXB objects
`protected AvclTelemetryFileWriter`	`fileWriter` File writer, sends telemetry events to an AVCL file
`protected boolean`	`filterOnTime` Should we filter on time at all?
`protected FileInputStream`	`fis` File we read "original format" data from before translating it into avcl.
`protected com.bbn.openmap.LatLonPoint`	`geoOriginLatLon`
`protected com.bbn.openmap.LatLonPoint`	`latLonOffset`
`protected MetaDataModel`	`metadata`
`protected GeodeticToUTMConverter`	`offsetCoordUTM`
`protected String`	`pathname` Pathname to the input file
`protected com.bbn.openmap.LatLonPoint`	`projectGeoOriginLatLon`
`protected PrintStream`	`sysoutPW`
`protected double`	`timeFilterMinimum` The periodicity at which we filter observations.

Fields inherited from interface avcl.translate.TelemetryTranslatorInterface
GEO_ORIGIN

Constructor Summary

Constructors
Constructor and Description

TelemetryFileTranslator()

Constructors
Constructor and Description
`TelemetryFileTranslator()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMetadataEntry(String metadataName, String metadataValue)` Used to add a new single metadata model to the list in the Metadata
`void`	`endDocument()` implements TelemetryTranslatorInterface
`AVCL`	`getAvclDocument()`
`AVCL`	`getDefaultAvclDocument()` Creates a mostly-filled-out `AVCL` document that lacks only the telemetry data.
`int`	`getImportStartTime()` Retrieves a desired start time
`int`	`getImportStopTime()` Retrieves a desired stop time
`protected String`	`getMonthName(int month)` Returns the name of a month
`protected double`	`getSignificantDigits(double input, int digitsToRight)` Given a floating point/double number, sets the number of significant digits to the right of the decimal point as specified.
`PrintStream`	`getSysOut()`
`double`	`getTelemetrySampleRate()` Accept data no more frequently than this
`double`	`getTimeFilterMinimum()`
`protected float[]`	`latLongToXY()` This conversion solution takes into account a WGS-84 ellipsoid when calculating (x, y) offsets in meters from a given GeoOrigin.
`protected Point2D`	`latLongToXY(com.bbn.openmap.LatLonPoint geoOrigin, com.bbn.openmap.LatLonPoint location)` Dragons be here.
`abstract void`	`parse()` required method
`void`	`setFilterOnTime(boolean onTime)`
`void`	`setImportStartTime(int time)` Sets a desired import start time
`void`	`setImportStopTime(int time)` Sets a desired import stop time
`void`	`setInputFileName(String pPathname)` implements TelemetryTranslatorInterface
`void`	`setMetadata(MetaDataModel metadata)`
`void`	`setSysOut(PrintStream printStream)` Provides a convenient sysout redirect feature to the output console
`void`	`setTimeFilterMinimum(double frequency)`
`void`	`startDocument()` implements TelemetryTranslatorInterface
`void`	`startDocument(AVCL pDoc)`
`void`	`sysOutPrintln(Object o)`
`void`	`sysOutPrintln(String s)`
`abstract String`	`toString()` Returns a string description of the translator, suitable for user viewing in GUIs.
`void`	`writeOutputFile(String s)` implements TelemetryTranslatorInterface *

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

- Field Detail
  - sysoutPW
```
protected PrintStream sysoutPW
```
  - fis
```
protected FileInputStream fis
```
    File we read "original format" data from before translating it into avcl.
  - pathname
```
protected String pathname
```
    Pathname to the input file
  - fileWriter
```
protected AvclTelemetryFileWriter fileWriter
```
    File writer, sends telemetry events to an AVCL file
  - geoOriginLatLon
```
protected com.bbn.openmap.LatLonPoint geoOriginLatLon
```
  - projectGeoOriginLatLon
```
protected com.bbn.openmap.LatLonPoint projectGeoOriginLatLon
```
  - latLonOffset
```
protected com.bbn.openmap.LatLonPoint latLonOffset
```
  - centerCoordUTM
```
protected GeodeticToUTMConverter centerCoordUTM
```
  - offsetCoordUTM
```
protected GeodeticToUTMConverter offsetCoordUTM
```
  - factory
```
protected ObjectFactory factory
```
    Creates new JAXB objects
  - avclDocument
```
protected AVCL avclDocument
```
  - metadata
```
protected MetaDataModel metadata
```
  - timeFilterMinimum
```
protected double timeFilterMinimum
```
    The periodicity at which we filter observations. In seconds
  - filterOnTime
```
protected boolean filterOnTime
```
    Should we filter on time at all?
- Constructor Detail
  - TelemetryFileTranslator
```
public TelemetryFileTranslator()
```
- Method Detail
  - setMetadata
```
public void setMetadata(MetaDataModel metadata)
```
    Specified by:
    
    setMetadata in interface TelemetryTranslatorInterface
    
    Parameters:
    metadata -
  - setFilterOnTime
```
public void setFilterOnTime(boolean onTime)
```
    Specified by:
    
    setFilterOnTime in interface TelemetryTranslatorInterface
  - setTimeFilterMinimum
```
public void setTimeFilterMinimum(double frequency)
```
    Specified by:
    
    setTimeFilterMinimum in interface TelemetryTranslatorInterface
  - addMetadataEntry
```
public void addMetadataEntry(String metadataName,
                    String metadataValue)
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Used to add a new single metadata model to the list in the Metadata
    
    Specified by:
    
    addMetadataEntry in interface TelemetryTranslatorInterface
  - startDocument
```
public void startDocument()
```
    implements TelemetryTranslatorInterface
    
    Specified by:
    
    startDocument in interface TelemetryTranslatorInterface
  - startDocument
```
public void startDocument(AVCL pDoc)
```
  - endDocument
```
public void endDocument()
```
    implements TelemetryTranslatorInterface
    
    Specified by:
    
    endDocument in interface TelemetryTranslatorInterface
  - writeOutputFile
```
public void writeOutputFile(String s)
                     throws Exception
```
    implements TelemetryTranslatorInterface *
    
    Specified by:
    
    writeOutputFile in interface TelemetryTranslatorInterface
    
    Parameters:
    s -
    
    Throws:
    
    Exception
  - setInputFileName
```
public void setInputFileName(String pPathname)
                      throws Exception
```
    implements TelemetryTranslatorInterface
    
    Specified by:
    
    setInputFileName in interface TelemetryTranslatorInterface
    
    Parameters:
    pPathname -
    
    Throws:
    
    Exception
  - getDefaultAvclDocument
```
public AVCL getDefaultAvclDocument()
```
    Creates a mostly-filled-out AVCL document that lacks only the telemetry data.
    
    Returns:
    a default AVCL telemetry mission specific to this type of vehicle
  - getAvclDocument
```
public AVCL getAvclDocument()
```
    Returns:
    AVCL document
  - parse
```
public abstract void parse()
```
    required method
    
    Specified by:
    
    parse in interface TelemetryTranslatorInterface
  - getMonthName
```
protected String getMonthName(int month)
```
    Returns the name of a month
    
    Parameters:
    month - int from 0-11
    
    Returns:
    the name of a month
  - latLongToXY
```
protected Point2D latLongToXY(com.bbn.openmap.LatLonPoint geoOrigin,
                  com.bbn.openmap.LatLonPoint location)
```
    Dragons be here.
    This code is rife with opportunities for being wrong in subtle ways. The open map code is generating a "correct" surface-of-sphere distance between points, while we are acting as if we are in a flat 2D world. So any time the vehicles are operating on a sufficiently large geographic scale, distoritions will start to show up. Note that the docs for LatLonPoint.azimuth and LatLonPoint.distance say they are premised on a spherical earth, vs. an ellipsoid used elsewhere, and that this can result in distance errors of 0.5% or so. If you are expecting exact results for (x, y) from lat/lon, you will be disappointed. Positive x is north, positive y east.
    
    Parameters:
    geoOrigin - the origin of our x-y world, in lat-long
    location - the lat-long point we want the x-y to be
    
    Returns:
    the (x, y) in orthogonal distances
  - latLongToXY
```
protected final float[] latLongToXY()
```
    This conversion solution takes into account a WGS-84 ellipsoid when calculating (x, y) offsets in meters from a given GeoOrigin. Positive x is north, positive y east.
    
    Returns:
    the (x, y) in orthogonal distances
  - getSignificantDigits
```
protected double getSignificantDigits(double input,
                          int digitsToRight)
```
    Given a floating point/double number, sets the number of significant digits to the right of the decimal point as specified. Eg, 10.453, 0 significant digits = 10, 11.174 & 2 significant digits = 11.17.
    
    Parameters:
    input - the double to trim
    digitsToRight - max digits to the right of the decimal point
    
    Returns:
    a trimed double value
  - setSysOut
```
public void setSysOut(PrintStream printStream)
```
    Provides a convenient sysout redirect feature to the output console
    
    Specified by:
    
    setSysOut in interface TelemetryTranslatorInterface
    
    Parameters:
    printStream - the stream to output to the system console
  - getSysOut
```
public PrintStream getSysOut()
```
  - sysOutPrintln
```
public void sysOutPrintln(String s)
```
  - sysOutPrintln
```
public void sysOutPrintln(Object o)
```
  - toString
```
public abstract String toString()
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Returns a string description of the translator, suitable for user viewing in GUIs.
    
    Specified by:
    
    toString in interface TelemetryTranslatorInterface
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String description of the translator
  - getTelemetrySampleRate
```
public double getTelemetrySampleRate()
```
    Accept data no more frequently than this
    
    Specified by:
    
    getTelemetrySampleRate in interface TelemetryTranslatorInterface
    
    Returns:
    the minimum time (in seconds) between telemetry data points
  - getTimeFilterMinimum
```
public double getTimeFilterMinimum()
```
    Specified by:
    
    getTimeFilterMinimum in interface TelemetryTranslatorInterface
  - setImportStartTime
```
public void setImportStartTime(int time)
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Sets a desired import start time
    
    Specified by:
    
    setImportStartTime in interface TelemetryTranslatorInterface
    
    Parameters:
    time - a desired import start time
  - getImportStartTime
```
public int getImportStartTime()
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Retrieves a desired start time
    
    Specified by:
    
    getImportStartTime in interface TelemetryTranslatorInterface
    
    Returns:
    a desired start time
  - setImportStopTime
```
public void setImportStopTime(int time)
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Sets a desired import stop time
    
    Specified by:
    
    setImportStopTime in interface TelemetryTranslatorInterface
    
    Parameters:
    time - a desired import stop time
  - getImportStopTime
```
public int getImportStopTime()
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Retrieves a desired stop time
    
    Specified by:
    
    getImportStopTime in interface TelemetryTranslatorInterface
    
    Returns:
    a desired stop time

Class TelemetryFileTranslator

Field Summary

Fields inherited from interface avcl.translate.TelemetryTranslatorInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sysoutPW

fis

pathname

fileWriter

geoOriginLatLon

projectGeoOriginLatLon

latLonOffset

centerCoordUTM

offsetCoordUTM

factory

avclDocument

metadata

timeFilterMinimum

filterOnTime

Constructor Detail

TelemetryFileTranslator

Method Detail

setMetadata

setFilterOnTime

setTimeFilterMinimum

addMetadataEntry

startDocument

startDocument

endDocument

writeOutputFile

setInputFileName

getDefaultAvclDocument

getAvclDocument

parse

getMonthName

latLongToXY

latLongToXY

getSignificantDigits

setSysOut

getSysOut

sysOutPrintln

sysOutPrintln

toString

getTelemetrySampleRate

getTimeFilterMinimum

setImportStartTime

getImportStartTime

setImportStopTime

getImportStopTime