org.vesalainen.parsers.nmea

Class GPSClock

java.lang.Object

org.vesalainen.parsers.nmea.GPSClock

All Implemented Interfaces:

Clock

public class GPSClock
extends Object
implements Clock

This clock is based on system clock in utc time corrected by NMEA sentences.

Author:

Timo Vesalainen

Constructor Summary

Constructors

Constructor and Description
GPSClock()

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 last nmea time updated with system clock.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPSClock

public GPSClock()

Method Detail

getTime

public long getTime()

Returns last nmea time updated with system clock. Use getCalendar to get nmea time

Specified by:

getTime in interface Clock

Returns:

See Also:

getCalendar()

getOffset

public long getOffset()

Description copied from interface: Clock

Returns NMEA time - system time

Specified by:

getOffset in interface Clock

Returns:

setTime

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

Description copied from interface: Clock

Set utc time

Specified by:

setTime in interface Clock

Parameters:

hour - 0 - 23

minute - 0 - 59

second - 0.0 - 59.999

setHour

public void setHour(int hour)

Description copied from interface: Clock

Update UTC Hour

Specified by:

setHour in interface Clock

setMinute

public void setMinute(int minute)

Description copied from interface: Clock

Update utc minute

Specified by:

setMinute in interface Clock

setSecond

public void setSecond(float second)

Description copied from interface: Clock

Update utc second

Specified by:

setSecond in interface Clock

rollback

public void rollback()

Description copied from interface: Clock

Read NMEA sentence was broken.

Specified by:

rollback in interface Clock

commit

public void commit()

Description copied from interface: Clock

Read NMEA sentence was correct.

Specified by:

commit in interface Clock

setDate

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

Description copied from interface: Clock

Set utc date

Specified by:

setDate in interface Clock

Parameters:

year - yy

month - mm 1 - 12

day - dd 1 - 31

setDay

public void setDay(int day)

Description copied from interface: Clock

Day, 01 to 31

Specified by:

setDay in interface Clock

setMonth

public void setMonth(int month)

Description copied from interface: Clock

Month, 01 to 12

Specified by:

setMonth in interface Clock

setYear

public void setYear(int year)

Description copied from interface: Clock

Year (4 digits)

Specified by:

setYear in interface Clock

setZoneHours

public void setZoneHours(int localZoneHours)

Description copied from interface: Clock

Local zone description, 00 to +- 13 hours

Specified by:

setZoneHours in interface Clock

setZoneMinutes

public void setZoneMinutes(int localZoneMinutes)

Description copied from interface: Clock

Local zone minutes description, apply same sign as local hours

Specified by:

setZoneMinutes in interface Clock

isCommitted

public boolean isCommitted()

Description copied from interface: Clock

returns true if committed ever

Specified by:

isCommitted in interface Clock

Returns:

getCalendar

public GregorianCalendar getCalendar()

Description copied from interface: Clock

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

Specified by:

getCalendar in interface Clock

Returns: