org.orekit.files.ccsds.ndm.odm

Enum CommonMetadataKey

java.lang.Object

java.lang.Enum<CommonMetadataKey>

org.orekit.files.ccsds.ndm.odm.CommonMetadataKey

All Implemented Interfaces:

Serializable, Comparable<CommonMetadataKey>

public enum CommonMetadataKey
extends Enum<CommonMetadataKey>

Keys for common ODM container entries.

Since:

11.0

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER_NAME Center name entry.
OBJECT_ID Object ID entry.
REF_FRAME Name of the reference frame in which the state vector and optional Keplerian element data are given.
REF_FRAME_EPOCH Epoch of reference frame, if not intrinsic to the definition of the reference frame.

Method Summary

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

OBJECT_ID

public static final CommonMetadataKey OBJECT_ID

Object ID entry.

CENTER_NAME

public static final CommonMetadataKey CENTER_NAME

Center name entry.

REF_FRAME

public static final CommonMetadataKey REF_FRAME

Name of the reference frame in which the state vector and optional Keplerian element data are given.

REF_FRAME_EPOCH

public static final CommonMetadataKey REF_FRAME_EPOCH

Epoch of reference frame, if not intrinsic to the definition of the reference frame.

Method Detail

values

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

Returns:

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

valueOf

public static CommonMetadataKey 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,
                       OdmCommonMetadata container)

Process one token.

Parameters:

token - token to process

context - context binding

container - container to fill

Returns:

true of token was accepted