Package org.orekit.files.ccsds.ndm.adm.apm

Enum Class EulerKey

java.lang.Object

java.lang.Enum<EulerKey>

org.orekit.files.ccsds.ndm.adm.apm.EulerKey

All Implemented Interfaces:

Serializable, Comparable<EulerKey>, Constable

public enum EulerKey
extends Enum<EulerKey>

Keys for APM Euler angles entries.

Since:

10.2

Author:

Bryan Cazabonne

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANGLE_1	First body rotation angle entry.
ANGLE_1_DOT	First body rotation rate entry.
ANGLE_2	Second body rotation angle entry.
ANGLE_2_DOT	Second body rotation rate entry.
ANGLE_3	Third body rotation angle entry.
ANGLE_3_DOT	Third body rotation rate entry.
COMMENT	Comment entry.
EULER_DIR	Rotation direction entry (ADM V1 only).
EULER_FRAME_A	First reference frame entry (only for ADM V1).
EULER_FRAME_B	Second reference frame entry (only for ADM V1).
EULER_ROT_SEQ	Rotation sequence entry.
RATE_FRAME	Reference frame for rate entry (ADM V1 only).
REF_FRAME_A	First reference frame entry.
REF_FRAME_B	Second reference frame entry.
rotationAngles	Rotation angles wrapping element in XML files (ADM V1 only).
rotationRates	Rotation rates wrapping element in XML files (ADM V1 only).
X_ANGLE	X body rotation angle entry (ADM V1 only).
X_RATE	X body rotation rate entry (ADM V1 only).
Y_ANGLE	Y body rotation angle entry (ADM V1 only).
Y_RATE	Y body rotation rate entry (ADM V1 only).
Z_ANGLE	Z body rotation angle entry (ADM V1 only).
Z_RATE	Z body rotation rate entry (ADM V1 only).

Method Summary

Modifier and Type	Method	Description
boolean	process(ParseToken token, ContextBinding context, Euler container)	Process one token.
static EulerKey	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EulerKey[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

rotationAngles

public static final EulerKey rotationAngles

Rotation angles wrapping element in XML files (ADM V1 only).

rotationRates

public static final EulerKey rotationRates

Rotation rates wrapping element in XML files (ADM V1 only).

COMMENT

public static final EulerKey COMMENT

Comment entry.

EULER_FRAME_A

public static final EulerKey EULER_FRAME_A

First reference frame entry (only for ADM V1).

REF_FRAME_A

public static final EulerKey REF_FRAME_A

First reference frame entry.

Since:

12.0

EULER_FRAME_B

public static final EulerKey EULER_FRAME_B

Second reference frame entry (only for ADM V1).

REF_FRAME_B

public static final EulerKey REF_FRAME_B

Second reference frame entry.

Since:

12.0

EULER_DIR

public static final EulerKey EULER_DIR

Rotation direction entry (ADM V1 only).

EULER_ROT_SEQ

public static final EulerKey EULER_ROT_SEQ

Rotation sequence entry.

RATE_FRAME

public static final EulerKey RATE_FRAME

Reference frame for rate entry (ADM V1 only).

X_ANGLE

public static final EulerKey X_ANGLE

X body rotation angle entry (ADM V1 only).

Y_ANGLE

public static final EulerKey Y_ANGLE

Y body rotation angle entry (ADM V1 only).

Z_ANGLE

public static final EulerKey Z_ANGLE

Z body rotation angle entry (ADM V1 only).

X_RATE

public static final EulerKey X_RATE

X body rotation rate entry (ADM V1 only).

Y_RATE

public static final EulerKey Y_RATE

Y body rotation rate entry (ADM V1 only).

Z_RATE

public static final EulerKey Z_RATE

Z body rotation rate entry (ADM V1 only).

ANGLE_1

public static final EulerKey ANGLE_1

First body rotation angle entry.

Since:

12.0

ANGLE_2

public static final EulerKey ANGLE_2

Second body rotation angle entry.

Since:

12.0

ANGLE_3

public static final EulerKey ANGLE_3

Third body rotation angle entry.

Since:

12.0

ANGLE_1_DOT

public static final EulerKey ANGLE_1_DOT

First body rotation rate entry.

Since:

12.0

ANGLE_2_DOT

public static final EulerKey ANGLE_2_DOT

Second body rotation rate entry.

Since:

12.0

ANGLE_3_DOT

public static final EulerKey ANGLE_3_DOT

Third body rotation rate entry.

Since:

12.0

Method Details

values

public static EulerKey[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EulerKey valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

process

public boolean process(ParseToken token,
 ContextBinding context,
 Euler container)

Process one token.

Parameters:

token - token to process

context - context binding

container - container to fill

Returns:

true of token was accepted