net.sf.marineapi.nmea.sentence

Interface DPTSentence

All Superinterfaces:

DepthSentence, Sentence

public interface DPTSentence
extends DepthSentence

Depth of water, measured in meters. Includes offset to transducer, positive values for distance from transducer to water line and negative values for distance from transducer to keel. The maximum value is included since NMEA v3.0 and may thus be missing.

Example:
$SDDPT,2.4,,*7F

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	getMaximum() Get maximum depth value the sounder can detect.
double	getOffset() Get offset to transducer.
void	setMaximum(double max) Set maximum depth value the sounder can detect.
void	setOffset(double offset) Set offset to transducer.

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

getDepth, setDepth

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

getOffset

double getOffset()

Get offset to transducer.

Returns:

Offset in meters.

setOffset

void setOffset(double offset)

Set offset to transducer.

Parameters:

offset - Offset in meters

getMaximum

double getMaximum()

Get maximum depth value the sounder can detect.

Returns:

Maximum depth, in meters.

setMaximum

void setMaximum(double max)

Set maximum depth value the sounder can detect.

Parameters:

max - Maximum depth, in meters.