agi.foundation.stk

(agi.foundation.models-2024r3.jar)

Enum CovarianceReadOptions

java.lang.Object

java.lang.Enum<CovarianceReadOptions>

agi.foundation.stk.CovarianceReadOptions

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CovarianceReadOptions>

public enum CovarianceReadOptions
extends Enum<CovarianceReadOptions>
implements Enumeration

An enumerator describing the different options for reading Covariance from an ephemeris file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOT_READ_COVARIANCE Instructs the reader to ignore any Covariance that exists.
READ_ALL_FILE_COVARIANCE Instructs the reader to read in the format of covariance data specified in the ephemeris file.
READ_ONLY_POSITION_COVARIANCE Instructs the reader to ignore velocity covariance data if it exists in the ephemeris file, and instead only read the position terms.

Method Summary

Modifier and Type	Method and Description
static CovarianceReadOptions	getDefault() Get the enum constant that is considered to be the default.
static CovarianceReadOptions	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 CovarianceReadOptions	valueOf(String name) Returns the enum constant of this type with the specified name.
static CovarianceReadOptions[]	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

DO_NOT_READ_COVARIANCE

public static final CovarianceReadOptions DO_NOT_READ_COVARIANCE

Instructs the reader to ignore any Covariance that exists.

READ_ONLY_POSITION_COVARIANCE

public static final CovarianceReadOptions READ_ONLY_POSITION_COVARIANCE

Instructs the reader to ignore velocity covariance data if it exists in the ephemeris file, and instead only read the position terms.

READ_ALL_FILE_COVARIANCE

public static final CovarianceReadOptions READ_ALL_FILE_COVARIANCE

Instructs the reader to read in the format of covariance data specified in the ephemeris file.

Method Detail

values

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

Returns:

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

valueOf

public static CovarianceReadOptions 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 CovarianceReadOptions 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 CovarianceReadOptions getDefault()

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

Returns:

The default enum constant.