net.sf.marineapi.nmea.sentence
Interface DateSentence

All Superinterfaces:
Sentence
All Known Subinterfaces:
RMCSentence, ZDASentence

public interface DateSentence
extends Sentence

Sentences that contains date information. Notice that some sentences may contain only time without the date.

Version:
$Revision: 72 $
Author:
Kimmo Tuukkanen
See Also:
TimeSentence

Field Summary
 
Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence
ADDRESS_FIELD, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR
 
Method Summary
 Date getDate()
          Parses the date information from sentence fields and returns a Date.
 void setDate(Date date)
          Set date.
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence
getFieldCount, getSentenceId, getTalkerId, isProprietary, isValid, setTalkerId, toSentence, toString
 

Method Detail

getDate

Date getDate()
Parses the date information from sentence fields and returns a Date.

Returns:
Date object
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

setDate

void setDate(Date date)
Set date. Depending on the sentence type, the values may be inserted to multiple fields or combined into one. Four-digit year value may also be reduced into two-digit format.

Parameters:
date - Date


Copyright (C) 2010-2011 Java Marine API author(s). All Rights Reserved.