net.sf.marineapi.nmea.sentence

Interface RSASentence

All Superinterfaces:

Sentence

public interface RSASentence
extends Sentence

Rudder angle, measured in degrees. Negative value represents port side, positive starboard side turn. May contain value for both port and starboard rudder. Side.PORT is used for vessels with single rudder.

Example:
$IIRSA,9,A,,*38

Author:

Lázár József, 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	getRudderAngle(Side side) Returns the rudder angle for specified side.
DataStatus	getStatus(Side side) Returns the data status (valid/invalid) for specified side.
void	setRudderAngle(Side side, double angle) Sets the rudder's angle for specified side.
void	setStatus(Side side, DataStatus status) Set data status for specified side.

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

getRudderAngle

double getRudderAngle(Side side)

Returns the rudder angle for specified side.

Returns:

Rudder angle in degrees.

setRudderAngle

void setRudderAngle(Side side,
                    double angle)

Sets the rudder's angle for specified side.

Parameters:

side - Rudder side

angle - Rudder angle in degrees

getStatus

DataStatus getStatus(Side side)

Returns the data status (valid/invalid) for specified side.

Parameters:

side - Rudder side

Returns:

Data status

setStatus

void setStatus(Side side,
               DataStatus status)

Set data status for specified side.

Parameters:

side - Rudder side

status - Data status to set