agi.foundation.stk

Enum StkEphemerisFile.StkTimeFormat

java.lang.Object

java.lang.Enum<StkEphemerisFile.StkTimeFormat>

agi.foundation.stk.StkEphemerisFile.StkTimeFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StkEphemerisFile.StkTimeFormat>

Enclosing class:

StkEphemerisFile

public static enum StkEphemerisFile.StkTimeFormat
extends Enum<StkEphemerisFile.StkTimeFormat>
implements Enumeration

The supported time formats for ephemeris and covariance information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EP_SEC Epoch seconds (EpSec) describes the time at which an event occurred with a two-step process.
GPS_G GlobalPositioningSystemTime (get) mapped onto the Gregorian calendar.
TAI_G InternationalAtomicTime (get) mapped onto the Gregorian calendar.
TDT_G TerrestrialTime (get) mapped onto the Gregorian calendar.
UTC_G CoordinatedUniversalTime (get) mapped onto the Gregorian calendar.

Method Summary

Modifier and Type	Method and Description
static StkEphemerisFile.StkTimeFormat	getDefault() Get the enum constant that is considered to be the default.
static StkEphemerisFile.StkTimeFormat	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static StkEphemerisFile.StkTimeFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static StkEphemerisFile.StkTimeFormat[]	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

EP_SEC

public static final StkEphemerisFile.StkTimeFormat EP_SEC

Epoch seconds (EpSec) describes the time at which an event occurred with a two-step process. First, it states an arbitrary, absolute time, an epoch. Second, it states the time of an event by identifying the number of seconds (and partial seconds) which have passed between the epoch and the event.

UTC_G

public static final StkEphemerisFile.StkTimeFormat UTC_G

CoordinatedUniversalTime (get) mapped onto the Gregorian calendar.

GPS_G

public static final StkEphemerisFile.StkTimeFormat GPS_G

GlobalPositioningSystemTime (get) mapped onto the Gregorian calendar.

TAI_G

public static final StkEphemerisFile.StkTimeFormat TAI_G

InternationalAtomicTime (get) mapped onto the Gregorian calendar.

TDT_G

public static final StkEphemerisFile.StkTimeFormat TDT_G

TerrestrialTime (get) mapped onto the Gregorian calendar.

Terrestrial Time is formerly known as Terrestrial Dynamical Time. STK continues to use the keyword TDTG to refer to Terrestrial Time mapped onto the Gregorian calendar.

Method Detail

values

public static StkEphemerisFile.StkTimeFormat[] 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 (StkEphemerisFile.StkTimeFormat c : StkEphemerisFile.StkTimeFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static StkEphemerisFile.StkTimeFormat 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StkEphemerisFile.StkTimeFormat getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static StkEphemerisFile.StkTimeFormat getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.