Index (Java Marine API v0.4 (b20110712215512))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

A

add(String) - Static method in class net.sf.marineapi.nmea.sentence.Checksum: Calculates and adds a checksum to specified sentence String.
addListener(TPVListener) - Method in class net.sf.marineapi.provider.TPVProvider: Inserts a listener to provider.
ADDRESS_FIELD - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence: Address field index, the first field of all sentences.
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.

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 the checksum of sentence String.
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.TPVEvent
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 sentence String.

D

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
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(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.
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 the distance to specified Position.
DPTSentence - Interface in net.sf.marineapi.nmea.sentence: Depth of water, in meters.

E

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

F

FIELD_DELIMITER - Static variable in interface net.sf.marineapi.nmea.sentence.Sentence: Sentence data fields delimiter char
finalize() - Method in class net.sf.marineapi.nmea.io.SentenceReader

G

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.
getAltitudeUnits() - Method in interface net.sf.marineapi.nmea.sentence.GGASentence: Gets the altitude units, meters or feet.
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.
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 class net.sf.marineapi.provider.event.TPVEvent: Returns the current (true) course over ground.
getCrossTrackError() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Get cross track error (XTE).
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.TPVEvent: 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.
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.
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.
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°).
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.TPVEvent: 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.
getGpsMode() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence: Get the GPS operation mode.
getGpsMode() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence: Get the GPS operating mode.
getGpsMode() - Method in class net.sf.marineapi.provider.event.TPVEvent: Returns the current GPS operating mode.
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).
getHour() - Method in class net.sf.marineapi.nmea.util.Time: Get the hour of day.
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.
getIntValue(int) - Method in class net.sf.marineapi.nmea.parser.SentenceParser: Parse integer value from the specified sentence field.
getLatHemisphere() - Method in class net.sf.marineapi.nmea.util.Position: Get the hemisphere of latitude (North/South).
getLatitude() - Method in class net.sf.marineapi.nmea.util.Position: Get latitude value of Position
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.
getLongitude() - Method in class net.sf.marineapi.nmea.util.Position: Get longitude value of Position
getLonHemisphere() - Method in class net.sf.marineapi.nmea.util.Position: Get the hemisphere of longitude (East/West).
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.
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.VTGSentence: Get the GPS receiver operating mode.
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.
getNoise() - Method in class net.sf.marineapi.nmea.util.SatelliteInfo: Get satellite the signal noise ratio, in dB (0-99 dB).
getOffset() - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence: Get offset to transducer.
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.
getPosition() - Method in interface net.sf.marineapi.nmea.sentence.PositionSentence: Gets the geographic position.
getPosition() - Method in class net.sf.marineapi.provider.event.TPVEvent: Returns the current position.
getPositionDOP() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence: Get the dilution of precision (PDOP) for position.
getRange() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Get range to destination waypoint.
getRouteId() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence: Get the number or name of the route.
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.
getSatelliteInfo() - Method in interface net.sf.marineapi.nmea.sentence.GSVSentence: Get the satellites information.
getSatellitesIds() - Method in interface net.sf.marineapi.nmea.sentence.GSASentence: Get list of satellites used for acquiring the GPS fix.
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.
getSpeed() - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence: Get current speed over ground (SOG).
getSpeed() - Method in class net.sf.marineapi.provider.event.TPVEvent: Returns the current speed over ground, in km/h.
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.VTGSentence: Get speed over ground in knots.
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.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.
getSteerTo() - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Get the direction to steer to correct error (left/right).
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.
getTime() - Method in interface net.sf.marineapi.nmea.sentence.TimeSentence: Get the time of day.
getTime() - Method in class net.sf.marineapi.provider.event.TPVEvent: 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 the Waypoint was created.
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.
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).
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.
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.
GpsMode - Enum in net.sf.marineapi.nmea.util: GpsMode defines the supported GPS operating modes.
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

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
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.

I

isActiveRoute() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence: Tells if the sentence holds a current active route data.
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.
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.
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.
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: Validates of the specified String against NMEA 0183 sentence format.
isWorkingRoute() - Method in interface net.sf.marineapi.nmea.sentence.RTESentence: Tells if the sentence holds a current working route data.

K

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)

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.
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).

N

net.sf.marineapi.nmea.event - package net.sf.marineapi.nmea.event: Provides event classes and listener interfaces for receiving NMEA updates.
net.sf.marineapi.nmea.io - package net.sf.marineapi.nmea.io: Basic input/output related classes and interfaces for reading and writing NMEA sentences.
net.sf.marineapi.nmea.parser - package net.sf.marineapi.nmea.parser: Contains base classes and parser implementations for supported NMEA sentences.
net.sf.marineapi.nmea.sentence - package net.sf.marineapi.nmea.sentence: Provides interfaces for supported NMEA 0183 sentences.
net.sf.marineapi.nmea.util - package net.sf.marineapi.nmea.util: Provides utilities and helper classes for handling the data extracted from NMEA sentences.
net.sf.marineapi.provider - package net.sf.marineapi.provider
net.sf.marineapi.provider.event - package net.sf.marineapi.provider.event

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, CompassPoint, double, CompassPoint) - Constructor for class net.sf.marineapi.nmea.util.Position: Creates a new instance of Position.
Position(double, CompassPoint, double, CompassPoint, Datum) - Constructor for class net.sf.marineapi.nmea.util.Position: Creates new instance of Position.
PositionSentence - Interface in net.sf.marineapi.nmea.sentence: Common interface for sentences that contain geographic position.

R

