net.sf.marineapi.nmea.sentence
Interface MWVSentence

All Superinterfaces:

Sentence

public interface MWVSentence
extends Sentence

Wind speed and angle. Speed in km/h, m/s, or knots. Wind angle is given in degrees relative to bow or true north.

Example:
$IIMWV,199,R,5.9,N,A*2E

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

double	getAngle() Get wind angle.
double	getSpeed() Returns the wind speed.
Units	getSpeedUnit() Returns the wind speed unit.
DataStatus	getStatus() Get data validity status.
boolean	isTrue() Tells if the angle is relative or true.
void	setAngle(double angle) Set wind angle.
void	setSpeed(double speed) Set the wind speed value.
void	setSpeedUnit(Units unit) Set wind speed unit.
void	setStatus(DataStatus status) Set data validity status.
void	setTrue(boolean isTrue) Set angle to relative or true.

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

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

Method Detail

getAngle

double getAngle()

Get wind angle.

Returns:

Wind angle in degrees.

getSpeed

double getSpeed()

Returns the wind speed.

Returns:

Wind speed value

getSpeedUnit

Units getSpeedUnit()

Returns the wind speed unit.

Returns:

Units.METER for meters per second, Units.KMH for kilometers per hour and Units.KNOT for knots.

getStatus

DataStatus getStatus()

Get data validity status.

Returns:

Data status

isTrue

boolean isTrue()

Tells if the angle is relative or true.

Returns:

True if relative to true north, otherwise false (relative to bow)

setAngle

void setAngle(double angle)

Set wind angle.

Parameters:

angle - Wind angle in degrees.

See Also:

setTrue(boolean)

setSpeed

void setSpeed(double speed)

Set the wind speed value.

Parameters:

speed - Wind speed to set.

setSpeedUnit

void setSpeedUnit(Units unit)

Set wind speed unit.

Parameters:

unit - Units.METER for meters per second, Units.KMH for kilometers per hour and Units.KNOT for knots.

Throws:

IllegalArgumentException - If trying to set invalid unit

setStatus

void setStatus(DataStatus status)

Set data validity status.

Parameters:

status - Data status to set.

setTrue

void setTrue(boolean isTrue)

Set angle to relative or true.

Parameters:

isTrue - True for true angle, false for relative to bow.

See Also:

setAngle(double)