Package org.orekit.time

Class ConstantOffsetTimeScale

java.lang.Object

org.orekit.time.ConstantOffsetTimeScale

All Implemented Interfaces:

Serializable, TimeScale

Direct Known Subclasses:

BDTScale, GalileoScale, GPSScale, IRNSSScale, QZSSScale, TAIScale, TTScale

public class ConstantOffsetTimeScale
extends Object
implements TimeScale

Base class for time scales with constant offset with respecto to TAI.

Since:

12.1

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConstantOffsetTimeScale(String name, double offset)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name time scale.
double	offsetFromTAI(AbsoluteDate date)	Get the offset to convert locations from TAIScale to instance.
<T extends CalculusFieldElement<T>> T	offsetFromTAI(FieldAbsoluteDate<T> 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

Methods inherited from interface org.orekit.time.TimeScale

getLeap, getLeap, insideLeap, insideLeap, minuteDuration, minuteDuration

Constructor Detail

ConstantOffsetTimeScale

protected ConstantOffsetTimeScale(String name,
                                  double offset)

Simple constructor.

Parameters:

name - name of the time scale

offset - offset from TAI

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)

offsetFromTAI

public <T extends CalculusFieldElement<T>> T offsetFromTAI(FieldAbsoluteDate<T> date)

Get the offset to convert locations from TAIScale to instance.

Specified by:

offsetFromTAI in interface TimeScale

Type Parameters:

T - type of the filed elements

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)

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