org.vesalainen.parsers.nmea

Interface Clock

All Known Implementing Classes:

GPSClock

public interface Clock

Author:

Timo Vesalainen

Method Summary

Modifier and Type	Method and Description
void	commit() Read NMEA sentence was correct.
GregorianCalendar	getCalendar() Returns current GregorianCalendar.
long	getOffset() Returns NMEA time - system time
long	getTime() Returns this Clocks Time
boolean	isCommitted() returns true if committed ever
void	rollback() Read NMEA sentence was broken.
void	setDate(int year, int month, int day) Set utc date
void	setDay(int day) Day, 01 to 31
void	setHour(int hour) Update UTC Hour
void	setMinute(int minute) Update utc minute
void	setMonth(int month) Month, 01 to 12
void	setSecond(float second) Update utc second
void	setTime(int hour, int minute, float second) Set utc time
void	setYear(int year) Year (4 digits)
void	setZoneHours(int localZoneHours) Local zone description, 00 to +- 13 hours
void	setZoneMinutes(int localZoneMinutes) Local zone minutes description, apply same sign as local hours

Method Detail

getCalendar

GregorianCalendar getCalendar()

Returns current GregorianCalendar. This object is not copy and it should not be modified!

Returns:

getTime

long getTime()

Returns this Clocks Time

Returns:

getOffset

long getOffset()

Returns NMEA time - system time

Returns:

setTime

void setTime(int hour,
             int minute,
             float second)

Set utc time

Parameters:

hour - 0 - 23

minute - 0 - 59

second - 0.0 - 59.999

setDate

void setDate(int year,
             int month,
             int day)

Set utc date

Parameters:

year - yy

month - mm 1 - 12

day - dd 1 - 31

setHour

void setHour(int hour)

Update UTC Hour

Parameters:

hour -

setMinute

void setMinute(int minute)

Update utc minute

Parameters:

minute -

setSecond

void setSecond(float second)

Update utc second

Parameters:

second -

rollback

void rollback()

Read NMEA sentence was broken.

commit

void commit()

Read NMEA sentence was correct.

setDay

void setDay(int day)

Day, 01 to 31

Parameters:

day -

setMonth

void setMonth(int month)

Month, 01 to 12

Parameters:

month -

setYear

void setYear(int year)

Year (4 digits)

Parameters:

year -

setZoneHours

void setZoneHours(int localZoneHours)

Local zone description, 00 to +- 13 hours

Parameters:

localZoneHours -

setZoneMinutes

void setZoneMinutes(int localZoneMinutes)

Local zone minutes description, apply same sign as local hours

Parameters:

localZoneMinutes -

isCommitted

boolean isCommitted()

returns true if committed ever

Returns: