GPS

Class GPSControl

java.lang.Object

PamController.PamControlledUnit

GPS.GPSControl

All Implemented Interfaces:

PamSettings

public class GPSControl
extends PamControlledUnit
implements PamSettings

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	gpsUnitType

Constructor Summary

Constructors

Constructor and Description
GPSControl(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
javax.swing.JMenuItem	createGPSMenu(java.awt.Frame parentFrame)
static GPSControl	getGpsControl() There is only one GPS controller in the model, so might as well make it easy to find with a static function.
GPSDataBlock	getGpsDataBlock()
GPSParameters	getGpsParameters()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
GpsDataUnit	getShipPosition(long timeMilliseconds)
java.lang.String	getWantedString() Get the name of the string we're wanting.
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	removeUnit() Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Field Detail

gpsUnitType

public static final java.lang.String gpsUnitType

See Also:

Constant Field Values

Constructor Detail

GPSControl

public GPSControl(java.lang.String unitName)

Method Detail

getGpsDataBlock

public GPSDataBlock getGpsDataBlock()

createGPSMenu

public javax.swing.JMenuItem createGPSMenu(java.awt.Frame parentFrame)

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

getGpsParameters

public GPSParameters getGpsParameters()

getGpsControl

public static GPSControl getGpsControl()

There is only one GPS controller in the model, so might as well make it easy to find with a static function.

Returns:

the gpsControl.

removeUnit

public boolean removeUnit()

Description copied from class: PamControlledUnit

Called to remove a unit.

Overrides:

removeUnit in class PamControlledUnit

Returns:

try (not used)

getShipPosition

public GpsDataUnit getShipPosition(long timeMilliseconds)

getWantedString

public java.lang.String getWantedString()

Get the name of the string we're wanting.

Returns: