Package org.orekit.files.ccsds.ndm.cdm

Enum CdmHeaderKey

java.lang.Object

java.lang.Enum<CdmHeaderKey>

org.orekit.files.ccsds.ndm.cdm.CdmHeaderKey

All Implemented Interfaces:

Serializable, Comparable<CdmHeaderKey>

public enum CdmHeaderKey
extends Enum<CdmHeaderKey>

Keywords allowed in CdmHeader.

Since:

11.2

Author:

Melina Vanel

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASSIFICATION	User-defined free-text message classification or caveats of this CDM.
MESSAGE_FOR	Creating spacecraft name for which the CDM is provided.

Method Summary

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

MESSAGE_FOR

public static final CdmHeaderKey MESSAGE_FOR

Creating spacecraft name for which the CDM is provided.

CLASSIFICATION

public static final CdmHeaderKey CLASSIFICATION

User-defined free-text message classification or caveats of this CDM.

Method Detail

values

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

Returns:

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

valueOf

public static CdmHeaderKey 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,
                       CdmHeader header)

Process an token.

Parameters:

token - token to process

context - context binding

header - header to fill

Returns:

true of token was accepted