org.orekit.time

Class GPSScale

java.lang.Object

org.orekit.time.GPSScale

All Implemented Interfaces:

Serializable, TimeScale

public class GPSScale
extends Object
implements TimeScale

GPS time scale.

By convention, TGPS = TAI - 19 s.

This is intended to be accessed thanks to the TimeScalesFactory class, so there is no public constructor.

Author:

Luc Maisonobe

See Also:

AbsoluteDate, Serialized Form

Method Summary

Modifier and Type	Method and Description
double	getLeap(AbsoluteDate date) Get the value of the previous leap.
String	getName() Get the name time scale.
boolean	insideLeap(AbsoluteDate date) Check if date is within a leap second introduction in this time scale.
double	offsetFromTAI(AbsoluteDate date) Get the offset to convert locations from TAIScale to instance.
double	offsetToTAI(DateComponents date, TimeComponents time) Get the offset to convert locations from instance to TAIScale.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

offsetFromTAI

public double offsetFromTAI(AbsoluteDate date)

Get the offset to convert locations from TAIScale to instance.

Specified by:

offsetFromTAI in interface TimeScale

Parameters:

date - conversion date

Returns:

offset in seconds to add to a location in TAIScale time scale to get a location in instance time scale

See Also:

TimeScale.offsetToTAI(DateComponents, TimeComponents)

offsetToTAI

public double offsetToTAI(DateComponents date,
                          TimeComponents time)

Get the offset to convert locations from instance to TAIScale.

Specified by:

offsetToTAI in interface TimeScale

Parameters:

date - date location in the time scale

time - time location in the time scale

Returns:

offset in seconds to add to a location in instance time scale to get a location in TAIScale time scale

See Also:

TimeScale.offsetFromTAI(AbsoluteDate)

insideLeap

public boolean insideLeap(AbsoluteDate date)

Check if date is within a leap second introduction in this time scale.

This method will return false for all time scales that do not implement leap seconds, even if the date corresponds to a leap second in UTC scale.

Specified by:

insideLeap in interface TimeScale

Parameters:

date - date to check

Returns:

true if time is within a leap second introduction

getLeap

public double getLeap(AbsoluteDate date)

Get the value of the previous leap.

This method will return 0.0 for all time scales that do not implement leap seconds.

Specified by:

getLeap in interface TimeScale

Parameters:

date - date to check

Returns:

value of the previous leap

getName

public String getName()

Get the name time scale.

Specified by:

getName in interface TimeScale

Returns:

name of the time scale

toString

public String toString()

Overrides:

toString in class Object