fr.cnes.sirius.patrius.bodies

Enum IAUPoleFunctionType

java.lang.Object

java.lang.Enum<IAUPoleFunctionType>

fr.cnes.sirius.patrius.bodies.IAUPoleFunctionType

All Implemented Interfaces:

Serializable, Comparable<IAUPoleFunctionType>

public enum IAUPoleFunctionType
extends Enum<IAUPoleFunctionType>

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. This class is used for defining effects alone. They cannot however be used alone for transformation computation. For transformation computation, effects are used cumulatively through IAUPoleModelType class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT Constant part only (transformation between ICRF and inertially-oriented frame).
HARMONICS Harmonic effects (transformation between mean equator/rotating and true equator/rotating frame).
SECULAR Secular effects (transformation between inertially-oriented and mean equator/rotating frame).

Method Summary

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

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

SECULAR

public static final IAUPoleFunctionType SECULAR

Secular effects (transformation between inertially-oriented and mean equator/rotating frame).

HARMONICS

public static final IAUPoleFunctionType HARMONICS

Harmonic effects (transformation between mean equator/rotating and true equator/rotating frame).

Method Detail

values

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

Returns:

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

valueOf

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