org.vesalainen.parsers.nmea.time

Class GPSClock

java.lang.Object

java.time.Clock

org.vesalainen.time.MutableClock

org.vesalainen.parsers.nmea.time.GPSClock

All Implemented Interfaces:

java.time.temporal.TemporalAccessor, NMEAClock, org.vesalainen.time.MutableDateTime, org.vesalainen.util.Transactional

public final class GPSClock
extends org.vesalainen.time.MutableClock
implements NMEAClock

Transactional MutableClock.

There are two modes depending on base clock.

Live (default). Data coming from active GPS. Time is updated between time-setting NMEA sentences to give accurate timing for other sentences as well.

Fixed (use fixed base clock). Data coming from recorded NMEA sentences like track file. Time is not updated between time-setting NMEA sentences.

Author:

tkv

Field Summary

Fields inherited from class org.vesalainen.time.MutableClock

clock, dateMillis, fields, needCalc, updated

Fields inherited from interface org.vesalainen.time.MutableDateTime

DayInMillis, HourInMillis, millisMap, MinuteInMillis, SecondInMillis, SupportedFields

Constructor Summary

Constructors

Constructor and Description
GPSClock() Creates a GPSClock in live mode using systemUTC base clock.
GPSClock(boolean live) Creates a GPSClock in live or fixed mode depending on argument.
GPSClock(java.time.Clock clock) Creates a GPSClock.

Method Summary

Modifier and Type	Method and Description
void	commit(String reason)
protected long	getUpdated()
boolean	isCommitted() returns true if committed ever
long	offset() Returns the offset in milliseconds between systemUTC time and this clock.
void	rollback(String reason)
void	set(java.time.temporal.ChronoField chronoField, int amount)
void	setZonedDateTime(java.time.ZonedDateTime zonedDateTime)
void	setZoneHours(int localZoneHours) Sets Zone hour offset.
void	setZoneMinutes(int localZoneMinutes) Sets Zone minute offset.
void	start(String reason)

Methods inherited from class org.vesalainen.time.MutableClock

get, getLong, getZone, getZonedDateTime, instant, isSupported, millis, setMillis, toString, withZone

Methods inherited from class java.time.Clock

equals, fixed, hashCode, offset, system, systemDefaultZone, systemUTC, tick, tickMinutes, tickSeconds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.vesalainen.parsers.nmea.NMEAClock

getZonedDateTime, millis, setMillis

Methods inherited from interface org.vesalainen.time.MutableDateTime

checkField, convertTo4DigitYear, equals, get, getDay, getGregorianCalendar, getHour, getMilliSecond, getMinute, getMonth, getOffsetSecond, getSecond, getYear, getZoneId, isAfter, isBefore, seconds, set, setDate, setDay, setHour, setMilliSecond, setMinute, setMonth, setOffsetSecond, setSecond, setTime, setYear, setZoneId

Methods inherited from interface java.time.temporal.TemporalAccessor

get, query, range

Constructor Detail

GPSClock

public GPSClock()

Creates a GPSClock in live mode using systemUTC base clock.

GPSClock

public GPSClock(boolean live)

Creates a GPSClock in live or fixed mode depending on argument.

Parameters:

live -

GPSClock

public GPSClock(java.time.Clock clock)

Creates a GPSClock. If clock is fixed mode is fixed.

It only matter if the clock is fixed or live. This clock always returns time according to GPS data. Live or recorded.

Parameters:

clock -

See Also:

Clock.fixed(java.time.Instant, java.time.ZoneId)

Method Detail

start

public void start(String reason)

Specified by:

start in interface org.vesalainen.util.Transactional

commit

public void commit(String reason)

Specified by:

commit in interface org.vesalainen.util.Transactional

rollback

public void rollback(String reason)

Specified by:

rollback in interface org.vesalainen.util.Transactional

getUpdated

protected long getUpdated()

Overrides:

getUpdated in class org.vesalainen.time.MutableClock

set

public void set(java.time.temporal.ChronoField chronoField,
                int amount)

Specified by:

set in interface org.vesalainen.time.MutableDateTime

Overrides:

set in class org.vesalainen.time.MutableClock

setZonedDateTime

public void setZonedDateTime(java.time.ZonedDateTime zonedDateTime)

Specified by:

setZonedDateTime in interface org.vesalainen.time.MutableDateTime

setZoneHours

public void setZoneHours(int localZoneHours)

Sets Zone hour offset. This method exist to support ZDA sentence which is most probable deprecated.

Specified by:

setZoneHours in interface NMEAClock

Parameters:

localZoneHours -

setZoneMinutes

public void setZoneMinutes(int localZoneMinutes)

Sets Zone minute offset. This method exist to support ZDA sentence which is most probable deprecated.

Specified by:

setZoneMinutes in interface NMEAClock

Parameters:

localZoneMinutes -

isCommitted

public boolean isCommitted()

Description copied from interface: NMEAClock

returns true if committed ever

Specified by:

isCommitted in interface NMEAClock

Returns:

offset

public long offset()

Returns the offset in milliseconds between systemUTC time and this clock.

Specified by:

offset in interface NMEAClock

Returns: