loggerForms.controls

Class NMEAControl

java.lang.Object

loggerForms.controls.LoggerControl

loggerForms.controls.SimpleControl

loggerForms.controls.NMEAControl

Direct Known Subclasses:

NMEACharControl, NMEAFloatControl, NMEAIntegerControl

public abstract class NMEAControl
extends SimpleControl

Intermediate class for all NMEA data types. Contains functionality to find particular NMEA strings, correct string. Then extracts desired section of that string searching multiple NMEA inputs if necessary to locate the

Author:

Doug Gillespie

Field Summary

Fields inherited from class loggerForms.controls.LoggerControl

AUTO_UPDATE_CANT, AUTO_UPDATE_FAIL, AUTO_UPDATE_SUCCESS

Constructor Summary

Constructors

Constructor and Description
NMEAControl(ControlDescription controlDescription, LoggerForm loggerForm)

Method Summary

Methods

Modifier and Type	Method and Description
int	autoUpdate() Automatically update a control.
int	fillNMEAControlData(NMEADataUnit dataUnit) Called once a correct NMEA data unit has been found to write the data into the control.
int	updateNMEAData() Tries to find the appropriate NMEA string by searching multiple data blocks if necessary.
int	updateNMEAData(NMEADataUnit nmeaData) Used when NMEA data is being updated in response to the arrival of a new NMEA string (i.e.

Methods inherited from class loggerForms.controls.SimpleControl

clear, getDataError, setData, setDefault

Methods inherited from class loggerForms.controls.LoggerControl

addF1KeyListener, addFocusListenerToAllSubComponants, addMouseListenerToAllSubComponants, clearDataError, clearDataWarning, f1Pressed, findNMEADataBlock, getComponent, getControlDescription, getData, getDataWarning, getLoggerForm, lFocusGained, setToolTipToAllSubJComponants

Methods inherited from class java.lang.Object

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

Constructor Detail

NMEAControl

public NMEAControl(ControlDescription controlDescription,
           LoggerForm loggerForm)

Method Detail

autoUpdate

public int autoUpdate()

Description copied from class: LoggerControl

Automatically update a control. This is only possible for controls such as time, timestamps and NMEA items.

Overrides:

autoUpdate in class LoggerControl

Returns:

AUTO_UPDATE_SUCCESS, AUTO_UPDATE_FAIL or AUTO_UPDATE_CANT

updateNMEAData

public int updateNMEAData()

Tries to find the appropriate NMEA string by searching multiple data blocks if necessary. IF the previous call was Successful, then it will just go straight to that same data block, otherwise, it will search all available datablocks.

Overrides:

updateNMEAData in class LoggerControl

Returns:

fillNMEAControlData

public int fillNMEAControlData(NMEADataUnit dataUnit)

Description copied from class: LoggerControl

Called once a correct NMEA data unit has been found to write the data into the control.

Overrides:

fillNMEAControlData in class SimpleControl

Parameters:

dataUnit - NMEA data unit

Returns:

success flag.

updateNMEAData

public int updateNMEAData(NMEADataUnit nmeaData)

Used when NMEA data is being updated in response to the arrival of a new NMEA string (i.e. on forms which save all NMEA data from a single string). An actual string is passed in, but there is just a chance that it will be the wrong type in which case the default is used.

Overrides:

updateNMEAData in class LoggerControl

Parameters:

nmeaData -