net.sf.marineapi.nmea.sentence

Interface XDRSentence

All Superinterfaces:

Sentence

public interface XDRSentence
extends Sentence

Transducer measurements. Measurements are delivered in sets containing four fields; transducer type, measurement value, unit of measurement and transducer name. There may be any number of sets like this, each describing a sensor. Notice that inserting too many measuments in one sentence may result in exceeding the maximum sentence length (82 chars).

Author:

Robert Huitema, Kimmo Tuukkanen

See Also:

Measurement

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
void	addMeasurement(Measurement... m) Adds specified measurement in sentence placing it last.
List<Measurement>	getMeasurements() Returns all measurements.
void	setMeasurement(Measurement m) Set single measurement.
void	setMeasurements(List<Measurement> measurements) Set multiple measurements in given order.

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

addMeasurement

void addMeasurement(Measurement... m)

Adds specified measurement in sentence placing it last. Multiple measurements are inserted in given order.

Parameters:

m - Measurements to add.

getMeasurements

List<Measurement> getMeasurements()

Returns all measurements.

Returns:

List of measurements, ordered as they appear in sentence.

setMeasurement

void setMeasurement(Measurement m)

Set single measurement. Overwrites all existing values and adjusts the number of data fields to minimum required by one measurement (4).

Parameters:

m - Measurement to set.

setMeasurements

void setMeasurements(List<Measurement> measurements)

Set multiple measurements in given order. Overwrites all existing values and adjusts the number of data fields as required by given measurements.

Parameters:

measurements - List of measurements to set.