A B C D E F G H I K L M N O P R S T U V W X Z 

A

AbstractProvider<T extends ProviderEvent> - Class in net.sf.marineapi.provider
Abstract base class for providers.
AbstractProvider(SentenceReader, String...) - Constructor for class net.sf.marineapi.provider.AbstractProvider
Creates a new instance of AbstractProvider.
AbstractProvider(SentenceReader, SentenceId...) - Constructor for class net.sf.marineapi.provider.AbstractProvider
Creates a new instance of AbstractProvider.
AbstractSentenceListener<T extends Sentence> - Class in net.sf.marineapi.nmea.event
Abstract base class for typed listeners with automatic sentence type resolving and casting.
AbstractSentenceListener() - Constructor for class net.sf.marineapi.nmea.event.AbstractSentenceListener
 
AcquisitionType - Enum in net.sf.marineapi.nmea.util
Aquisition types.
add(String) - Static method in class net.sf.marineapi.nmea.sentence.Checksum
Append or replace existing checksum in specified NMEA sentence.
addListener(ProviderListener<T>) - Method in class net.sf.marineapi.provider.AbstractProvider
Inserts a listener to provider.
addMeasurement(Measurement...) - Method in interface net.sf.marineapi.nmea.sentence.XDRSentence
Adds specified measurement in sentence placing it last.
addSentenceListener(SentenceListener) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Adds a SentenceListener that wants to receive all sentences read by the reader.
addSentenceListener(SentenceListener, SentenceId) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Adds a SentenceListener that is interested in receiving only sentences of certain type.
addSentenceListener(SentenceListener, String) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Adds a SentenceListener that is interested in receiving only sentences of certain type.
addWaypointId(String) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Add a waypoint ID at the end of waypoint list.
ALT_UNIT_FEET - Static variable in interface net.sf.marineapi.nmea.sentence.GGASentence
Altitude presented in feet.
ALT_UNIT_METERS - Static variable in interface net.sf.marineapi.nmea.sentence.GGASentence
Altitude presented in meters.
ALTERNATIVE_BEGIN_CHAR - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Alternative sentence begin character used in VDO and VDM sentences.
APBSentence - Interface in net.sf.marineapi.nmea.sentence
Autopilot sentence "type B", cross-track error, bearings and heading towards destination waypoint.

B

BEGIN_CHAR - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Sentence begin character
BODSentence - Interface in net.sf.marineapi.nmea.sentence
True and magnetic bearing from origin to destination in degrees.

C

calculate(String) - Static method in class net.sf.marineapi.nmea.sentence.Checksum
Calculates checksum for given NMEA sentence, i.e.
Checksum - Class in net.sf.marineapi.nmea.sentence
Provides Sentence checksum calculation and utilities.
CHECKSUM_DELIMITER - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Checksum field delimiter char
clone() - Method in class net.sf.marineapi.provider.event.PositionEvent
 
CompassPoint - Enum in net.sf.marineapi.nmea.util
Defines the supported compass and relative directions.
createParser(String) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Creates a parser for specified NMEA 0183 sentence String.
createParser(TalkerId, SentenceId) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Creates a parser for specified talker and sentence type.
createParser(TalkerId, String) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Creates a parser for specified talker and sentence type.
createProviderEvent() - Method in class net.sf.marineapi.provider.AbstractProvider
Creates a ProviderEvent of type T.
createProviderEvent() - Method in class net.sf.marineapi.provider.HeadingProvider
 
createProviderEvent() - Method in class net.sf.marineapi.provider.PositionProvider
 
createProviderEvent() - Method in class net.sf.marineapi.provider.SatelliteInfoProvider
 

D

DataListener - Interface in net.sf.marineapi.nmea.io
Listener for all data that is not recognized as NMEA 0183.
DataNotAvailableException - Exception in net.sf.marineapi.nmea.parser
Thrown to indicate that requested data is not available.
DataNotAvailableException(String) - Constructor for exception net.sf.marineapi.nmea.parser.DataNotAvailableException
Constructor
DataNotAvailableException(String, Throwable) - Constructor for exception net.sf.marineapi.nmea.parser.DataNotAvailableException
Constructor
dataRead(String) - Method in interface net.sf.marineapi.nmea.io.DataListener
Invoked by SentenceReader when non-NMEA data has been read from the device/data source.
DataStatus - Enum in net.sf.marineapi.nmea.util
DataStatus defines the validity of data being broadcasted by an NMEA device.
Date - Class in net.sf.marineapi.nmea.util
Represents a calendar date (day-month-year) transmitted in sentences that implement DateSentence.
Date() - Constructor for class net.sf.marineapi.nmea.util.Date
Creates a new instance of Date using the current date.
Date(String) - Constructor for class net.sf.marineapi.nmea.util.Date
Creates a new instance of Date, assumes the default NMEA 0183 date formatting, ddmmyy or ddmmyyyy.
Date(int, int, int) - Constructor for class net.sf.marineapi.nmea.util.Date
Constructor with date values.
DateSentence - Interface in net.sf.marineapi.nmea.sentence
Sentences that contains date information.
Datum - Enum in net.sf.marineapi.nmea.util
Defines the supported datums, i.e. the coordinate systems used to specify geographic positions.
DBTSentence - Interface in net.sf.marineapi.nmea.sentence
Water depth below transducer, in meters, feet and fathoms.
DEFAULT_INTERVAL - Static variable in class net.sf.marineapi.nmea.io.SentenceReader
Default reader interval, pause between read attempts (50ms)
DEFAULT_TIMEOUT - Static variable in class net.sf.marineapi.nmea.io.SentenceReader
Default timeout value in milliseconds.
DepthSentence - Interface in net.sf.marineapi.nmea.sentence
Interface for sentences containing the depth of water.
Direction - Enum in net.sf.marineapi.nmea.util
Defines the relative directions, e.g.
distanceTo(Position) - Method in class net.sf.marineapi.nmea.util.Position
Calculates distance to specified Position.
DPTSentence - Interface in net.sf.marineapi.nmea.sentence
Depth of water, measured in meters.
DTMSentence - Interface in net.sf.marineapi.nmea.sentence
Datum reference.

E

ENGINE - Static variable in interface net.sf.marineapi.nmea.sentence.RPMSentence
Source indicator for engine
equals(Object) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
equals(Object) - Method in class net.sf.marineapi.nmea.util.Date
 
equals(Object) - Method in class net.sf.marineapi.nmea.util.Time
 
ExceptionListener - Interface in net.sf.marineapi.nmea.io
A listener callback interface for listening to Exceptions in DataReaders.

F

FaaMode - Enum in net.sf.marineapi.nmea.util
FAA operating modes reported by APB, BWC, BWR, GLL, RMA, RMB, RMC, VTG, WCV and XTE sentences since NMEA 2.3.
FIELD_DELIMITER - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Sentence data fields delimiter char

G

getAbsoluteHumidity() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the absolute humidity.
getAcquisitionType() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the acquisition type of the target.
getAirTemperature() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the air temperature.
getAltitude() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get antenna altitude above mean sea level.
getAltitude() - Method in class net.sf.marineapi.nmea.util.Position
Gets the position altitude from mean sea level.
getAltitudeOffset() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the altitude offset.
getAltitudeUnits() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Gets the altitude units, meters or feet.
getAngle() - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Get wind angle.
getArrivalStatus() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get the arrival to waypoint status.
getAzimuth() - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Get satellite azimuth, in degrees from true north (0..359°).
getBearing() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get true bearing to destination.
getBearing() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the true bearing from the radar to the target.
getBearingOriginToDestination() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns bearing from origin to destination.
getBearingPositionToDestination() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the bearing from current position to destination waypoint.
getBeginChar() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
getBeginChar() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Get the sentence begin character.
getCharValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Parse a single character from the specified sentence field.
getCorrectedCourse() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get the corrected course over ground.
getCourse() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get true course over ground (COG).
getCourse() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the course the target is maintaining.
getCourse() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the current (true) course over ground.
getCrossTrackError() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the cross-track error magnitude/distance.
getCrossTrackError() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get cross track error (XTE).
getCrossTrackUnits() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the unit of cross-track error.
getCycleLockStatus() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the Loran-C cycle lock status, not used for GPS.
getCycleLockStatus() - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Returns the Loran-C cycle lock status, not used for GPS.
getDate() - Method in interface net.sf.marineapi.nmea.sentence.DateSentence
Parses the date information from sentence fields and returns a Date.
getDate() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the date.
getDatum() - Method in class net.sf.marineapi.nmea.util.Position
Gets the datum, i.e. the coordinate system used to define geographic position.
getDatumCode() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the local datum code.
getDatumSubCode() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the local datum subcode, may be blank.
getDay() - Method in class net.sf.marineapi.nmea.util.Date
Get day of month.
getDepth() - Method in interface net.sf.marineapi.nmea.sentence.DepthSentence
Get depth of water, in meters.
getDescription() - Method in class net.sf.marineapi.nmea.util.Waypoint
Gets the waypoint description/comment.
getDestination() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get the destination waypoint.
getDestinationWaypointId() - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Get the ID of destination waypoint.
getDestionationWaypointId() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the destination waypoint id/name.
getDeviation() - Method in interface net.sf.marineapi.nmea.sentence.HDGSentence
Get magnetic deviation.
getDewPoint() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the dew point.
getDgpsAge() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Gets the age of differential GPS data (DGPS).
getDgpsStationId() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Gets the ID of DGPS station.
getDirectionOfVariation() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get the direction of magnetic variation; east or west.
getDistance() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the distance from the radar to the target.
getDistanceOfCPA() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the distance at the Closest Point of Approach (CPA).
getDoubleValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Parse double value from the specified sentence field.
getElevation() - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Get satellite elevation, in degrees (max. 90°).
getExceptionListener() - Method in class net.sf.marineapi.nmea.io.SentenceReader
Returns the exception call-back listener.
getFathoms() - Method in interface net.sf.marineapi.nmea.sentence.DBTSentence
Get depth in fathoms.
getFeet() - Method in interface net.sf.marineapi.nmea.sentence.DBTSentence
Get depth in feet.
getFieldCount() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
getFieldCount() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Returns the current number of data fields in sentence, excluding ID field and checksum.
getFixQuality() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get the GPS fix quality.
getFixQuality() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the current GPS fix quality.
getFixStatus() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get the GPS fix mode; 2D, 3D or no fix.
getGeoidalHeight() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level.
getGeoidalHeightUnits() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get units of height above geoid.
getGpsFixStatus() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the GPS fix status as reported by GSA sentence.
getGpsMode() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the GPS mode of operation as reported in GSA sentence.
getGroundSpeedStatus() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Ground Speed Status.
getHeading() - Method in interface net.sf.marineapi.nmea.sentence.HeadingSentence
Returns the vessel's current heading.
getHeading() - Method in class net.sf.marineapi.provider.event.HeadingEvent
Returns the current heading.
getHeadingToDestionation() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the heading to steer to destination waypoint.
getHorizontalDOP() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get the horizontal dilution of precision (HDOP), i.e. the relative accuracy of horizontal position.
getHorizontalDOP() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get the horizontal dilution Of precision (HDOP).
getHorizontalPrecision() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the horizontal precision of GPS fix.
getHour() - Method in class net.sf.marineapi.nmea.util.Time
Get the hour of day.
getId() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Returns the engine or shaft number/id.
getId() - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Get the ID of satellite vehicle, for example "05".
getId() - Method in class net.sf.marineapi.nmea.util.Waypoint
Get id of Waypoint
getInstance() - Static method in class net.sf.marineapi.nmea.parser.SentenceFactory
Returns the singleton instance of SentenceFactory.
getInterval() - Method in class net.sf.marineapi.nmea.io.SentenceReader
Returns the current reader interval.
getIntValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Parse integer value from the specified sentence field.
getLatitude() - Method in class net.sf.marineapi.nmea.util.Position
Get latitude value of Position
getLatitudeHemisphere() - Method in class net.sf.marineapi.nmea.util.Position
Get the hemisphere of latitude, North or South.
getLatitudeOffset() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the latitude offset.
getLocalZoneHours() - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Get offset to local time zone in hours, from 0 to +/- 13 hours.
getLocalZoneMinutes() - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Get offset to local time zone in minutes, from 0 to +/- 59.
getLongGroundSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Longitudinal Ground Speed.
getLongitude() - Method in class net.sf.marineapi.nmea.util.Position
Get longitude value of Position
getLongitudeHemisphere() - Method in class net.sf.marineapi.nmea.util.Position
Get the hemisphere of longitude, East or West.
getLongitudeOffset() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the longitude offset.
getLongWaterSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Longitudinal Water Speed.
getMagneticBearing() - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Get the magnetic bearing from origin to destination.
getMagneticCourse() - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Get the magnetic course over ground.
getMagneticDirection() - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Returns the magnetic current direction.
getMagneticHeading() - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Returns the current magnetic heading.
getMagneticWindDirection() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the magnetic wind direction.
getMagneticWindDirection() - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
 
