net.sf.marineapi.nmea.sentence

Interface VWRSentence

All Superinterfaces:

Sentence

public interface VWRSentence
extends Sentence

Relative Wind Speed and Angle. Wind direction magnitude in degrees Wind direction Left/Right of bow Speed in Knots, Meters Per Second and Kilometers Per Hour

Example:
---

Author:

Henri Laurent

Field Summary

Fields

Modifier and Type	Field and Description
static char	KMPH Units indicator for kilometers per hour
static char	KNOT Units indicator for knots (nautical miles per hour)
static char	MPS Units indicator for meters per second

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
Direction	getDirectionLeftRight() Get the Wind direction Left/Right of bow
double	getSpeedKmh() Get relative wind speed, in kilometers per hour.
double	getSpeedKnots() Get relative wind speed in knots.
double	getWindAngle() Get the Wind angle magnitude in degrees
void	setDirectionLeftRight(Direction direction) Set the Wind direction Left/Right of bow
void	setSpeedKmh(double kmh) Set the relative wind speed in kmh
void	setSpeedKnots(double knots) Set the relative wind speed in knots.
void	setWindAngle(double mWindAngle) Set the Wind angle magnitude

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

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

Field Detail

MPS

static final char MPS

Units indicator for meters per second

See Also:

Constant Field Values

KMPH

static final char KMPH

Units indicator for kilometers per hour

See Also:

Constant Field Values

KNOT

static final char KNOT

Units indicator for knots (nautical miles per hour)

See Also:

Constant Field Values

Method Detail

getWindAngle

double getWindAngle()

Get the Wind angle magnitude in degrees

Returns:

Wind angle

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getDirectionLeftRight

Direction getDirectionLeftRight()

Get the Wind direction Left/Right of bow

Returns:

Direction enum

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

Since:

NMEA 2.3

getSpeedKmh

double getSpeedKmh()

Get relative wind speed, in kilometers per hour.

Returns:

Speed in km/h

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getSpeedKnots

double getSpeedKnots()

Get relative wind speed in knots.

Returns:

Speed in knots (nautical miles per hour)

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

setWindAngle

void setWindAngle(double mWindAngle)

Set the Wind angle magnitude

Parameters:

mWindAngle - Wind angle magnitude in degrees.

setDirectionLeftRight

void setDirectionLeftRight(Direction direction)

Set the Wind direction Left/Right of bow

Parameters:

direction - Direction to set

Since:

NMEA 2.3

setSpeedKmh

void setSpeedKmh(double kmh)

Set the relative wind speed in kmh

Parameters:

kmh - Speed in kilometers per hour (km/h).

setSpeedKnots

void setSpeedKnots(double knots)

Set the relative wind speed in knots.

Parameters:

knots - Speed in knots (nautical miles per hour)