triana.types.util

Class GPSCalendar

java.lang.Object

java.util.Calendar

java.util.GregorianCalendar

triana.types.util.GPSCalendar

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.Calendar>

public class GPSCalendar
extends java.util.GregorianCalendar

Class GPSCalendar provides a conversion between GPS time (in seconds or milliseconds) and normal dates (UTC time). It uses the Java GregorianCalendar class to handle dates, and adds the information to normalize counting of GPS seconds. The user creates an instance of this class by giving a time in conventional form -- by giving the year, month, etc -- or by giving the GPS time in seconds. Then the instance can return information about the time -- conventional UTC time information or GPS information -- by using various get methods.

The Calendar is constructed using the GMT time zone. This prevents offsets between dates computed using the local time zone and those referred to the reference epoch of the Java Calendar and Date classes, namely January 1, 1970, 00:00:00 GMT. All UTC times returned are thus referred to GMT.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.GregorianCalendar

AD, BC

Fields inherited from class java.util.Calendar

ALL_STYLES, AM, AM_PM, APRIL, areFieldsSet, AUGUST, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DST_OFFSET, ERA, FEBRUARY, FIELD_COUNT, fields, FRIDAY, HOUR, HOUR_OF_DAY, isSet, isTimeSet, JANUARY, JULY, JUNE, LONG, MARCH, MAY, MILLISECOND, MINUTE, MONDAY, MONTH, NOVEMBER, OCTOBER, PM, SATURDAY, SECOND, SEPTEMBER, SHORT, SUNDAY, THURSDAY, time, TUESDAY, UNDECIMBER, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, YEAR, ZONE_OFFSET

Constructor Summary

Constructors

Constructor and Description
GPSCalendar() Default empty constructor.
GPSCalendar(int year, int month, int day, int min, int sec) Construct a GPSCalendar Calendar using conventional time notation (not hours) as referred to GMT.
GPSCalendar(int year, int month, int day, int hour, int min, int sec) Construct a GPSCalendar Calendar using conventional time notation (including hours) as referred to GMT.
GPSCalendar(long gpsMilliSec) Construct a Calendar using the GPS time in milliseconds to define the time and setting the time zone to GMT.

Method Summary

Methods

Modifier and Type	Method and Description
long	getGPSMilliseconds() Get the GPS time in milliseconds corresponding to the time set in the current Calendar.
long	getGPSSeconds() Get the GPS seconds corresponding to the time set in the current Calendar.
long	getSeconds() Get the GPS seconds corresponding to the time set in the current Calendar.
long	getTimeInMillis() Get the time corresponding to the date of this Calendar in milliseconds from the reference time for Java Calendars (not the GPS time in milliseconds).
int	getUTCDay() Get the day of the month corresponding to the time held in this calendar
int	getUTCDayOfYear() Get the day of the year corresponding to the time held in this calendar
int	getUTCHour() Get the hour of the day corresponding to the time held in this calendar
int	getUTCMillisecond() Get the millisecond corresponding to the time held in this calendar
int	getUTCMinute() Get the minute corresponding to the time held in this calendar
int	getUTCMonth() Get the month corresponding to the time held in this calendar
int	getUTCSecond() Get the second corresponding to the time held in this calendar
int	getUTCYear() Get the year corresponding to the time held in this calendar
void	setGPSSeconds(long gpsTime) Set the time of this Calendar by giving the GPS time in seconds.

Methods inherited from class java.util.GregorianCalendar

add, clone, computeFields, computeTime, equals, getActualMaximum, getActualMinimum, getGreatestMinimum, getGregorianChange, getLeastMaximum, getMaximum, getMinimum, getTimeZone, getWeeksInWeekYear, getWeekYear, hashCode, isLeapYear, isWeekDateSupported, roll, roll, setGregorianChange, setTimeZone, setWeekDate

Methods inherited from class java.util.Calendar

after, before, clear, clear, compareTo, complete, get, getAvailableLocales, getDisplayName, getDisplayNames, getFirstDayOfWeek, getInstance, getInstance, getInstance, getInstance, getMinimalDaysInFirstWeek, getTime, internalGet, isLenient, isSet, set, set, set, set, setFirstDayOfWeek, setLenient, setMinimalDaysInFirstWeek, setTime, setTimeInMillis, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GPSCalendar

public GPSCalendar()

Default empty constructor. The Calendar is set to the present time using the GMT time zone.

GPSCalendar

public GPSCalendar(long gpsMilliSec)

Construct a Calendar using the GPS time in milliseconds to define the time and setting the time zone to GMT.

GPSCalendar

public GPSCalendar(int year,
           int month,
           int day,
           int min,
           int sec)

Construct a GPSCalendar Calendar using conventional time notation (not hours) as referred to GMT.

GPSCalendar

public GPSCalendar(int year,
           int month,
           int day,
           int hour,
           int min,
           int sec)

Construct a GPSCalendar Calendar using conventional time notation (including hours) as referred to GMT.

Method Detail

getSeconds

public long getSeconds()

Get the GPS seconds corresponding to the time set in the current Calendar. Fractions of a second are truncated. Avoid using this method because its name is ambiguous. Use the identical method getGPSSeconds(), for which this is an alias. Kept for compatibility with previous versions.

Returns:

long The GPS time in seconds corresponding to this time

getGPSSeconds

public long getGPSSeconds()

Get the GPS seconds corresponding to the time set in the current Calendar. Fractions of a second are truncated.

Returns:

long The GPS time in seconds corresponding to this time

getGPSMilliseconds

public long getGPSMilliseconds()

Get the GPS time in milliseconds corresponding to the time set in the current Calendar.

Returns:

long The GPS time in milliseconds corresponding to this time

setGPSSeconds

public void setGPSSeconds(long gpsTime)

Set the time of this Calendar by giving the GPS time in seconds.

Parameters:

gpsTime - The GPS time in seconds

getTimeInMillis

public long getTimeInMillis()

Get the time corresponding to the date of this Calendar in milliseconds from the reference time for Java Calendars (not the GPS time in milliseconds).

Overrides:

getTimeInMillis in class java.util.Calendar

Returns:

long The Calendar time in milliseconds

getUTCYear

public int getUTCYear()

Get the year corresponding to the time held in this calendar

Returns:

int The year for this date

getUTCMonth

public int getUTCMonth()

Get the month corresponding to the time held in this calendar

Returns:

int The month for this date

getUTCDay

public int getUTCDay()

Get the day of the month corresponding to the time held in this calendar

Returns:

int The day of the month for this date (range 1..31)

getUTCDayOfYear

public int getUTCDayOfYear()

Get the day of the year corresponding to the time held in this calendar

Returns:

int The day of the week for this date (range 1..366)

getUTCHour

public int getUTCHour()

Get the hour of the day corresponding to the time held in this calendar

Returns:

int The hour of the day for this date (on 24-hour clock)

getUTCMinute

public int getUTCMinute()

Get the minute corresponding to the time held in this calendar

Returns:

int The minute of the hour for this date

getUTCSecond

public int getUTCSecond()

Get the second corresponding to the time held in this calendar

Returns:

int The second of the minute for this date

getUTCMillisecond

public int getUTCMillisecond()

Get the millisecond corresponding to the time held in this calendar

Returns:

int The millisecond part of the second of the time for this date