getMagnitude() - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Returns the cross-track error magnitude/distance.
getMaximum() - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence
Get maximum depth value the sounder can detect.
getMeasurements() - Method in interface net.sf.marineapi.nmea.sentence.XDRSentence
Returns all measurements.
getMilliseconds() - Method in class net.sf.marineapi.nmea.util.Time
Get time as milliseconds since beginning of day.
getMinutes() - Method in class net.sf.marineapi.nmea.util.Time
Get the minute of hour.
getMode() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get the FAA operation mode of GPS.
getMode() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get the FAA operating mode for GPS.
getMode() - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Get the FAA operating mode of GPS receiver.
getMode() - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Returns the FAA mode.
getMode() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the current FAA operating mode of GPS receiver.
getMonth() - Method in class net.sf.marineapi.nmea.util.Date
Get month, valid values are 1-12 where 1 denotes January, 2 denotes February etc.
getName() - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Returns the datum name, e.g.
getName() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the name of the target as assigned by the radar.
getName() - Method in class net.sf.marineapi.nmea.util.Measurement
Returns the name of transducer.
getNoise() - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Get satellite the signal noise ratio, in dB (0-99 dB).
getNumber() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the number assigned to this target by the radar.
getOffset() - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence
Get offset to transducer.
getOffsetHours() - Method in class net.sf.marineapi.nmea.util.Time
Get time zone offset hours.
getOffsetMinutes() - Method in class net.sf.marineapi.nmea.util.Time
Get time zone offset minutes.
getOriginId() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get the ID of origin waypoint.
getOriginWaypointId() - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Get the ID of origin waypoint.
getPauseTimeout() - Method in class net.sf.marineapi.nmea.io.SentenceReader
Returns the current reading paused timeout.
getPitch() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Returns the propeller pitch, % of maximum.
getPosition() - Method in interface net.sf.marineapi.nmea.sentence.PositionSentence
Gets the geographic position.
getPosition() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the current position.
getPositionDOP() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get the dilution of precision (PDOP) for position.
getPositionPrecision() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the overall precision of GPS fix.
getPrimaryBarometricPressure() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the primary barometric pressure.
getPrimaryBarometricPressureUnit() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the unit of primary barometric pressure.
getRange() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get range to destination waypoint.
getRateOfTurn() - Method in interface net.sf.marineapi.nmea.sentence.ROTSentence
Returns the vessel's rate of turn.
getReference() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
A target may be used to calculate own ship position.
getRelativeHumidity() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the relative humidity.
getRouteId() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Get the number or name of the route.
getRPM() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Returns the revolutions value.
getRudderAngle(Side) - Method in interface net.sf.marineapi.nmea.sentence.RSASentence
Returns the rudder angle for specified side.
getSatelliteCount() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get the number of active satellites in use.
getSatelliteCount() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Get the number of satellites in view.
getSatelliteIds() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get list of satellites used for acquiring the GPS fix.
getSatelliteIds() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the list of GPS satellites used for GPS fix.
getSatelliteInfo() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Get the satellites information.
getSatelliteInfo() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the current detailed satellite information.
getSecondaryBarometricPressure() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the secondary barometric pressure.
getSecondaryBarometricPressureUnit() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the unit of secondary barometric pressure.
getSeconds() - Method in class net.sf.marineapi.nmea.util.Time
Get the second of minute.
getSentence() - Method in class net.sf.marineapi.nmea.event.SentenceEvent
Gets the Sentence object that triggered the event.
getSentenceCount() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Get the total number of sentences in GSV sequence.
getSentenceCount() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Get the number of sentences in RTE sequence.
getSentenceId() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
getSentenceId() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Get the sentence ID that specifies the sentence type and data it holds.
getSentenceIndex() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Get the index of this sentence in GSV sequence.
getSentenceIndex() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Get the index of sentence in RTE sequence.
getSentences() - Method in class net.sf.marineapi.provider.AbstractProvider
Returns the collected sentences.
getSource() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Returns the measurement source, engine or shaft.
getSpeed() - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Returns the wind speed.
getSpeed() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get current speed over ground (SOG).
getSpeed() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the speed the target.
getSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Returns the current flow speed.
getSpeed() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the current speed over ground, in km/h.
getSpeedKmh() - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Returns the current water speed.
getSpeedKmh() - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Get current speed over ground, in kilometers per hour.
getSpeedKnots() - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Returns the current water speed.
getSpeedKnots() - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Get speed over ground in knots.
getSpeedUnit() - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Returns the wind speed unit.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the signal/fix status, LORAN-C Blink or SNR warning.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.GLLSentence
Get the data quality status, valid or invalid.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Get data validity status.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get the sentence data status, valid or invalid.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Gets the data status, valid or invalid.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.ROTSentence
Returns the data status (valid/invalid).
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Returns the data validity status.
getStatus(Side) - Method in interface net.sf.marineapi.nmea.sentence.RSASentence
Returns the data status (valid/invalid) for specified side.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the status of the target.
getStatus() - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Returns the signal/fix status.
getSteerTo() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the direction in which to steer in order to get back on route.
getSteerTo() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get the direction to steer to correct error (left/right).
getSteerTo() - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Returns the direction in which to steer in order to get back on route.
getSternGroundSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Stern Ground Speed.
getSternGroundSpeedStatus() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Stern Ground Speed Status.
getSternWaterSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Stern Water Speed.
getSternWaterSpeedStatus() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Stern Water Speed Status.
getStringValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Get contents of a data field as a String.
getTalkerId() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
getTalkerId() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Gets the talker ID of the sentence.
getTemperature() - Method in interface net.sf.marineapi.nmea.sentence.MTASentence
Returns the air temperature.
getTemperature() - Method in interface net.sf.marineapi.nmea.sentence.MTWSentence
Get the water temperature.
getTime() - Method in interface net.sf.marineapi.nmea.sentence.TimeSentence
Get the time of day.
getTime() - Method in class net.sf.marineapi.provider.event.PositionEvent
Returns the time.
getTimeStamp() - Method in class net.sf.marineapi.nmea.event.SentenceEvent
Get system time when this event was created.
getTimeStamp() - Method in class net.sf.marineapi.nmea.util.Waypoint
Returns the time stamp when Waypoint was created.
getTimeToCPA() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the time to the Closest Point of Approach (CPA).
getTotal() - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Returns the total cumulative distance traveled.
getTotalUnits() - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Returns the unit of measurement for cumulative total distance.
getTravGroundSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Transverse Ground Speed.
getTravWaterSpeed() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Transverse Water Speed.
getTrip() - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Returns the distance traveled since last reset.
getTripUnits() - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Returns the unit of measurement for distance since last reset.
getTrueBearing() - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Get the true bearing from origin to destination.
getTrueCourse() - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Get the true course over ground.
getTrueDirection() - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Returns the true direction of current.
getTrueWindDirection() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the wind direction.
getTrueWindDirection() - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
 
getType() - Method in class net.sf.marineapi.nmea.util.Measurement
Returns the type of transducer.
getUnits() - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Get the unit of measure used for distance and speeds.
getUnits() - Method in class net.sf.marineapi.nmea.util.Measurement
Returns the units of measurement.
getValue() - Method in class net.sf.marineapi.nmea.util.Measurement
Returns the measurement value.
getVariation() - Method in interface net.sf.marineapi.nmea.sentence.HDGSentence
Get magnetic variation.
getVariation() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Get the magnetic variation.
getVelocity() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Get velocity towards destination.
getVerticalDOP() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Get the vertical dilution of precision (VDOP).
getVerticalPrecision() - Method in class net.sf.marineapi.provider.event.SatelliteInfoEvent
Returns the vertical precision of GPS fix.
getWaterSpeedStatus() - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Returns the Water Speed Status.
getWaterTemperature() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the water temperature.
getWaypoint() - Method in interface net.sf.marineapi.nmea.sentence.WPLSentence
Get the destination waypoint.
getWaypointCount() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Get the number of waypoints IDs in this sentence.
getWaypointIds() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Get the list of route waypoints.
getWindSpeed() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the wind speed.
getWindSpeed() - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
 
getWindSpeedKnots() - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Returns the wind speed.
getWindSpeedKnots() - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
 
getYear() - Method in class net.sf.marineapi.nmea.util.Date
Get year.
GGASentence - Interface in net.sf.marineapi.nmea.sentence
Global Positioning System fix data.
GLLSentence - Interface in net.sf.marineapi.nmea.sentence
Current geographic position and time.
GpsFixQuality - Enum in net.sf.marineapi.nmea.util
GpsFixQuality defines the supported fix quality types.
GpsFixStatus - Enum in net.sf.marineapi.nmea.util
GpsFixStatus defines the status of current GPS fix.
GSASentence - Interface in net.sf.marineapi.nmea.sentence
Precision of GPS fix and list of active satellites.
GSVSentence - Interface in net.sf.marineapi.nmea.sentence
Detailed GPS satellite data; satellites in view, satellite elevation, azimuth and signal noise ratio (SNR).

H

hasAll(String...) - Method in class net.sf.marineapi.provider.AbstractProvider
Tells if the provider has captured all the specified sentences.
hasArrived() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Tells if the destination waypoint has been reached or not.
hashCode() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
hashCode() - Method in class net.sf.marineapi.nmea.util.Date
 
hashCode() - Method in class net.sf.marineapi.nmea.util.Time
 
hasOne(String...) - Method in class net.sf.marineapi.provider.AbstractProvider
Tells if the provider has captured at least one of the specified sentences.
hasParser(String) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Tells if the factory is able to create parser for specified sentence type.
hasValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Tells is if the field specified by the given index contains a value.
HDGSentence - Interface in net.sf.marineapi.nmea.sentence
Vessel heading with magnetic deviation and variation.
HDMSentence - Interface in net.sf.marineapi.nmea.sentence
Vessel heading in degrees, relative to magnetic north.
HDTSentence - Interface in net.sf.marineapi.nmea.sentence
Vessel heading in degrees, relative to true north.
HeadingEvent - Class in net.sf.marineapi.provider.event
HeadingProvider event, reports the current magnetic/true heading of vessel in degrees.
HeadingEvent(Object, HeadingSentence) - Constructor for class net.sf.marineapi.provider.event.HeadingEvent
 
HeadingListener - Interface in net.sf.marineapi.provider.event
Listener interface for HeadingProvider.
HeadingProvider - Class in net.sf.marineapi.provider
Heading provider reports the vessel's current heading.
HeadingProvider(SentenceReader) - Constructor for class net.sf.marineapi.provider.HeadingProvider
Creates a new intance of HeadingProvider.
HeadingSentence - Interface in net.sf.marineapi.nmea.sentence
Interface for sentences that provide vessel's true or magnetic heading.

I

index(String) - Static method in class net.sf.marineapi.nmea.sentence.Checksum
Returns the index of checksum separator char in specified NMEA sentence.
isActiveRoute() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Tells if the sentence holds a current active route data.
isArrivalCircleEntered() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Tells if vessel has entered the arrival circle.
isBearingOriginToDestionationTrue() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Tells if the bearing from origin to destination is true or magnetic.
isBearingPositionToDestinationTrue() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Tells if the bearing from current position to destionation is true or magnetic.
isEmpty() - Method in class net.sf.marineapi.nmea.util.Measurement
Tells if all fields in this measurement are empty (null).
isEngine() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Tells if the data source is engine.
isFirst() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Tells if this is the first sentence in GSV sequence.
isFirst() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Tells if this is the first sentence in RTE sequence.
isHeadingToDestinationTrue() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Tells if the heading to destionation is true or magnetic.
isLast() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Tells if this is the last sentence in GSV sequence.
isLast() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Tells if this is the last sentence in RTE sequence.
isLatitudeNorth() - Method in class net.sf.marineapi.nmea.util.Position
Tells if the latitude is on northern hemisphere.
isLongitudeEast() - Method in class net.sf.marineapi.nmea.util.Position
Tells if the longitude is on eastern hemisphere.
isPerpendicularPassed() - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Tells if vessel has passed perpendicular at waypoint.
isProprietary() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
isProprietary() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Tells if the sentence is of proprietary format.
isReady() - Method in class net.sf.marineapi.provider.AbstractProvider
Tells if provider has captured the required sentences for creating new ProviderEvent.
isReady() - Method in class net.sf.marineapi.provider.HeadingProvider
 
isReady() - Method in class net.sf.marineapi.provider.PositionProvider
 
isReady() - Method in class net.sf.marineapi.provider.SatelliteInfoProvider
 
isSentence(String) - Static method in class net.sf.marineapi.nmea.sentence.SentenceValidator
Tells if the specified String matches the NMEA 0183 sentence format.
isShaft() - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Tells if the data source is shaft.
isTrue() - Method in interface net.sf.marineapi.nmea.sentence.HeadingSentence
Tells if the heading returned and set by HeadingSentence.getHeading() and HeadingSentence.setHeading(double) methods is true or magnetic .
isTrue() - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Tells if the angle is relative or true.
isTrue() - Method in class net.sf.marineapi.provider.event.HeadingEvent
Tells if the heading is relative to true or magnetic north.
isValid() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
isValid() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Tells if the sentence formatting matches NMEA 0183 format.
isValid(String) - Static method in class net.sf.marineapi.nmea.sentence.SentenceValidator
Tells if the specified String is a valid NMEA 0183 sentence.
isValid() - Method in class net.sf.marineapi.provider.AbstractProvider
Tells if the captured sentence events contain valid data to be dispatched to ProviderListeners.
isValid() - Method in class net.sf.marineapi.provider.HeadingProvider
 
isValid() - Method in class net.sf.marineapi.provider.PositionProvider
 
isValid() - Method in class net.sf.marineapi.provider.SatelliteInfoProvider
 
isWorkingRoute() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Tells if the sentence holds a current working route data.

K

KM - Static variable in interface net.sf.marineapi.nmea.sentence.APBSentence
Kilometers
KM - Static variable in interface net.sf.marineapi.nmea.sentence.VLWSentence
Kilometers
KMPH - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Units indicator for kilometers per hour
KNOT - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Units indicator for knots (nautical miles per hour)

L

listParsers() - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Returns a list of currently parseable sentence types.

M

MAGNETIC - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Char indicator for "magnetic"
MAX_LENGTH - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Maximum length of NMEA 0183 sentences, including BEGIN_CHAR and TERMINATOR.
MDASentence - Interface in net.sf.marineapi.nmea.sentence
Meteorological Composite - Barometric pressure, air and water temperature, humidity, dew point and wind speed and direction relative to the surface of the earth.
Measurement - Class in net.sf.marineapi.nmea.util
Sensor measurement data delivered by XDRSentence.
Measurement() - Constructor for class net.sf.marineapi.nmea.util.Measurement
Creates a new empty instance of Measurement.
Measurement(String, double, String, String) - Constructor for class net.sf.marineapi.nmea.util.Measurement
Creates a new instance of Measurement with given values.
MODE_AUTOMATIC - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Operating in automatic mode (2D/3D).
MODE_MANUAL - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Operating in manual mode (forced 2D or 3D).
MTASentence - Interface in net.sf.marineapi.nmea.sentence
Air temperature in degrees Celsius.
MTWSentence - Interface in net.sf.marineapi.nmea.sentence
Water temperature in degrees Celsius.
MWDSentence - Interface in net.sf.marineapi.nmea.sentence
Wind speed and true/magnetic direction, speed given in meters per second and knots.
MWVSentence - Interface in net.sf.marineapi.nmea.sentence
Wind speed and angle.

N

net.sf.marineapi.nmea.event - package net.sf.marineapi.nmea.event
Event/listener classes for receiving NMEA updates.
net.sf.marineapi.nmea.io - package net.sf.marineapi.nmea.io
Classes and interfaces for NMEA input/output.
net.sf.marineapi.nmea.parser - package net.sf.marineapi.nmea.parser
Parser implementations and factory for supported NMEA 0183 sentences.
net.sf.marineapi.nmea.sentence - package net.sf.marineapi.nmea.sentence
Public interfaces for supported NMEA 0183 sentences.
net.sf.marineapi.nmea.util - package net.sf.marineapi.nmea.util
Utilities and helper classes for handling the data extracted from NMEA sentences.
net.sf.marineapi.provider - package net.sf.marineapi.provider
Higher-level APIs that provide data value updates for selected measurements.
net.sf.marineapi.provider.event - package net.sf.marineapi.provider.event
Contains event classes and listener interfaces for Providers.
NM - Static variable in interface net.sf.marineapi.nmea.sentence.APBSentence
Nautical miles
NM - Static variable in interface net.sf.marineapi.nmea.sentence.VLWSentence
Nautical miles

O

onException(Exception) - Method in interface net.sf.marineapi.nmea.io.ExceptionListener
Invoked by SentenceReader when error has occured while reading the data source.

P

parse(String) - Static method in enum net.sf.marineapi.nmea.sentence.SentenceId
Parses the sentence id from specified sentence String and returns a corresponding SentenceId enum (assuming it exists).
parse(String) - Static method in enum net.sf.marineapi.nmea.sentence.TalkerId
Parses the talker id from specified sentence String and returns the corresponding TalkerId enum using the TalkerId.valueOf(String) method.
ParseException - Exception in net.sf.marineapi.nmea.parser
Thrown to indicate that parser is unable interpret the contents of requested data field.
ParseException(String) - Constructor for exception net.sf.marineapi.nmea.parser.ParseException
Constructor with description.
ParseException(String, Throwable) - Constructor for exception net.sf.marineapi.nmea.parser.ParseException
Constructor with message and cause.
parseStr(String) - Static method in enum net.sf.marineapi.nmea.sentence.SentenceId
Parses the sentence id from specified sentence String and returns it as String.
PIVOT_YEAR - Static variable in class net.sf.marineapi.nmea.util.Date
A pivot value that is used to determine century for two-digit year values.
Position - Class in net.sf.marineapi.nmea.util
Represents a geographic position.
Position(double, double) - Constructor for class net.sf.marineapi.nmea.util.Position
Creates a new instance of Position.
Position(double, double, double) - Constructor for class net.sf.marineapi.nmea.util.Position
Creates a new instance of position with latitude, longitude and altitude.
Position(double, double, Datum) - Constructor for class net.sf.marineapi.nmea.util.Position
Creates new instance of Position with latitude, longitude and datum.
Position(double, double, double, Datum) - Constructor for class net.sf.marineapi.nmea.util.Position
Creates new instance of Position with latitude, longitude, altitude and datum.
PositionEvent - Class in net.sf.marineapi.provider.event
GPS time/position/velocity report with current position, altitude, speed, course and a time stamp.
PositionEvent(Object, Position, double, double, Date, Time, FaaMode, GpsFixQuality) - Constructor for class net.sf.marineapi.provider.event.PositionEvent
Creates a new instance of PositionEvent.
PositionListener - Interface in net.sf.marineapi.provider.event
Listener interface for GPS time/position/velocity events.
PositionProvider - Class in net.sf.marineapi.provider
Provides Time, Position and Velocity reports from GPS.
PositionProvider(SentenceReader) - Constructor for class net.sf.marineapi.provider.PositionProvider
Creates a new instance of PositionProvider.
PositionSentence - Interface in net.sf.marineapi.nmea.sentence
Common interface for sentences that contain geographic position.
ProviderEvent - Class in net.sf.marineapi.provider.event
Abstract base class for provider events.
ProviderEvent(Object) - Constructor for class net.sf.marineapi.provider.event.ProviderEvent
Constructor
ProviderListener<T extends ProviderEvent> - Interface in net.sf.marineapi.provider.event
Base interface for provider listeners.
providerUpdate(HeadingEvent) - Method in interface net.sf.marineapi.provider.event.HeadingListener
 
