net.sf.marineapi.nmea.sentence
Interface ROTSentence

All Superinterfaces:
Sentence

public interface ROTSentence
extends Sentence

Vessel's rate of turn given in degrees per minute. Negative values indicate bow turning to port.

Example:
$GPROT,35.6,A*4E

Author:
Mike Tamis, 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 getRateOfTurn()
          Returns the vessel's rate of turn.
 DataStatus getStatus()
          Returns the data status (valid/invalid).
 void setRateOfTurn(double rot)
          Sets the vessel's rate of turn value.
 void setStatus(DataStatus status)
          Sets the data status.
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence
getBeginChar, getFieldCount, getSentenceId, getTalkerId, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString
 

Method Detail

getRateOfTurn

double getRateOfTurn()
Returns the vessel's rate of turn.

Returns:
Rate of Turn value (degrees per minute)

setRateOfTurn

void setRateOfTurn(double rot)
Sets the vessel's rate of turn value.

Parameters:
rot - Rate of Turn value to set (degrees per minute)

getStatus

DataStatus getStatus()
Returns the data status (valid/invalid).

Returns:
True means data is valid

setStatus

void setStatus(DataStatus status)
Sets the data status.

Parameters:
status - DataStatus to set.


Copyright (C) 2010-2014 Java Marine API authors. All Rights Reserved.