MissionEditDataModel (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.mission.MissionEditDataModel

```
public class MissionEditDataModel
extends Object
```
This class manages the file-based data for a single mission. The single instance of MultiMissionController creates one of these for every mission. This object creates a temporary file containing a copy of the originally-loaded one (if a file was loaded from disk), and changes from any of the editors (tree, list, text or 2D display) are made to the temp file. Then, when the model is explicitly saved, the temp file is copied to the "user" file. This makes the complex task of trying to update individual pieces of the mission, which are handled differently by the different views, more reliably, albeit slightly more slowly, done than with dynamic, incremental updates. So, when one view changes something, the temp file is updated, and the other views are simply informed that the data has changed. They typically re-read and re-render the whole file at that point. Autonomous Underwater Vehicle Workbench Naval Postgraduate School, Monterey, CA www.nps.edu

Since:

Dec 8, 2004, 1:33:35 PM

Version:

$Id: MissionEditDataModel.java 8833 2013-02-15 22:06:23Z tnorbraten $

Author:

Mike Bailey

Field Summary

Fields
Modifier and Type Field and Description

Point2D lastRealtimeLocation

int realtimeCommandIdx

Point2D realtimeLocation

boolean selected

Fields
Modifier and Type	Field and Description
`Point2D`	`lastRealtimeLocation`
`int`	`realtimeCommandIdx`
`Point2D`	`realtimeLocation`
`boolean`	`selected`

Constructor Summary

Constructors
Constructor and Description
`MissionEditDataModel(File xmlPath, AUVWorkbenchConfig cfgAUV, MultiMissionController multiMissionController)` Constructor for existing missions
`MissionEditDataModel(int vehicleType, AUVWorkbenchConfig cfgAUV, MultiMissionController multiMissionController)` Constructor for new missions

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeMission()` Do whatever dispose stuff needs doing.
`AvclMission`	`getAvclMission()` Since the mission is created here, provide a way to retrieve it.
`List<JAXBElement<?>>`	`getCommandList()` The mission icon list and 2D display will typically want this when they've been informed that the data has changed.
`List<AreaElementType>`	`getConstraintAvoidAreas()`
`RouteElementType`	`getConstraintEgressRouting()`
`RouteElementType`	`getConstraintIngressRouting()`
`List<AgendaGoalElementType>`	`getGoalList()`
`int`	`getID()`
`org.jdom.Document`	`getJdomMissionDocument()` The MultiMissionController will call this XML view to check for the default 3D scene name
`AbsoluteHorizontalPositionElementType`	`getLaunchPosition()`
`Color`	`getMissionColor()` Retrieve the specified color for this mission
`MissionExecutionAndDynamicsHandler`	`getMissionExecutionAndDynamicsHandler()`
`File`	`getMissionFile()` Get the file which the user thinks he's dealing with.
`MunitionAimPointElementType`	`getMunitionAimPoint()`
`MunitionLaunchPointElementType`	`getMunitionLaunchPoint()`
`AbsoluteHorizontalPositionElementType`	`getRecoveryPosition()`
`String[]`	`getSupportedVehicleDisplayNames()`
`String[]`	`getSupportedVehicleTypes()`
`File`	`getTempMissionFile()` The raw text editor will typ do this after being informed that mission data has changed.
`boolean`	`isMissionDirty()`
`void`	`marshalTempMissionFile()` Marshal in memory mission XML to file
`static Object`	`missionIDfromString(String s)`
`static String`	`missionIDtoString(Object mid)` Stringify a mission ID
`void`	`saveMission()` On loaded-from-disk missions, the MultiMissionController will come here.
`void`	`saveMission(File xmlPath)` The MultiMissionController will come here when the mission is being closed or saved.
`void`	`setAgendaElementSelected(int indexNum, boolean tf)`
`void`	`setAllAgendaElementsSelected(boolean tf)`
`void`	`setMissionDirty(boolean dirty)`
`void`	`setMissionFile(File f)` Called after a save-as.
`void`	`setSupportedVehicleDisplayNames(String[] sa)`
`void`	`setSupportedVehicleTypes(String[] sa)`

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

- Field Detail
  - lastRealtimeLocation
```
public Point2D lastRealtimeLocation
```
  - realtimeLocation
```
public Point2D realtimeLocation
```
  - realtimeCommandIdx
```
public int realtimeCommandIdx
```
  - selected
```
public boolean selected
```
- Constructor Detail
  - MissionEditDataModel
```
public MissionEditDataModel(File xmlPath,
                    AUVWorkbenchConfig cfgAUV,
                    MultiMissionController multiMissionController)
```
    Constructor for existing missions
    
    Parameters:
    xmlPath - path to the XML mission file
    cfgAUV - the workbench configuration handler
    multiMissionController - the workbench multi mission controller
  - MissionEditDataModel
```
public MissionEditDataModel(int vehicleType,
                    AUVWorkbenchConfig cfgAUV,
                    MultiMissionController multiMissionController)
```
    Constructor for new missions
    
    Parameters:
    vehicleType - the type mission to create based on a vehicle type
    cfgAUV - the workbench configuration handler
    multiMissionController - the workbench multi mission controller
- Method Detail
  - closeMission
```
public void closeMission()
```
    Do whatever dispose stuff needs doing. The tab is being removed
  - getMissionColor
```
public Color getMissionColor()
```
    Retrieve the specified color for this mission
    
    Returns:
    the specified color for this mission
  - getMissionExecutionAndDynamicsHandler
```
public MissionExecutionAndDynamicsHandler getMissionExecutionAndDynamicsHandler()
```
  - marshalTempMissionFile
```
public void marshalTempMissionFile()
```
    Marshal in memory mission XML to file
  - getJdomMissionDocument
```
public org.jdom.Document getJdomMissionDocument()
```
    The MultiMissionController will call this XML view to check for the default 3D scene name
    
    Returns:
    the jDom Document for the MultiMissionController default 3D scene check
  - getTempMissionFile
```
public File getTempMissionFile()
```
    The raw text editor will typ do this after being informed that mission data has changed.
    
    Returns:
    the TEMPORARY file that is continually updated. This file is discarded when this model object is disposed. It is copied into the "user" file in the saveMission() method.
  - getMissionFile
```
public File getMissionFile()
```
    Get the file which the user thinks he's dealing with. This is the one who's name is displayed on the tabs, from whom the data was originally read, and to which the data is saved on user command.
    
    Returns:
    the current mission file (mission tab name)
  - setMissionFile
```
public void setMissionFile(File f)
```
    Called after a save-as.
    
    Parameters:
    f - current mission file (mission tab name)
  - getCommandList
```
public List<JAXBElement<?>> getCommandList()
```
    The mission icon list and 2D display will typically want this when they've been informed that the data has changed.
    
    Returns:
    the mission icon list
  - getGoalList
```
public List<AgendaGoalElementType> getGoalList()
```
  - getConstraintAvoidAreas
```
public List<AreaElementType> getConstraintAvoidAreas()
```
  - getConstraintEgressRouting
```
public RouteElementType getConstraintEgressRouting()
```
  - getConstraintIngressRouting
```
public RouteElementType getConstraintIngressRouting()
```
  - getLaunchPosition
```
public AbsoluteHorizontalPositionElementType getLaunchPosition()
```
  - getRecoveryPosition
```
public AbsoluteHorizontalPositionElementType getRecoveryPosition()
```
  - setAllAgendaElementsSelected
```
public void setAllAgendaElementsSelected(boolean tf)
```
  - setAgendaElementSelected
```
public void setAgendaElementSelected(int indexNum,
                            boolean tf)
```
  - getMunitionAimPoint
```
public MunitionAimPointElementType getMunitionAimPoint()
```
  - getMunitionLaunchPoint
```
public MunitionLaunchPointElementType getMunitionLaunchPoint()
```
  - getAvclMission
```
public AvclMission getAvclMission()
```
    Since the mission is created here, provide a way to retrieve it.
    
    Returns:
    the current AVCL mission
  - saveMission
```
public void saveMission()
```
    On loaded-from-disk missions, the MultiMissionController will come here.
  - saveMission
```
public void saveMission(File xmlPath)
```
    The MultiMissionController will come here when the mission is being closed or saved.
    
    Parameters:
    xmlPath - the mission file to save
  - getSupportedVehicleTypes
```
public String[] getSupportedVehicleTypes()
```
  - setSupportedVehicleTypes
```
public void setSupportedVehicleTypes(String[] sa)
```
  - getSupportedVehicleDisplayNames
```
public String[] getSupportedVehicleDisplayNames()
```
  - setSupportedVehicleDisplayNames
```
public void setSupportedVehicleDisplayNames(String[] sa)
```
  - isMissionDirty
```
public boolean isMissionDirty()
```
  - setMissionDirty
```
public void setMissionDirty(boolean dirty)
```
  - getID
```
public int getID()
```
    Returns:
    a unique vehicle ID
  - missionIDfromString
```
public static Object missionIDfromString(String s)
```
  - missionIDtoString
```
public static String missionIDtoString(Object mid)
```
    Stringify a mission ID
    
    Parameters:
    mid - the mission ID to convert to a string
    
    Returns:
    the mission ID

Class MissionEditDataModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lastRealtimeLocation

realtimeLocation

realtimeCommandIdx

selected

Constructor Detail

MissionEditDataModel

MissionEditDataModel

Method Detail

closeMission

getMissionColor

getMissionExecutionAndDynamicsHandler

marshalTempMissionFile

getJdomMissionDocument

getTempMissionFile

getMissionFile

setMissionFile

getCommandList

getGoalList

getConstraintAvoidAreas

getConstraintEgressRouting

getConstraintIngressRouting

getLaunchPosition

getRecoveryPosition

setAllAgendaElementsSelected

setAgendaElementSelected

getMunitionAimPoint

getMunitionLaunchPoint

getAvclMission

saveMission

saveMission

getSupportedVehicleTypes

setSupportedVehicleTypes

getSupportedVehicleDisplayNames

setSupportedVehicleDisplayNames

isMissionDirty

setMissionDirty

getID

missionIDfromString

missionIDtoString