net.sf.marineapi.nmea.sentence

Interface DTMSentence

All Superinterfaces:

Sentence

public interface DTMSentence
extends Sentence

Datum reference.

Example:
$GPDTM,W84,,0.000000,N,0.000000,E,0.0,W84*6F

Author:

Kimmo Tuukkanen

Field Summary

Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence

ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR

Method Summary

Modifier and Type	Method and Description
double	getAltitudeOffset() Returns the altitude offset.
String	getDatumCode() Returns the local datum code.
String	getDatumSubCode() Returns the local datum subcode, may be blank.
double	getLatitudeOffset() Returns the latitude offset.
double	getLongitudeOffset() Returns the longitude offset.
String	getName() Returns the datum name, e.g.
void	setDatumCode(String code) Sets the local datum code.
void	setDatumSubCode(String code) Sets the local datum code, may be blank.
void	setLatitudeOffset(double offset) Sets the latitude offset.
void	setLongitudeOffset(double offset) Sets the longitude offset.
void	setName(String name) Sets the datum name.

Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence

getBeginChar, getFieldCount, getSentenceId, getTalkerId, isAISSentence, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString

Method Detail

getAltitudeOffset

double getAltitudeOffset()

Returns the altitude offset.

Returns:

Altitude offset, in meters.

getDatumCode

String getDatumCode()

Returns the local datum code.

Returns:

Datum code

getDatumSubCode

String getDatumSubCode()

Returns the local datum subcode, may be blank.

Returns:

Datum subcode

getLatitudeOffset

double getLatitudeOffset()

Returns the latitude offset. Positive values depict northern offset, negative for southern.

Returns:

Offset value in minutes.

getLongitudeOffset

double getLongitudeOffset()

Returns the longitude offset. Positive values for east, negative west.

Returns:

Longitude offset in minutes.

getName

String getName()

Returns the datum name, e.g. "W84" for WGS84 used by GPS.

Returns:

Datum name

setDatumCode

void setDatumCode(String code)

Sets the local datum code.

Parameters:

code - Code to set

setDatumSubCode

void setDatumSubCode(String code)

Sets the local datum code, may be blank.

Parameters:

code - Code to set

setLatitudeOffset

void setLatitudeOffset(double offset)

Sets the latitude offset. Positive values depict northern offset, negative for southern.

Parameters:

offset - Latitude offset in minutes.

setLongitudeOffset

void setLongitudeOffset(double offset)

Sets the longitude offset. Positive values for east, negative west.

Parameters:

offset - Longitude offset in minutes.

setName

void setName(String name)

Sets the datum name.

Parameters:

name - Name to set.