providerUpdate(PositionEvent) - Method in interface net.sf.marineapi.provider.event.PositionListener
Invoked when fresh time/position/velocity report is available, typically once per second.
providerUpdate(T) - Method in interface net.sf.marineapi.provider.event.ProviderListener
Invoked when provider has new data available.
providerUpdate(SatelliteInfoEvent) - Method in interface net.sf.marineapi.provider.event.SatelliteInfoListener
Invoked when new satellite data is available.

R

readingPaused() - Method in class net.sf.marineapi.nmea.event.AbstractSentenceListener
Empty implementation.
readingPaused() - Method in interface net.sf.marineapi.nmea.event.SentenceListener
Called after SentenceReader has timed out for receiving new data.
readingPaused() - Method in class net.sf.marineapi.provider.AbstractProvider
 
readingStarted() - Method in class net.sf.marineapi.nmea.event.AbstractSentenceListener
Empty implementation.
readingStarted() - Method in interface net.sf.marineapi.nmea.event.SentenceListener
Called before SentenceReader starts dispatching events.
readingStarted() - Method in class net.sf.marineapi.provider.AbstractProvider
 
readingStopped() - Method in class net.sf.marineapi.nmea.event.AbstractSentenceListener
Empty implementation.
readingStopped() - Method in interface net.sf.marineapi.nmea.event.SentenceListener
Called after SentenceReader has permanently stopped reading, either due to an error or by calling the SentenceReader.stop() method.
readingStopped() - Method in class net.sf.marineapi.provider.AbstractProvider
 
registerParser(String, Class<? extends SentenceParser>) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Register a sentence parser to factory.
removeListener(ProviderListener<T>) - Method in class net.sf.marineapi.provider.AbstractProvider
Removes the specified listener from provider.
removeSentenceListener(SentenceListener) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Remove a listener from reader.
reset() - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Resets the factory in it's initial state, i.e. restores and removes all parsers the have been either removed or added.
reset() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
reset() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Resets the sentence contents, i.e. removes all existing values from data fields.
RMBSentence - Interface in net.sf.marineapi.nmea.sentence
Recommended minimum navigation information.
RMCSentence - Interface in net.sf.marineapi.nmea.sentence
Recommended minimum navigation information type C.
ROTSentence - Interface in net.sf.marineapi.nmea.sentence
Vessel's rate of turn given in degrees per minute.
RouteType - Enum in net.sf.marineapi.nmea.util
Defines the supported route types.
RPMSentence - Interface in net.sf.marineapi.nmea.sentence
Revolutions, measured from shaft or engine.
RSASentence - Interface in net.sf.marineapi.nmea.sentence
Rudder angle, measured in degrees.
RTESentence - Interface in net.sf.marineapi.nmea.sentence
GPS route data and list of waypoints.

S

SatelliteInfo - Class in net.sf.marineapi.nmea.util
SatelliteInfo represents the information about a single GPS satellite vehicle.
SatelliteInfo(String, int, int, int) - Constructor for class net.sf.marineapi.nmea.util.SatelliteInfo
Creates a new instance of SatelliteInfo
SatelliteInfoEvent - Class in net.sf.marineapi.provider.event
SatelliteInfoEvent contains the satellite information collected by SatelliteInfoProvider.
SatelliteInfoEvent(Object, GSASentence, List<SatelliteInfo>) - Constructor for class net.sf.marineapi.provider.event.SatelliteInfoEvent
 
SatelliteInfoListener - Interface in net.sf.marineapi.provider.event
 
SatelliteInfoProvider - Class in net.sf.marineapi.provider
SatelliteInfoProvider collects GPS satellite information from sequence of GSV sentences and reports all the information in a single event.
SatelliteInfoProvider(SentenceReader) - Constructor for class net.sf.marineapi.provider.SatelliteInfoProvider
Creates a new instance of SatelliteInfoProvider with specified reader.
Sentence - Interface in net.sf.marineapi.nmea.sentence
Base interface and constants for NMEA 0183 sentences.
SentenceEvent - Class in net.sf.marineapi.nmea.event
Sentence events occur when a valid NMEA 0183 sentence has been read from the data source.
SentenceEvent(Object, Sentence) - Constructor for class net.sf.marineapi.nmea.event.SentenceEvent
Creates a new SentenceEvent object.
SentenceFactory - Class in net.sf.marineapi.nmea.parser
Factory for creating sentence parsers.
SentenceId - Enum in net.sf.marineapi.nmea.sentence
Defines the supported NMEA 0831 sentence types.
SentenceListener - Interface in net.sf.marineapi.nmea.event
Base interface for listening to SentenceEvents.
SentenceParser - Class in net.sf.marineapi.nmea.parser
Base class for all NMEA 0183 sentence parsers.
SentenceParser(String) - Constructor for class net.sf.marineapi.nmea.parser.SentenceParser
Creates a new instance of SentenceParser.
SentenceParser(char, TalkerId, String, int) - Constructor for class net.sf.marineapi.nmea.parser.SentenceParser
Creates a new empty sentence with specified begin character, talker and sentence IDs.
SentenceParser(String, String) - Constructor for class net.sf.marineapi.nmea.parser.SentenceParser
Creates a new instance of SentenceParser.
SentenceParser(TalkerId, String, int) - Constructor for class net.sf.marineapi.nmea.parser.SentenceParser
Creates a new empty sentence with specified talker and sentence IDs.
sentenceRead(T) - Method in class net.sf.marineapi.nmea.event.AbstractSentenceListener
Invoked when sentence of type T has been read and parsed.
sentenceRead(SentenceEvent) - Method in class net.sf.marineapi.nmea.event.AbstractSentenceListener
Resolves the type of each received sentence parser and passes it to sentenceRead(T) if the type matches the expected type T.
sentenceRead(SentenceEvent) - Method in interface net.sf.marineapi.nmea.event.SentenceListener
Called by SentenceReader when a single NMEA 0183 sentence has been read and parsed from the data stream.
sentenceRead(SentenceEvent) - Method in class net.sf.marineapi.provider.AbstractProvider
 
SentenceReader - Class in net.sf.marineapi.nmea.io
Sentence reader detects supported NMEA 0183 sentences from the specified data source and dispatches them to registered listeners as sentence events.
SentenceReader(DatagramSocket) - Constructor for class net.sf.marineapi.nmea.io.SentenceReader
Creates a SentenceReader for UDP/DatagramSocket.
SentenceReader(InputStream) - Constructor for class net.sf.marineapi.nmea.io.SentenceReader
Creates a new instance of SentenceReader.
SentenceValidator - Class in net.sf.marineapi.nmea.sentence
SentenceValidator for detecting and validation of sentence Strings.
setAbsoluteHumidity(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the absolute humidity.
setAcquisitionType(AcquisitionType) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the acquisition type of the target.
setAirTemperature(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the air temperature.
setAltitude(double) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Set the antenna altitude.
setAltitude(double) - Method in class net.sf.marineapi.nmea.util.Position
Sets the altitude of position above or below mean sea level.
setAltitudeUnits(Units) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Sets the unit of altitude.
setAngle(double) - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Set wind angle.
setArrivalCircleEntered(boolean) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the arrival circle enter status.
setArrivalStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set the arrival to waypoint status.
setAzimuth(int) - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Set satellite azimuth, in degrees from true north (0..359°).
setBearing(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set true bearing to destination, in degrees.
setBearing(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the true bearing from the radar to the target.
setBearingOriginToDestination(double) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the bearing from origin to destination.
setBearingOriginToDestionationTrue(boolean) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the bearing from origin to destination true or magnetic.
setBearingPositionToDestination(double) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the bearing from current position to destination waypoint.
setBearingPositionToDestinationTrue(boolean) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the bearing from current position to destination true or magnetic.
setBeginChar(char) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
setBeginChar(char) - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Set the sentence begin character.
setCharValue(int, char) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set a character in specified field.
setCourse(double) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set true course over ground (COG).
setCourse(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the course of the target.
setCrossTrackError(double) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the cross-track error magnitude/distance.
setCrossTrackError(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set cross track error (XTE), in nautical miles.
setCrossTrackUnits(char) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the unit of cross-track error.
setCycleLockStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the Loran-C cycle lock status.
setCycleLockStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Sets the Loran-C cycle lock status.
setDatagramSocket(DatagramSocket) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Sets the DatagramSocket to be used as data source.
setDataListener(DataListener) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Set listener for any data that is not recognized as NMEA 0183.
setDate(Date) - Method in interface net.sf.marineapi.nmea.sentence.DateSentence
Set date.
setDatumCode(String) - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Sets the local datum code.
setDatumSubCode(String) - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Sets the local datum code, may be blank.
setDay(int) - Method in class net.sf.marineapi.nmea.util.Date
Set day of month.
setDegreesValue(int, double) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set degrees value, e.g. course or heading.
setDepth(double) - Method in interface net.sf.marineapi.nmea.sentence.DepthSentence
Set depth of water, in meters.
setDescription(String) - Method in class net.sf.marineapi.nmea.util.Waypoint
Sets the waypoint description.
setDestination(Waypoint) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set the destination waypoint.
setDestinationWaypointId(String) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Returns the destination waypoint id/name.
setDestinationWaypointId(String) - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Sets the destination waypoint ID.
setDeviation(double) - Method in interface net.sf.marineapi.nmea.sentence.HDGSentence
Set magnetic deviation.
setDewPoint(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the dew point temperature.
setDgpsAge(double) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Sets the age of differential GPS data (DGPS).
setDgpsStationId(String) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Sets the ID of DGPS station.
setDirectionOfVariation(CompassPoint) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set the direction of magnetic variation, east or west.
setDistance(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the distance from the radar to the target.
setDistanceOfCPA(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the distance at CPA.
setDoubleValue(int, double) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set double value in specified field.
setDoubleValue(int, double, int, int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set double value in specified field, with given number of digits before and after the decimal separator ('.').
setElevation(int) - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Set satellite elevation, in degrees (max. 90°).
setExceptionListener(ExceptionListener) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Set exception call-back listener.
setFathoms(double) - Method in interface net.sf.marineapi.nmea.sentence.DBTSentence
Set depth value, in fathoms.
setFeet(double) - Method in interface net.sf.marineapi.nmea.sentence.DBTSentence
Set depth value, in feet.
setFieldCount(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Sets the number of sentence data fields.
setFixQuality(GpsFixQuality) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Sets the GPS fix quality.
setFixStatus(GpsFixStatus) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set the GPS fix mode; 2D, 3D or no fix.
setGeoidalHeight(double) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Set height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level.
setGeoidalHeightUnits(Units) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Get unit of height above geoid.
setGroundSpeedStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Ground Speed Status.
setHeading(double) - Method in interface net.sf.marineapi.nmea.sentence.HeadingSentence
Sets the heading value.
setHeadingToDestination(double) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the heading to destination waypoint.
setHeadingToDestinationTrue(boolean) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the heading to destionation true or magnetic.
setHorizontalDOP(double) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence
Set the horizontal dilution of precision (HDOP), i.e. the relative accuracy of horizontal position.
setHorizontalDOP(double) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set the horizontal dilution of precision (HDOP).
setHour(int) - Method in class net.sf.marineapi.nmea.util.Time
Set the hour of day.
setId(int) - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Sets the engine or shaft number/id.
setId(String) - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Set the ID of satellite vehicle, for example "05".
setId(String) - Method in class net.sf.marineapi.nmea.util.Waypoint
Set the id of Waypoint
setInputStream(InputStream) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Sets the InputStream to be used as data source.
setInterval(int) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Sets the reader interval, i.e. pause time between read attempts.
setIntValue(int, int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set integer value in specified field.
setIntValue(int, int, int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set integer value in specified field, with specified minimum number of digits.
setLatitude(double) - Method in class net.sf.marineapi.nmea.util.Position
Set the latitude degrees of Position
setLatitudeOffset(double) - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Sets the latitude offset.
setLocalZoneHours(int) - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Set offset to local time zone in hours.
setLocalZoneMinutes(int) - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Set offset to local time zone in minutes.
setLongGroundSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Longitudinal Ground Speed.
setLongitude(double) - Method in class net.sf.marineapi.nmea.util.Position
Set the longitude degrees of Position
setLongitudeOffset(double) - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Sets the longitude offset.
setLongWaterSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Longitudinal Water Speed.
setMagneticBearing(double) - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Sets the true bearing from origin to destination, in degrees.
setMagneticCourse(double) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Set the magnetic course over ground.
setMagneticDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Sets the magnetic direction of current.
setMagneticHeading(double) - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Sets the magnetic heading.
setMagneticWindDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the magnetic wind direction.
setMagneticWindDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
Sets the magnetic wind direction.
setMagnitude(double) - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Sets the cross-track error magnitude/distance.
setMaximum(double) - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence
Set maximum depth value the sounder can detect.
setMeasurement(Measurement) - Method in interface net.sf.marineapi.nmea.sentence.XDRSentence
Set single measurement.
setMeasurements(List<Measurement>) - Method in interface net.sf.marineapi.nmea.sentence.XDRSentence
Set multiple measurements in given order.
setMinutes(int) - Method in class net.sf.marineapi.nmea.util.Time
Set the minute of hour.
setMode(FaaMode) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set the FAA operation mode of GPS.
setMode(FaaMode) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set the FAA operation mode of GPS.
setMode(FaaMode) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Set the FAA operating mode of GPS receiver.
setMode(FaaMode) - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Sets the FAA mode.
setMonth(int) - Method in class net.sf.marineapi.nmea.util.Date
Get month, valid values are 1-12 where 1 denotes January, 2 denotes February etc.
setName(String) - Method in interface net.sf.marineapi.nmea.sentence.DTMSentence
Sets the datum name.
setName(String) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the name of the target.
setName(String) - Method in class net.sf.marineapi.nmea.util.Measurement
Sets the name of transducer.
setNoise(int) - Method in class net.sf.marineapi.nmea.util.SatelliteInfo
Set the satellite signal noise ratio, in dB (0-99 dB).
setNumber(int) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the number of the target.
setOffset(double) - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence
Set offset to transducer.
setOffsetHours(int) - Method in class net.sf.marineapi.nmea.util.Time
Set time zone offset hours.
setOffsetMinutes(int) - Method in class net.sf.marineapi.nmea.util.Time
Set time zone offset minutes.
setOriginId(String) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set the ID of origin waypoint.
setOriginWaypointId(String) - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Sets the ID of origin waypoint.
setPauseTimeout(int) - Method in class net.sf.marineapi.nmea.io.SentenceReader
Set timeout time for reading paused events.
setPerpendicularPassed(boolean) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the perpendicular to waypoint pass status.
setPitch(double) - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Sets the propeller pitch, % of maximum.
setPosition(Position) - Method in interface net.sf.marineapi.nmea.sentence.PositionSentence
Set the geographic position.
setPositionDOP(double) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set the dilution of precision for position.
setPrimaryBarometricPressure(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the primary barometric pressure value.
setPrimaryBarometricPressureUnit(char) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the barometric pressure unit.
setRange(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set range to destination waypoint.
setRateOfTurn(double) - Method in interface net.sf.marineapi.nmea.sentence.ROTSentence
Sets the vessel's rate of turn value.
setReference(boolean) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
A target may be used to calculate own ship position.
setRelativeHumidity(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the relative humidity
setRouteId(String) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Set the route name or number.
setRouteType(RouteType) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Set the type of route.
setRudderAngle(Side, double) - Method in interface net.sf.marineapi.nmea.sentence.RSASentence
Sets the rudder's angle for specified side.
setSatelliteCount(int) - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Set the number of satellites in view.
setSatelliteIds(String[]) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set list of satellites used for acquiring the GPS fix.
setSatelliteInfo(List<SatelliteInfo>) - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Set the satellite information.
setSecondaryBarometricPressure(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the barometric pressure value.
setSecondaryBarometricPressureUnit(char) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the secondary barometric pressure unit.
setSeconds(double) - Method in class net.sf.marineapi.nmea.util.Time
Set seconds of minute.
setSentenceCount(int) - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Set the total number of sentences in GSV sequence.
setSentenceCount(int) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Set the number of sentences in RTE sequence.
setSentenceIndex(int) - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence
Set the index of this sentence in GSV sequence.
setSentenceIndex(int) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Set the index of sentence in RTE sequence.
setSource(char) - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Sets the source indicator, engine or shaft.
setSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Set the wind speed value.
setSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set current speed over ground (SOG).
setSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the speed of the target.
setSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Sets the current flow speed.
setSpeedKmh(double) - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Sets the water speed in km/h.
setSpeedKmh(double) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Set the current speed over ground.
setSpeedKnots(double) - Method in interface net.sf.marineapi.nmea.sentence.VHWSentence
Sets the water speed in knots.
setSpeedKnots(double) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Set the speed over ground, in knots.
setSpeedUnit(Units) - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Set wind speed unit.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Sets the signal/fix status, LORAN-C Blink or SNR warning.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.GLLSentence
Set the data quality status, valid or invalid.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Set data validity status.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set status of sentence data, valid or invalid.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set the data status, valid or invalid.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.ROTSentence
Sets the data status.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.RPMSentence
Sets the data validity status.
setStatus(Side, DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.RSASentence
Set data status for specified side.
setStatus(TargetStatus) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the Status of the target.
setStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Sets the signal/fix status.
setSteerTo(Direction) - Method in interface net.sf.marineapi.nmea.sentence.APBSentence
Set direction in which to steer in order to get back on route.
setSteerTo(Direction) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set the direction to steer to correct error (left/right).
setSteerTo(Direction) - Method in interface net.sf.marineapi.nmea.sentence.XTESentence
Set direction in which to steer in order to get back on route.
setSternGroundSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Stern Ground Speed.
setSternGroundSpeedStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Stern Ground Speed Status.
setSternWaterSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Stern Water Speed.
setSternWaterSpeedStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Stern Water Speed Status.
setStringValue(int, String) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Set String value in specified data field.
setStringValues(int, String[]) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
Replace multiple fields with given String array, starting at the specified index.
setTalkerId(TalkerId) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
setTalkerId(TalkerId) - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Set the talker ID of the sentence.
setTemperature(double) - Method in interface net.sf.marineapi.nmea.sentence.MTASentence
Sets the air temperature.
setTemperature(double) - Method in interface net.sf.marineapi.nmea.sentence.MTWSentence
Set the water temperature.
setTime(Time) - Method in interface net.sf.marineapi.nmea.sentence.TimeSentence
Set the time of day.
setTime(Date) - Method in class net.sf.marineapi.nmea.util.Time
Set the time by Date.
setTimeAndLocalZone(Time) - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Set time and local time zone hours and minutes.
setTimeToCPA(double) - Method in interface net.sf.marineapi.nmea.sentence.TTMSentence
Set the time to CPA.
setTotal(double) - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Sets the total cumulative distance traveled.
setTotalUnits(char) - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Sets the units of measure for cumulative total distance.
setTravGroundSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Transverse Ground Speed.
setTravWaterSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Transverse Water Speed.
setTrip(double) - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Sets the distance traveled since last reset.
setTripUnits(char) - Method in interface net.sf.marineapi.nmea.sentence.VLWSentence
Sets the units of measure for distance since last reset.
setTrue(boolean) - Method in interface net.sf.marineapi.nmea.sentence.MWVSentence
Set angle to relative or true.
setTrueBearing(double) - Method in interface net.sf.marineapi.nmea.sentence.BODSentence
Sets the true bearing from origin to destination, in degrees.
setTrueCourse(double) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence
Set the true course over ground.
setTrueDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.VDRSentence
Sets the true direction of current.
setTrueWindDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the True wind direction.
setTrueWindDirection(double) - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
Sets the true wind direction.
setType(String) - Method in class net.sf.marineapi.nmea.util.Measurement
Sets the type of measurement.
setUnits(String) - Method in class net.sf.marineapi.nmea.util.Measurement
Sets the units of measurement.
setValue(double) - Method in class net.sf.marineapi.nmea.util.Measurement
Sets the measurement value.
setVariation(double) - Method in interface net.sf.marineapi.nmea.sentence.HDGSentence
Set magnetic variation.
setVariation(double) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence
Set the magnetic variation.
setVelocity(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence
Set velocity towards destination.
setVerticalDOP(double) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence
Set the vertical dilution of precision (VDOP).
setWaterSpeedStatus(DataStatus) - Method in interface net.sf.marineapi.nmea.sentence.VBWSentence
Sets Water Speed Status.
setWaterTemperature(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the Water temperature.
setWaypoint(Waypoint) - Method in interface net.sf.marineapi.nmea.sentence.WPLSentence
Set the destination waypoint.
setWaypointIds(String[]) - Method in interface net.sf.marineapi.nmea.sentence.RTESentence
Set the list of route waypoints.
setWindSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the wind speed.
setWindSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
Sets the wind speed in meters per second.
setWindSpeedKnots(double) - Method in interface net.sf.marineapi.nmea.sentence.MDASentence
Sets the wind speed, in knots.
setWindSpeedKnots(double) - Method in interface net.sf.marineapi.nmea.sentence.MWDSentence
Sets the wind speed in knots.
setYear(int) - Method in class net.sf.marineapi.nmea.util.Date
Set year.
SHAFT - Static variable in interface net.sf.marineapi.nmea.sentence.RPMSentence
Source indicator for shaft
Side - Enum in net.sf.marineapi.nmea.util
Defines the sides of a boat, i.e.
start() - Method in class net.sf.marineapi.nmea.io.SentenceReader
Starts reading the input stream and dispatching events.
stop() - Method in class net.sf.marineapi.nmea.io.SentenceReader
Stops the reader and event dispatching.

T

TalkerId - Enum in net.sf.marineapi.nmea.sentence
The enumeration of Talker IDs, i.e. the first two characters in sentence's address field.
TargetStatus - Enum in net.sf.marineapi.nmea.util
Defines the status of a target reported in a TTM sentence.
TERMINATOR - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence
Sentence terminator <CR><LF>.
Time - Class in net.sf.marineapi.nmea.util
Represents a time of day in 24-hour clock, i.e. the UTC time used as default in NMEA 0183.
Time() - Constructor for class net.sf.marineapi.nmea.util.Time
Creates a new instance of Time using the current system time.
Time(String) - Constructor for class net.sf.marineapi.nmea.util.Time
Creates a new instance of Time based on given String.
Time(int, int, double) - Constructor for class net.sf.marineapi.nmea.util.Time
Creates a new instance of Time with hours, minutes and seconds.
Time(int, int, double, int, int) - Constructor for class net.sf.marineapi.nmea.util.Time
Creates a new instance of Time with time zone offsets.
TimeSentence - Interface in net.sf.marineapi.nmea.sentence
Interface for sentences that provide UTC time.
toChar() - Method in enum net.sf.marineapi.nmea.util.AcquisitionType
Returns the corresponding char constant.
toChar() - Method in enum net.sf.marineapi.nmea.util.CompassPoint
Returns the corresponding char constant.
toChar() - Method in enum net.sf.marineapi.nmea.util.DataStatus
Returns the character used in NMEA sentences to indicate the status.
toChar() - Method in enum net.sf.marineapi.nmea.util.Direction
Returns the corresponding char constant.
toChar() - Method in enum net.sf.marineapi.nmea.util.FaaMode
Returns the corresponding char indicator of GPS mode.
toChar() - Method in enum net.sf.marineapi.nmea.util.RouteType
Get the corresponding char indicator of enum.
toChar() - Method in enum net.sf.marineapi.nmea.util.Side
Returns the corresponding char constant.
toChar() - Method in enum net.sf.marineapi.nmea.util.TargetStatus
Returns the corresponding char constant.
toChar() - Method in enum net.sf.marineapi.nmea.util.Units
Returns the corresponding char constant.
toDate() - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence
Get date and time as Date.
toDate() - Method in class net.sf.marineapi.nmea.util.Date
Converts to Date, time of day set to 00:00:00.000.
toDate(Date) - Method in class net.sf.marineapi.nmea.util.Time
Convert to Date.
toInt() - Method in enum net.sf.marineapi.nmea.util.GpsFixQuality
Returns the corresponding int indicator for fix quality.
toInt() - Method in enum net.sf.marineapi.nmea.util.GpsFixStatus
Returns the corresponding int value for fix status enum.
toISO8601() - Method in class net.sf.marineapi.nmea.util.Date
Returns the date in ISO 8601 format (yyyy-mm-dd).
toISO8601(Time) - Method in class net.sf.marineapi.nmea.util.Date
Returns a timestamp in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm).
toISO8601() - Method in class net.sf.marineapi.nmea.util.Time
Returns the ISO 8601 representation of time (hh:mm:ss+hh:mm).
toSentence() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
toSentence(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
toSentence() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Formats and validates the String representation of sentence.
toSentence(int) - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Formats and validates the sentence like Sentence.toSentence(), but checks also that resulting String does not exceed specified length.
toString() - Method in class net.sf.marineapi.nmea.parser.SentenceParser
 
toString() - Method in interface net.sf.marineapi.nmea.sentence.Sentence
Returns the String representation of the sentence, without line terminator CR/LR.
toString() - Method in class net.sf.marineapi.nmea.util.Date
Returns the String representation of Date.
toString() - Method in class net.sf.marineapi.nmea.util.Position
 
toString() - Method in class net.sf.marineapi.nmea.util.Time
Returns the String representation of Time.
toString() - Method in class net.sf.marineapi.provider.event.HeadingEvent
 
toString() - Method in class net.sf.marineapi.provider.event.PositionEvent
 
toWaypoint(String) - Method in class net.sf.marineapi.nmea.util.Position
Convenience method for creating a waypoint based in the Position.
TRUE - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence
Char indicator for "true"
TTMSentence - Interface in net.sf.marineapi.nmea.sentence
Tracked Target Message.

U

Units - Enum in net.sf.marineapi.nmea.util
Defines the supported units of measure.
unregisterParser(Class<? extends SentenceParser>) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory
Unregisters a parser class, regardless of sentence type(s) it is registered for.

V

valueOf(String) - Static method in enum net.sf.marineapi.nmea.sentence.SentenceId
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.sentence.TalkerId
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.AcquisitionType
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.AcquisitionType
Get the enum corresponding to specified char.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.CompassPoint
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.CompassPoint
Get the enum corresponding to specified char.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.DataStatus
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.DataStatus
Returns the DataStatus enum for status char used in sentences.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.Datum
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.Direction
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.Direction
Get the enum corresponding to specified char.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.FaaMode
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.FaaMode
Returns the FaaMode enum corresponding the actual char indicator used in the sentencess.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.GpsFixQuality
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum net.sf.marineapi.nmea.util.GpsFixQuality
Get GpsFixQuality enum that corresponds the actual integer identifier used in the sentences.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.GpsFixStatus
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum net.sf.marineapi.nmea.util.GpsFixStatus
Returns the GpsFixStatus enum corresponding to actual int identifier used in the sentences.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.RouteType
Returns the enum constant of this type with the specified name.
valueOf(char) - Method in enum net.sf.marineapi.nmea.util.RouteType
Get the char indicator corresponding to enum.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.Side
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.Side
Get the enum corresponding to specified char.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.TargetStatus
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.TargetStatus
Get the enum corresponding to specified char.
valueOf(String) - Static method in enum net.sf.marineapi.nmea.util.Units
Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.Units
Get the enum corresponding to specified char.
values() - Static method in enum net.sf.marineapi.nmea.sentence.SentenceId
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.sentence.TalkerId
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.AcquisitionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.CompassPoint
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.DataStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.Datum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.Direction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.FaaMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.GpsFixQuality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.GpsFixStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.RouteType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.Side
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.TargetStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.marineapi.nmea.util.Units
Returns an array containing the constants of this enum type, in the order they are declared.
VBWSentence - Interface in net.sf.marineapi.nmea.sentence
VBW Dual Ground/Water Speed Longitudinal, Transverse and Stern Ground/Water Speed with Status.
VDRSentence - Interface in net.sf.marineapi.nmea.sentence
Set and drift, true/magnetic direction and speed of current.
VHWSentence - Interface in net.sf.marineapi.nmea.sentence
Water speed and heading in respect to true and magnetic north.
VLWSentence - Interface in net.sf.marineapi.nmea.sentence
Distance traveled through water, cumulative and trip.
VTGSentence - Interface in net.sf.marineapi.nmea.sentence
Course and speed over the ground.

W

Waypoint - Class in net.sf.marineapi.nmea.util
Waypoint represents a named geographic location.
Waypoint(String, double, double) - Constructor for class net.sf.marineapi.nmea.util.Waypoint
Creates a new instance of Waypoint with default WGS84 datum.
Waypoint(String, double, double, double) - Constructor for class net.sf.marineapi.nmea.util.Waypoint
Creates a new instance of Waypoint with default WGS84 datum.
Waypoint(String, double, double, Datum) - Constructor for class net.sf.marineapi.nmea.util.Waypoint
Creates a new instance of Waypoint with explicitly specified datum.
Waypoint(String, double, double, double, Datum) - Constructor for class net.sf.marineapi.nmea.util.Waypoint
Creates a new instance of Waypoint with explicitly specified datum.
WPLSentence - Interface in net.sf.marineapi.nmea.sentence
Destination waypoint location and ID.

X

XDRSentence - Interface in net.sf.marineapi.nmea.sentence
Transducer measurements.
xor(String) - Static method in class net.sf.marineapi.nmea.sentence.Checksum
Calculates XOR checksum of given String.
XTESentence - Interface in net.sf.marineapi.nmea.sentence
Measured cross-track error when navigating towards waypoint.

Z

ZDASentence - Interface in net.sf.marineapi.nmea.sentence
UTC time and date with local time zone offset.
A B C D E F G H I K L M N O P R S T U V W X Z 

Copyright (C) 2010-2015 Java Marine API authors. All Rights Reserved.