net.sf.marineapi.nmea.sentence
Interface ZDASentence

All Superinterfaces:
DateSentence, Sentence, TimeSentence

public interface ZDASentence
extends TimeSentence, DateSentence

UTC time and date with local time zone offset.

Example:
$GPZDA,032915,07,08,2004,00,00*4D

Author:
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
 int getLocalZoneHours()
          Get offset to local time zone in hours, from 0 to +/- 13 hours.
 int getLocalZoneMinutes()
          Get offset to local time zone in minutes, from 0 to +/- 59.
 void setLocalZoneHours(int hours)
          Set offset to local time zone in hours.
 void setLocalZoneMinutes(int minutes)
          Set offset to local time zone in minutes.
 void setTimeAndLocalZone(Time t)
          Set time and local time zone hours and minutes.
 Date toDate()
          Get date and time as Date.
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.TimeSentence
getTime, setTime
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.DateSentence
getDate, setDate
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence
getBeginChar, getFieldCount, getSentenceId, getTalkerId, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString
 

Method Detail

getLocalZoneHours

int getLocalZoneHours()
Get offset to local time zone in hours, from 0 to +/- 13 hours.

Returns:
Time zone offset
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getLocalZoneMinutes

int getLocalZoneMinutes()
Get offset to local time zone in minutes, from 0 to +/- 59.

Returns:
Time zone offset
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

setLocalZoneHours

void setLocalZoneHours(int hours)
Set offset to local time zone in hours.

Parameters:
hours - Offset, from 0 to +/- 13 hours.

setLocalZoneMinutes

void setLocalZoneMinutes(int minutes)
Set offset to local time zone in minutes.

Parameters:
minutes - Offset, from 0 to +/- 59 minutes.

setTimeAndLocalZone

void setTimeAndLocalZone(Time t)
Set time and local time zone hours and minutes.

Parameters:
t - Time to be inserted in sentence.

toDate

Date toDate()
Get date and time as Date.

Returns:
Date
Throws:
DataNotAvailableException - If any of the date/time values is not available.
ParseException - If the any of the date/time fields contains invalid value.


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