readingPaused() - Method in interface net.sf.marineapi.nmea.event.SentenceListener: Called when NMEA data flow has paused for some reason, e.g. when reached the end of file or device has stopped providing data, but the reader is still running and waiting for more data.
readingPaused() - Method in class net.sf.marineapi.provider.TPVProvider
readingStarted() - Method in interface net.sf.marineapi.nmea.event.SentenceListener: Called when NMEA data is found in stream and reader starts dispatching SentenceEvents.
readingStarted() - Method in class net.sf.marineapi.provider.TPVProvider
readingStopped() - Method in interface net.sf.marineapi.nmea.event.SentenceListener: Invoked after SentenceReader has stopped reading the input stream, either due to error or explicit request by calling SentenceReader.stop().
readingStopped() - Method in class net.sf.marineapi.provider.TPVProvider
registerParser(String, Class<? extends SentenceParser>) - Method in class net.sf.marineapi.nmea.parser.SentenceFactory: Register a sentence parser to factory.
removeListener(TPVListener) - Method in class net.sf.marineapi.provider.TPVProvider: Removes the specified listener from provider.
removeSentenceListener(SentenceListener) - Method in class net.sf.marineapi.nmea.io.SentenceReader: Remove a listener from reader.
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.
RouteType - Enum in net.sf.marineapi.nmea.util: Defines the supported route types.
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
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 sentence parser for all NMEA sentence types.
SentenceParser(String) - Constructor for class net.sf.marineapi.nmea.parser.SentenceParser: Creates a new instance of SentenceParser.
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(SentenceEvent) - Method in interface net.sf.marineapi.nmea.event.SentenceListener: Invoked when valid NMEA 0183 data has been read by SentenceReader.
sentenceRead(SentenceEvent) - Method in class net.sf.marineapi.provider.TPVProvider
SentenceReader - Class in net.sf.marineapi.nmea.io: Sentence provider reads NMEA sentences from the specified InputStream and dispatches them to listeners as SentenceEvents.
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 checks any String against NMEA 0183 format.
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 mean sea level.
setAltitudeUnits(Units) - Method in interface net.sf.marineapi.nmea.sentence.GGASentence: Sets the unit of altitude.
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.
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).
setCrossTrackError(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Set cross track error (XTE), in nautical miles.
setDate(Date) - Method in interface net.sf.marineapi.nmea.sentence.DateSentence: Set date.
setDay(int) - Method in class net.sf.marineapi.nmea.util.Date: Set day of month.
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.BODSentence: Sets the destination waypoint ID.
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.
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°).
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.
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.
setGpsMode(GpsMode) - Method in interface net.sf.marineapi.nmea.sentence.GSASentence: Set the GPS operation mode.
setGpsMode(GpsMode) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence: Set the GPS operation mode.
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(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 input stream from which to read NMEA data.
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.
setLatHemisphere(CompassPoint) - Method in class net.sf.marineapi.nmea.util.Position: Set the hemisphere of latitude (North/South).
setLatitude(double) - Method in class net.sf.marineapi.nmea.util.Position: Set the latitude degrees of Position
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.
setLongitude(double) - Method in class net.sf.marineapi.nmea.util.Position: Set the longitude degrees of Position
setLonHemisphere(CompassPoint) - Method in class net.sf.marineapi.nmea.util.Position: Set the hemisphere of longitude (East/West).
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.
setMinutes(int) - Method in class net.sf.marineapi.nmea.util.Time: Set the minute of hour.
setMode(GpsMode) - Method in interface net.sf.marineapi.nmea.sentence.VTGSentence: Set the GPS receiver operating 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.
setNoise(int) - Method in class net.sf.marineapi.nmea.util.SatelliteInfo: Set the satellite signal noise ratio, in dB (0-99 dB).
setOffset(double) - Method in interface net.sf.marineapi.nmea.sentence.DPTSentence: Set offset to transducer.
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.
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.
setRange(double) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Set range to destination waypoint.
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.
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.
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.
setSpeed(double) - Method in interface net.sf.marineapi.nmea.sentence.RMCSentence: Set current speed over ground (SOG).
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.VTGSentence: Set the speed over ground, in knots.
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.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.
setSteerTo(Direction) - Method in interface net.sf.marineapi.nmea.sentence.RMBSentence: Set the direction to steer to correct error (left/right).
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.
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 values from specified Date.
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.
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).
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.
setYear(int) - Method in class net.sf.marineapi.nmea.util.Date: Set year.
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 NMEA Talker IDs, i.e. the first two characters in sentence's address field.
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(int, int, double) - Constructor for class net.sf.marineapi.nmea.util.Time: Creates a new instance of Time.
TimeSentence - Interface in net.sf.marineapi.nmea.sentence: Interface for sentences that provide UTC time.
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.GpsMode: 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.Units: Returns the corresponding char constant.
toDate() - Method in interface net.sf.marineapi.nmea.sentence.ZDASentence: Get date and time as Date.
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.
toSentence() - 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 without the line terminator CR/LF.
toString() - Method in class net.sf.marineapi.nmea.parser.SentenceParser: Returns the String representation of the sentence (without line terminator CR/LR).
toString() - Method in interface net.sf.marineapi.nmea.sentence.Sentence: Returns the String representation of sentence in NMEA 0183 format.
toString() - Method in class net.sf.marineapi.nmea.util.Date
toString() - Method in class net.sf.marineapi.nmea.util.Position
toString() - Method in class net.sf.marineapi.nmea.util.Time
toString() - Method in class net.sf.marineapi.provider.event.TPVEvent
toWaypoint(String) - Method in class net.sf.marineapi.nmea.util.Position: Convenience method for creating a waypoint based in the Position.
TPVEvent - Class in net.sf.marineapi.provider.event: GPS time/position/velocity report with current position, altitude, speed, course and a time stamp.
TPVEvent(Object, Position, double, double, Date, Time, GpsMode, GpsFixQuality) - Constructor for class net.sf.marineapi.provider.event.TPVEvent: Creates a new instance of TPVEvent.
TPVListener - Interface in net.sf.marineapi.provider.event: Listener interface for GPS time/position/velocity events.
TPVProvider - Class in net.sf.marineapi.provider: Provides a time/position/velocity report from GPS.
TPVProvider(SentenceReader) - Constructor for class net.sf.marineapi.provider.TPVProvider: Creates a new instance of GPSProvider.
tpvUpdate(TPVEvent) - Method in interface net.sf.marineapi.provider.event.TPVListener: Invoked when fresh time/position/velocity report is available, typically once per second.
TRUE - Static variable in interface net.sf.marineapi.nmea.sentence.VTGSentence: Char indicator for "true"

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.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.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.GpsMode: Returns the enum constant of this type with the specified name.
valueOf(char) - Static method in enum net.sf.marineapi.nmea.util.GpsMode: Returns the GpsMode enum corresponding the actual char indicator used in the sentencess.
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.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're 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're 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're 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're 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're 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're 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're 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're declared.
values() - Static method in enum net.sf.marineapi.nmea.util.GpsMode: Returns an array containing the constants of this enum type, in the order they're 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're 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're declared.
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, CompassPoint, double, CompassPoint) - Constructor for class net.sf.marineapi.nmea.util.Waypoint: Creates a new instance of Waypoint with default WGS84 datum.
Waypoint(String, double, CompassPoint, double, CompassPoint, 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.

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 M N P R S T U V W Z

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES