NMEA

Class NMEAControl

java.lang.Object

PamController.PamControlledUnit

NMEA.NMEAControl

All Implemented Interfaces:

PamSettings

public class NMEAControl
extends PamControlledUnit
implements PamSettings

Author:

Doug Gillespie, David McLaren, Paul Redmond

Controller for NMEA data acquisition into the Pamguard framework

The controller contains two processes, each of which produces a single output PamDataBlock.

The first process adds all NMEA strings to it's output block in their original format

The second process takes only the GPRMC data and adds them to a separate data block. the map should subscribe to this second process and tell it how much data it wished to keep using the FirstRequiredSample method of the PamObserver interface.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NMEAControl(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	createNMEAMenu(java.awt.Frame parentFrame)
NMEADataBlock	getNMEADataBLock() Get the NMEA DataBlock.
NMEAParameters	getNmeaParameters()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
void	pamClose() Called when PAMGUARD is finally closing down so that a module may free any remaining resources (e.g.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setupControlledUnit() called for all PamControlledUnits after all units have been created.

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, notifyModelChanged, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, 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

nmeaUnitType

public static final java.lang.String nmeaUnitType

See Also:

Constant Field Values

Constructor Detail

NMEAControl

public NMEAControl(java.lang.String unitName)

Method Detail

createNMEAMenu

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

getNmeaParameters

public NMEAParameters getNmeaParameters()

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

setupControlledUnit

public void setupControlledUnit()

Description copied from class: PamControlledUnit

called for all PamControlledUnits after all units have been created. This is a good time for the controlled units and processes to find and check their source data and the configuration generally since most onjects (i.e. output data blocks) should be in place

Overrides:

setupControlledUnit in class PamControlledUnit

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.

pamClose

public void pamClose()

Description copied from class: PamControlledUnit

Called when PAMGUARD is finally closing down so that a module may free any remaining resources (e.g. files or COMM ports).

Overrides:

pamClose in class PamControlledUnit

getNMEADataBLock

public NMEADataBlock getNMEADataBLock()

Get the NMEA DataBlock.

Returns:

the NMEA data block