Package org.orekit.time

Class ClockTimeScale

java.lang.Object

org.orekit.time.ClockTimeScale

All Implemented Interfaces:

Serializable, TimeScale

public class ClockTimeScale
extends Object
implements TimeScale

Time scale with clock offset from another time scale.

Since:

12.1

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClockTimeScale(String name, TimeScale reference, ClockModel clockModel)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name time scale.
TimeOffset	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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.time.TimeScale

getLeap, getLeap, insideLeap, insideLeap, minuteDuration, minuteDuration, offsetToTAI

Constructor Detail

ClockTimeScale

public ClockTimeScale(String name,
                      TimeScale reference,
                      ClockModel clockModel)

Simple constructor.

Parameters:

name - name of the time scale

reference - reference time scale

clockModel - clock offset model

Method Detail

offsetFromTAI

public TimeOffset 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)

getName

public String getName()

Get the name time scale.

Specified by:

getName in interface TimeScale

Returns:

name of the time scale