fr.cnes.sirius.patrius.bodies

Enum IAUPoleModelType

java.lang.Object

java.lang.Enum<IAUPoleModelType>

fr.cnes.sirius.patrius.bodies.IAUPoleModelType

All Implemented Interfaces:

Serializable, Comparable<IAUPoleModelType>

public enum IAUPoleModelType
extends Enum<IAUPoleModelType>

IAU pole type: this enumeration lists all possible IAU pole effects (constant, secular, harmonics) used to convert from ICRF body centered frame to true equator/rotating body centered frame. Note that when used in UserIAUPole, effects are cumulative. One cannot only get the harmonic effects alone for instance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT Constant part only (transformation between ICRF and inertially-oriented frame).
MEAN Constant + secular effects (transformation between inertially-oriented and mean equator/rotating frame).
TRUE Constant + secular + harmonic effects (transformation between inertially-oriented and true equator/rotating frame).

Method Summary

Modifier and Type	Method and Description
static IAUPoleModelType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IAUPoleModelType[]	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

CONSTANT

public static final IAUPoleModelType CONSTANT

Constant part only (transformation between ICRF and inertially-oriented frame).

MEAN

public static final IAUPoleModelType MEAN

Constant + secular effects (transformation between inertially-oriented and mean equator/rotating frame).

TRUE

public static final IAUPoleModelType TRUE

Constant + secular + harmonic effects (transformation between inertially-oriented and true equator/rotating frame).

Method Detail

values

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

Returns:

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

valueOf

public static IAUPoleModelType 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