net.sf.marineapi.nmea.sentence
Interface TTMSentence

All Superinterfaces:

Sentence, TimeSentence

public interface TTMSentence
extends TimeSentence

Tracked Target Message. Range and bearing from radar to target. Course and speed of target. One message per target.

Example:
$RATTM,11,11.4,13.6,T,7.0,20.0,T,0.0,0.0,N,,Q,,154125.82,A,*17

Author:

Johan Bergkvist

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

AcquisitionType	getAcquisitionType() Get the acquisition type of the target.
double	getBearing() Get the true bearing from the radar to the target.
double	getCourse() Get the course the target is maintaining.
double	getDistance() Get the distance from the radar to the target.
double	getDistanceOfCPA() Get the distance at the Closest Point of Approach (CPA).
String	getName() Get the name of the target as assigned by the radar.
int	getNumber() Get the number assigned to this target by the radar.
boolean	getReference() A target may be used to calculate own ship position.
double	getSpeed() Get the speed the target.
TargetStatus	getStatus() Get the status of the target.
double	getTimeToCPA() Get the time to the Closest Point of Approach (CPA).
Units	getUnits() Get the unit of measure used for distance and speeds.
void	setAcquisitionType(AcquisitionType acquisitionType) Set the acquisition type of the target.
void	setBearing(double bearing) Set the true bearing from the radar to the target.
void	setCourse(double course) Set the course of the target.
void	setDistance(double distance) Set the distance from the radar to the target.
void	setDistanceOfCPA(double distance) Set the distance at CPA.
void	setName(String name) Set the name of the target.
void	setNumber(int number) Set the number of the target.
void	setReference(boolean isReference) A target may be used to calculate own ship position.
void	setSpeed(double speed) Set the speed of the target.
void	setStatus(TargetStatus status) Set the Status of the target.
void	setTimeToCPA(double minutes) Set the time to CPA.

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

getTime, setTime

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

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

Method Detail

getNumber

int getNumber()

Get the number assigned to this target by the radar. The TTM sentence mandate a two digit number, so valid numbers are 0 to 99 inclusive.

Returns:

Target number in the range 0 - 99.

Throws:

DataNotAvailableException - If the data is not available.

getDistance

double getDistance()

Get the distance from the radar to the target.

Returns:

Distance to target in nautical miles.

getBearing

double getBearing()

Get the true bearing from the radar to the target.

Returns:

True bearing in degrees.

getSpeed

double getSpeed()

Get the speed the target.

Returns:

Speed in kts (nautical miles per hour).

getCourse

double getCourse()

Get the course the target is maintaining.

Returns:

True course in degrees.

getDistanceOfCPA

double getDistanceOfCPA()

Get the distance at the Closest Point of Approach (CPA).

Returns:

The distance in nautical miles.

getTimeToCPA

double getTimeToCPA()

Get the time to the Closest Point of Approach (CPA).

Returns:

The time in minutes.

getUnits

Units getUnits()

Get the unit of measure used for distance and speeds.

Returns:

The unit of measure.

getName

String getName()

Get the name of the target as assigned by the radar.

Returns:

Name.

getStatus

TargetStatus getStatus()

Get the status of the target. A target is first in state QUERY while the radar works out firm data of the target. At first the calculated course and speed are rough and varies a lot; with time they settle at which point the target becomes TRACKING. A target no longer detected becomes LOST before TTM sentences will not be sent at all for the target.

Returns:

The state (QUERY, TRACKING, LOST)

getReference

boolean getReference()

A target may be used to calculate own ship position.

Returns:

True if this target is used to calculate own ship position.

getAcquisitionType

AcquisitionType getAcquisitionType()

Get the acquisition type of the target. AUTO indicates that the radar initiated the target. MANUAL indicates that the radar operator initiated the target in the radar. REPORTED indicates that the target came from another source. TODO: Is that true?

Returns:

The acquisition type (AUTO, MANUAL, REPORTED)

setNumber

void setNumber(int number)

Set the number of the target. Uniquely identifies the target.

Parameters:

number - The number in the range 0 to 99 inclusive.

setDistance

void setDistance(double distance)

Set the distance from the radar to the target.

Parameters:

distance - Distance in nautical miles.

setBearing

void setBearing(double bearing)

Set the true bearing from the radar to the target.

Parameters:

bearing - True bearing in degrees.

setSpeed

void setSpeed(double speed)

Set the speed of the target.

Parameters:

speed - Speed in kts (nautical miles per hour).

setCourse

void setCourse(double course)

Set the course of the target.

Parameters:

course - True course in degrees.

setDistanceOfCPA

void setDistanceOfCPA(double distance)

Set the distance at CPA.

Parameters:

distance - Distance in nautical miles

setTimeToCPA

void setTimeToCPA(double minutes)

Set the time to CPA.

Parameters:

minutes - Time to CPA in minutes.

setName

void setName(String name)

Set the name of the target.

Parameters:

name - The name as a string, probably not too long...

setStatus

void setStatus(TargetStatus status)

Set the Status of the target.

Parameters:

status - The status

See Also:

getStatus()

setReference

void setReference(boolean isReference)

A target may be used to calculate own ship position.

Parameters:

isReference - True if this target is used to calculate own ship position.

setAcquisitionType

void setAcquisitionType(AcquisitionType acquisitionType)

Set the acquisition type of the target.

Parameters:

acquisitionType - The acquisition type.

See Also:

getAcquisitionType()