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

Enum ApmQuaternionKey

java.lang.Object

java.lang.Enum<ApmQuaternionKey>

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

All Implemented Interfaces:

Serializable, Comparable<ApmQuaternionKey>

public enum ApmQuaternionKey
extends Enum<ApmQuaternionKey>

Keys for APM quaternion entries.

Since:

10.2

Author:

Bryan Cazabonne

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMENT	Comment entry.
EPOCH	Epoch entry (only for ADM V1).
Q_DIR	Rotation direction entry.
Q_FRAME_A	First reference frame entry (ADM V1 only).
Q_FRAME_B	Second reference frame entry (ADM V1 only).
Q1	First component of the vector part of the quaternion entry.
Q1_DOT	First component of the vector part of the quaternion derivative entry.
Q2	Second component of the vector part of the quaternion entry.
Q2_DOT	Second component of the vector part of the quaternion derivative entry.
Q3	Third component of the vector part of the quaternion entry.
Q3_DOT	Third component of the vector part of the quaternion derivative entry.
QC	Scalar part of the quaternion entry.
QC_DOT	Scalar part of the quaternion derivative entry.
quaternion	Quaternion wrapping element in XML files.
quaternionDot	Quaternion derivative wrapping element in XML files.
quaternionRate	Quaternion derivative wrapping element in XML files (ADM V1 only).
REF_FRAME_A	First reference frame entry.
REF_FRAME_B	Second reference frame entry.

Method Summary

Modifier and Type	Method	Description
boolean	process(ParseToken token, ContextBinding context, ApmQuaternion container, ParseToken.DateConsumer epochSetter)	Process one token.
static ApmQuaternionKey	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ApmQuaternionKey[]	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

quaternion

public static final ApmQuaternionKey quaternion

Quaternion wrapping element in XML files.

quaternionRate

public static final ApmQuaternionKey quaternionRate

Quaternion derivative wrapping element in XML files (ADM V1 only).

quaternionDot

public static final ApmQuaternionKey quaternionDot

Quaternion derivative wrapping element in XML files.

Since:

12.0

COMMENT

public static final ApmQuaternionKey COMMENT

Comment entry.

EPOCH

public static final ApmQuaternionKey EPOCH

Epoch entry (only for ADM V1).

Q_FRAME_A

public static final ApmQuaternionKey Q_FRAME_A

First reference frame entry (ADM V1 only).

REF_FRAME_A

public static final ApmQuaternionKey REF_FRAME_A

First reference frame entry.

Since:

12.0

Q_FRAME_B

public static final ApmQuaternionKey Q_FRAME_B

Second reference frame entry (ADM V1 only).

REF_FRAME_B

public static final ApmQuaternionKey REF_FRAME_B

Second reference frame entry.

Since:

12.0

Q_DIR

public static final ApmQuaternionKey Q_DIR

Rotation direction entry.

QC

public static final ApmQuaternionKey QC

Scalar part of the quaternion entry.

Q1

public static final ApmQuaternionKey Q1

First component of the vector part of the quaternion entry.

Q2

public static final ApmQuaternionKey Q2

Second component of the vector part of the quaternion entry.

Q3

public static final ApmQuaternionKey Q3

Third component of the vector part of the quaternion entry.

QC_DOT

public static final ApmQuaternionKey QC_DOT

Scalar part of the quaternion derivative entry.

Q1_DOT

public static final ApmQuaternionKey Q1_DOT

First component of the vector part of the quaternion derivative entry.

Q2_DOT

public static final ApmQuaternionKey Q2_DOT

Second component of the vector part of the quaternion derivative entry.

Q3_DOT

public static final ApmQuaternionKey Q3_DOT

Third component of the vector part of the quaternion derivative entry.

Method Detail

values

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

Returns:

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

valueOf

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

process

public boolean process(ParseToken token,
                       ContextBinding context,
                       ApmQuaternion container,
                       ParseToken.DateConsumer epochSetter)

Process one token.

Parameters:

token - token to process

context - context binding

container - container to fill

epochSetter - setter for the epoch (used only in ADM V1 XML files)

Returns:

true of token was accepted