agi.foundation.celestial

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

Enum RadiationVectorType

java.lang.Object

java.lang.Enum<RadiationVectorType>

agi.foundation.celestial.RadiationVectorType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RadiationVectorType>

public enum RadiationVectorType
extends Enum<RadiationVectorType>
implements Enumeration

Defines the type of vector to use between the target and the illuminating body in context of scalar occultation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORRECT_FOR_LIGHT_TIME_DELAY_AND_ABERRATION The vectors to and from the target point, eclipsing bodies, and illuminating body are found using apparent position, which corrects for light time delay and aberration.
TRUE_POSITION The vectors to and from the target point, eclipsing bodies, and illuminating body are found using true position.

Method Summary

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

TRUE_POSITION

public static final RadiationVectorType TRUE_POSITION

The vectors to and from the target point, eclipsing bodies, and illuminating body are found using true position.

CORRECT_FOR_LIGHT_TIME_DELAY_AND_ABERRATION

public static final RadiationVectorType CORRECT_FOR_LIGHT_TIME_DELAY_AND_ABERRATION

The vectors to and from the target point, eclipsing bodies, and illuminating body are found using apparent position, which corrects for light time delay and aberration.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.