net.sf.marineapi.nmea.sentence
Interface RPMSentence

All Superinterfaces:

Sentence

public interface RPMSentence
extends Sentence

Revolutions, measured from shaft or engine.

Author:

Kimmo Tuukkanen

Field Summary

static char	ENGINE Source indicator for engine
static char	SHAFT Source indicator for shaft

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

ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR

Method Summary

int	getId() Returns the engine or shaft number/id.
double	getPitch() Returns the propeller pitch, % of maximum.
double	getRPM() Returns the revolutions value.
char	getSource() Returns the measurement source, engine or shaft.
DataStatus	getStatus() Returns the data validity status.
boolean	isEngine() Tells if the data source is engine.
boolean	isShaft() Tells if the data source is shaft.
void	setId(int id) Sets the engine or shaft number/id.
void	setPitch(double pitch) Sets the propeller pitch, % of maximum.
void	setSource(char source) Sets the source indicator, engine or shaft.
void	setStatus(DataStatus status) Sets the data validity status.

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

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

Field Detail

ENGINE

static final char ENGINE

Source indicator for engine

See Also:

Constant Field Values

SHAFT

static final char SHAFT

Source indicator for shaft

See Also:

Constant Field Values

Method Detail

getId

int getId()

Returns the engine or shaft number/id.

Returns:

Engine of shaft number

getPitch

double getPitch()

Returns the propeller pitch, % of maximum.

Returns:

Pitch value, negative values denote astern.

getRPM

double getRPM()

Returns the revolutions value.

Returns:

Speed, revolutions per minute.

getSource

char getSource()

Returns the measurement source, engine or shaft.

Returns:

'E' for engine, 'S' for shaft.

getStatus

DataStatus getStatus()

Returns the data validity status.

Returns:

DataStatus

isEngine

boolean isEngine()

Tells if the data source is engine.

Returns:

True if engine, otherwise false.

isShaft

boolean isShaft()

Tells if the data source is shaft.

Returns:

True for shaft, otherwise false.

setId

void setId(int id)

Sets the engine or shaft number/id.

Parameters:

id - ID to set.

setPitch

void setPitch(double pitch)

Sets the propeller pitch, % of maximum.

Parameters:

pitch - Pitch value to set, negative values denote astern.

setSource

void setSource(char source)

Sets the source indicator, engine or shaft.

Parameters:

source - 'E' for engine or 'S' for shaft.

Throws:

IllegalArgumentException - If specified char is not 'E' or 'S'.

setStatus

void setStatus(DataStatus status)

Sets the data validity status.

Parameters:

status - DataStatus to set.