org.orekit.files.ccsds

Enum CcsdsTimeScale

java.lang.Object

java.lang.Enum<CcsdsTimeScale>

org.orekit.files.ccsds.CcsdsTimeScale

All Implemented Interfaces:

Serializable, Comparable<CcsdsTimeScale>

public enum CcsdsTimeScale
extends Enum<CcsdsTimeScale>

The set of time scales defined in Annex A of the ODM CCSDS standard 502.0-B-2.

Author:

Evan Ward

Enum Constant Summary

Enum Constants

Enum Constant and Description
GMST Greenwich Mean Sidereal Time.
GPS Global Positioning System.
MET Mission Elapsed Time.
MRT Mission Relative Time.
SCLK Spacecraft Clock.
TAI International Atomic Time.
TCB Barycentric Coordinate Time.
TCG Geocentric Coordinate Time.
TDB Barycentric Dynamical Time.
TT Terrestrial Time.
UT1 Universal Time.
UTC Universal Coordinated Time.

Method Summary

Modifier and Type	Method and Description
static boolean	contains(String timeScale) Check if timeScale is one of the values supported by this enum.
TimeScale	getTimeScale(IERSConventions conventions) Get the corresponding TimeScale.
abstract TimeScale	getTimeScale(IERSConventions conventions, TimeScales timeScales) Get the corresponding TimeScale.
AbsoluteDate	parseDate(String date, IERSConventions conventions, AbsoluteDate missionReferenceDate) Parse a date in this time scale.
AbsoluteDate	parseDate(String date, IERSConventions conventions, AbsoluteDate missionReferenceDate, TimeScales timeScales) Parse a date in this time scale.
static CcsdsTimeScale	valueOf(String name) Returns the enum constant of this type with the specified name.
static CcsdsTimeScale[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GMST

public static final CcsdsTimeScale GMST

Greenwich Mean Sidereal Time.

GPS

public static final CcsdsTimeScale GPS

Global Positioning System.

MET

public static final CcsdsTimeScale MET

Mission Elapsed Time.

MRT

public static final CcsdsTimeScale MRT

Mission Relative Time.

SCLK

public static final CcsdsTimeScale SCLK

Spacecraft Clock. Not currently Implemented.

TAI

public static final CcsdsTimeScale TAI

International Atomic Time.

TCB

public static final CcsdsTimeScale TCB

Barycentric Coordinate Time.

TDB

public static final CcsdsTimeScale TDB

Barycentric Dynamical Time.

TCG

public static final CcsdsTimeScale TCG

Geocentric Coordinate Time.

TT

public static final CcsdsTimeScale TT

Terrestrial Time.

UT1

public static final CcsdsTimeScale UT1

Universal Time.

UTC

public static final CcsdsTimeScale UTC

Universal Coordinated Time.

Method Detail

values

public static CcsdsTimeScale[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CcsdsTimeScale c : CcsdsTimeScale.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CcsdsTimeScale valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

parseDate

@DefaultDataContext
public AbsoluteDate parseDate(String date,
                                                  IERSConventions conventions,
                                                  AbsoluteDate missionReferenceDate)

Parse a date in this time scale.

This method uses the default data context.

Parameters:

date - a CCSDS date string.

conventions - IERS conventions for UT1 and GMST.

missionReferenceDate - epoch for MET and MRT.

Returns:

parsed date.

See Also:

parseDate(String, IERSConventions, AbsoluteDate, TimeScales)

parseDate

public AbsoluteDate parseDate(String date,
                              IERSConventions conventions,
                              AbsoluteDate missionReferenceDate,
                              TimeScales timeScales)

Parse a date in this time scale.

Parameters:

date - a CCSDS date string.

conventions - IERS conventions for UT1 and GMST.

missionReferenceDate - epoch for MET and MRT.

timeScales - the set of time scales to use.

Returns:

parsed date.

Since:

10.1

getTimeScale

@DefaultDataContext
public TimeScale getTimeScale(IERSConventions conventions)

Get the corresponding TimeScale.

This method uses the default data context.

Parameters:

conventions - IERS Conventions for the GMST and UT1 scales.

Returns:

the time scale.

getTimeScale

public abstract TimeScale getTimeScale(IERSConventions conventions,
                                       TimeScales timeScales)

Get the corresponding TimeScale.

Parameters:

conventions - IERS Conventions for the GMST and UT1 scales.

timeScales - the set of time scales to use.

Returns:

the time scale.

contains

public static boolean contains(String timeScale)

Check if timeScale is one of the values supported by this enum.

Parameters:

timeScale - specifier.

Returns:

true if valueOf(String) will not throw an exception with the same string.