MissionExecutionAndDynamicsHandler (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.main.MissionExecutionAndDynamicsHandler

public class MissionExecutionAndDynamicsHandler
extends Object

Currently, in new multi-mission gui, one of these gets instantiated per mission tab

Version:

$Id: MissionExecutionAndDynamicsHandler.java 9109 2015-07-29 22:39:46Z brutzman $

Latest Modification:


     Date:     August 13, 2005
     Time:     0240:55
     Author:   Terry D. Norbraten
     Comments: Updated getClasspath() with xercesImpl-2.7.0.jar

     Date:     February 09, 2006
     Time:     1554
     Author:   Terry D. Norbraten
     Comments: Renamed xercesImpl-2.7.0.jar in getClasspath() with
               xercesImpl.jar so that updating jars won't break other code

     Date:     15 APR 2007
     Time:     1650
     Author:   Terry D. Norbraten
     Comments: updated getClasspath() with current jar names

     Date:     15 JUN 2007
     Time:     0420Z
     Author:   Terry D. Norbraten
     Comments: Prevent creation of 0 byte files in the current project
               directory when only playing back previous mission telemetry
               (Bug 1271 fix)

     Date:     12 APR 2008
     Time:     0423Z
     Author:   Terry D. Norbraten
     Comments: Update to apache-ant.1.7.0 in getClasspath()

     Date:     19 APR 2008
     Time:     1818Z
     Author:   Terry D. Norbraten
     Comments: Create individual telemetry file output directories in the
               user's project directory instead of mixing them altogether

     Date:     27 OCT 2009
     Time:     0404Z
     Author:   Terry D. Norbraten
     Comments: Provide more mission color choices (19 total)

     Date:     22 DEC 2011
     Time:     0458Z
     Author:   Terry D. Norbraten
     Comments: Provide better synchronized cycling through colors

Author:

Mike Bailey

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MissionExecutionAndDynamicsHandler.ExecutionParameters

Nested Classes
Modifier and Type	Class and Description
`static class`	`MissionExecutionAndDynamicsHandler.ExecutionParameters`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_MUNITION_MISSION_TEXT`
`static String`	`DEFAULT_UAV_MISSION_TEXT` filename for AVCL UAV mission
`static String`	`DEFAULT_UGV_MISSION_TEXT` filename for AVCL UGV mission
`static String`	`DEFAULT_USV_MISSION_TEXT` filename for AVCL USV mission
`static String`	`DEFAULT_UUV_MISSION_TEXT` filename for AVCL UUV mission
`static String`	`DIR_DYNAMICS_JAVA` dynamics
`static String`	`DIR_EXECUTION_C` Execution (C)
`static String`	`DIR_EXECUTION_JAVA_MUNITION`
`static String`	`DIR_EXECUTION_JAVA_UAV`
`static String`	`DIR_EXECUTION_JAVA_UGV`
`static String`	`DIR_EXECUTION_JAVA_USV`
`static String`	`DIR_EXECUTION_JAVA_UUV` Execution (Java)
`static String`	`FILE_DYNAMICS` Dynamics application name
`static String`	`FILE_EXE_MISSION` filename for text-based mission script (used by Execution C)
`static String`	`FILE_EXE_MISSION_XML` filename for XML-based mission script (used by Execution C)
`static String`	`FILE_EXECUTION_C` Execution (C) application name
`static String`	`FILE_EXECUTION_JAVA_MUNITION`
`static String`	`FILE_EXECUTION_JAVA_UAV`
`static String`	`FILE_EXECUTION_JAVA_UGV`
`static String`	`FILE_EXECUTION_JAVA_USV`
`static String`	`FILE_EXECUTION_JAVA_UUV` Dynamics (Java) application name
`String`	`mission_x3dFile`
`static int`	`NUMAUVTYPES` Yet another annoying magic # that includes UUV, AUV, USV, UGV, MUNITION and SSGN

Constructor Summary

Constructors
Constructor and Description
`MissionExecutionAndDynamicsHandler(AvclMission mission, AUVWorkbenchConfig cfgAUVW, MultiMissionController controller)` Creates a new instance of MissionExecutionAndDynamicsHandler

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildXmlTelemetryFileName(String missionFileName)` Builds all necessary resources and directories required to archive a mission's output results.
`void`	`disposeMission()` Do this when an instance of this object is to be thrown away
`int`	`getLocalVehicleID()`
`int`	`getSetVehicleID(int existing)` Tries to assign the same ID as the last one
`List<String>`	`getSingleMissionTelemetryResults()`
`Color`	`getTelemetryColor()`
`Color`	`getWaypointColor()` Retrieve the specified color for this mission
`void`	`processMultipleLoopsMission()` Handles selection of multipleLoopsMission
`void`	`processPause()` Handles selection of pause
`void`	`processResume()` Handles the resume button selected
`void`	`processStart(MissionExecutionAndDynamicsHandler.ExecutionParameters executionParameters, String userMissionFileName, String execID, boolean networkedDIS, boolean useEnvironmentalFactors)` Start process - using C or Java dynamics
`void`	`processStop()` Stops each of the separately launched JVM processes
`void`	`releaseVehicleID(int existing)`
`void`	`setSingleMissionTelemetryResults(List<String> singleMissionTelemetryResults)` Set the list of telemetry results files

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

- Field Detail
  - DIR_DYNAMICS_JAVA
```
public static final String DIR_DYNAMICS_JAVA
```
    dynamics
  - FILE_DYNAMICS
```
public static final String FILE_DYNAMICS
```
    Dynamics application name
    
    See Also:
    
    Constant Field Values
  - DIR_EXECUTION_C
```
public static final String DIR_EXECUTION_C
```
    Execution (C)
    
    See Also:
    
    Constant Field Values
  - DIR_EXECUTION_JAVA_UUV
```
public static final String DIR_EXECUTION_JAVA_UUV
```
    Execution (Java)
  - DIR_EXECUTION_JAVA_UGV
```
public static final String DIR_EXECUTION_JAVA_UGV
```
  - DIR_EXECUTION_JAVA_USV
```
public static final String DIR_EXECUTION_JAVA_USV
```
  - DIR_EXECUTION_JAVA_UAV
```
public static final String DIR_EXECUTION_JAVA_UAV
```
  - DIR_EXECUTION_JAVA_MUNITION
```
public static final String DIR_EXECUTION_JAVA_MUNITION
```
  - FILE_EXECUTION_C
```
public static final String FILE_EXECUTION_C
```
    Execution (C) application name
    
    See Also:
    
    Constant Field Values
  - FILE_EXECUTION_JAVA_UUV
```
public static final String FILE_EXECUTION_JAVA_UUV
```
    Dynamics (Java) application name
    
    See Also:
    
    Constant Field Values
  - FILE_EXECUTION_JAVA_UGV
```
public static final String FILE_EXECUTION_JAVA_UGV
```
    See Also:
    
    Constant Field Values
  - FILE_EXECUTION_JAVA_USV
```
public static final String FILE_EXECUTION_JAVA_USV
```
    See Also:
    
    Constant Field Values
  - FILE_EXECUTION_JAVA_UAV
```
public static final String FILE_EXECUTION_JAVA_UAV
```
    See Also:
    
    Constant Field Values
  - FILE_EXECUTION_JAVA_MUNITION
```
public static final String FILE_EXECUTION_JAVA_MUNITION
```
    See Also:
    
    Constant Field Values
  - FILE_EXE_MISSION
```
public static final String FILE_EXE_MISSION
```
    filename for text-based mission script (used by Execution C)
    
    See Also:
    
    Constant Field Values
  - FILE_EXE_MISSION_XML
```
public static final String FILE_EXE_MISSION_XML
```
    filename for XML-based mission script (used by Execution C)
  - DEFAULT_UUV_MISSION_TEXT
```
public static final String DEFAULT_UUV_MISSION_TEXT
```
    filename for AVCL UUV mission
    
    See Also:
    
    Constant Field Values
  - DEFAULT_UGV_MISSION_TEXT
```
public static final String DEFAULT_UGV_MISSION_TEXT
```
    filename for AVCL UGV mission
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USV_MISSION_TEXT
```
public static final String DEFAULT_USV_MISSION_TEXT
```
    filename for AVCL USV mission
    
    See Also:
    
    Constant Field Values
  - DEFAULT_UAV_MISSION_TEXT
```
public static final String DEFAULT_UAV_MISSION_TEXT
```
    filename for AVCL UAV mission
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MUNITION_MISSION_TEXT
```
public static final String DEFAULT_MUNITION_MISSION_TEXT
```
    See Also:
    
    Constant Field Values
  - NUMAUVTYPES
```
public static final int NUMAUVTYPES
```
    Yet another annoying magic # that includes UUV, AUV, USV, UGV, MUNITION and SSGN
    
    See Also:
    
    Constant Field Values
  - mission_x3dFile
```
public String mission_x3dFile
```
- Constructor Detail
  - MissionExecutionAndDynamicsHandler
```
public MissionExecutionAndDynamicsHandler(AvclMission mission,
                                          AUVWorkbenchConfig cfgAUVW,
                                          MultiMissionController controller)
```
    Creates a new instance of MissionExecutionAndDynamicsHandler
    
    Parameters:
    
    mission - the user selected AVCL mission
    
    cfgAUVW - the original AUVW configuration
    
    controller - the MultiMissionController controlling this handler
- Method Detail
  - disposeMission
```
public void disposeMission()
```
    Do this when an instance of this object is to be thrown away
  - processStart
```
public void processStart(MissionExecutionAndDynamicsHandler.ExecutionParameters executionParameters,
                         String userMissionFileName,
                         String execID,
                         boolean networkedDIS,
                         boolean useEnvironmentalFactors)
```
    Start process - using C or Java dynamics
    
    Parameters:
    
    executionParameters - various execution parameters
    
    userMissionFileName - name of mission file being executed
    
    execID - execution id
    
    networkedDIS - use networked DIS
    
    useEnvironmentalFactors - enable environmental factors
  - processMultipleLoopsMission
```
public void processMultipleLoopsMission()
```
    Handles selection of multipleLoopsMission
  - processPause
```
public void processPause()
```
    Handles selection of pause
  - processResume
```
public void processResume()
```
    Handles the resume button selected
  - processStop
```
public void processStop()
```
    Stops each of the separately launched JVM processes
  - getWaypointColor
```
public Color getWaypointColor()
```
    Retrieve the specified color for this mission
    
    Returns:
    
    the specified color for this mission
  - getTelemetryColor
```
public Color getTelemetryColor()
```
  - getSetVehicleID
```
public final int getSetVehicleID(int existing)
```
    Tries to assign the same ID as the last one
    
    Parameters:
    
    existing - last id
    
    Returns:
    
    assigned id
  - releaseVehicleID
```
public void releaseVehicleID(int existing)
```
  - getLocalVehicleID
```
public int getLocalVehicleID()
```
    Returns:
    
    a unique vehicle ID
  - buildXmlTelemetryFileName
```
public String buildXmlTelemetryFileName(String missionFileName)
```
    Builds all necessary resources and directories required to archive a mission's output results.
    
    Parameters:
    
    missionFileName - the filename of the recorded, or translated mission telemetry
    
    Returns:
    
    a path to the mission results archive directory and file name
  - getSingleMissionTelemetryResults
```
public List<String> getSingleMissionTelemetryResults()
```
    Returns:
    
    a list of telemetry results files
  - setSingleMissionTelemetryResults
```
public void setSingleMissionTelemetryResults(List<String> singleMissionTelemetryResults)
```
    Set the list of telemetry results files
    
    Parameters:
    
    singleMissionTelemetryResults -

Class MissionExecutionAndDynamicsHandler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIR_DYNAMICS_JAVA

FILE_DYNAMICS

DIR_EXECUTION_C

DIR_EXECUTION_JAVA_UUV

DIR_EXECUTION_JAVA_UGV

DIR_EXECUTION_JAVA_USV

DIR_EXECUTION_JAVA_UAV

DIR_EXECUTION_JAVA_MUNITION

FILE_EXECUTION_C

FILE_EXECUTION_JAVA_UUV

FILE_EXECUTION_JAVA_UGV

FILE_EXECUTION_JAVA_USV

FILE_EXECUTION_JAVA_UAV

FILE_EXECUTION_JAVA_MUNITION

FILE_EXE_MISSION

FILE_EXE_MISSION_XML

DEFAULT_UUV_MISSION_TEXT

DEFAULT_UGV_MISSION_TEXT

DEFAULT_USV_MISSION_TEXT

DEFAULT_UAV_MISSION_TEXT

DEFAULT_MUNITION_MISSION_TEXT

NUMAUVTYPES

mission_x3dFile

Constructor Detail

MissionExecutionAndDynamicsHandler

Method Detail

disposeMission

processStart

processMultipleLoopsMission

processPause

processResume

processStop

getWaypointColor

getTelemetryColor

getSetVehicleID

releaseVehicleID

getLocalVehicleID

buildXmlTelemetryFileName

getSingleMissionTelemetryResults

setSingleMissionTelemetryResults