calc.main

Enum UserFramesConfsEnum

java.lang.Object

java.lang.Enum<UserFramesConfsEnum>

calc.main.UserFramesConfsEnum

All Implemented Interfaces:

Serializable, Comparable<UserFramesConfsEnum>

public enum UserFramesConfsEnum
extends Enum<UserFramesConfsEnum>

Enumerate of the possible frames configuration to be used in JPSIMU.

Author:

ffsm

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY Any correction is active.
FACTORY The default IERS2000 configuration.
IGNORE The PATRIUS default configuration is used.
ONLY_PREC_NUT Only precession and nutation are active.

Method Summary

Modifier and Type	Method and Description
void	apply() Applies (PATRIUS singleton) the frames configuration corresponding to the enumerate item.
fr.cnes.sirius.patrius.frames.configuration.FramesConfiguration	getFramesConfiguration() Returns the frames configuration corresponding to the enumerate item.
static UserFramesConfsEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserFramesConfsEnum[]	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

IGNORE

public static final UserFramesConfsEnum IGNORE

The PATRIUS default configuration is used.

FACTORY

public static final UserFramesConfsEnum FACTORY

The default IERS2000 configuration.

ONLY_PREC_NUT

public static final UserFramesConfsEnum ONLY_PREC_NUT

Only precession and nutation are active.

EMPTY

public static final UserFramesConfsEnum EMPTY

Any correction is active.

Method Detail

values

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

Returns:

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

valueOf

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

getFramesConfiguration

public fr.cnes.sirius.patrius.frames.configuration.FramesConfiguration getFramesConfiguration()

Returns the frames configuration corresponding to the enumerate item.

Returns:

the frames configuration corresponding to the enumerate item.

apply

public void apply()

Applies (PATRIUS singleton) the frames configuration corresponding to the enumerate item.