Package org.orekit.files.ccsds.ndm.odm.ocm

Enum Class OcmMetadataKey

java.lang.Object

java.lang.Enum<OcmMetadataKey>

org.orekit.files.ccsds.ndm.odm.ocm.OcmMetadataKey

All Implemented Interfaces:

Serializable, Comparable<OcmMetadataKey>, Constable

public enum OcmMetadataKey
extends Enum<OcmMetadataKey>

Keys for OCM container entries.

Since:

11.0

Author:

Luc Maisonobe

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
ADM_MSG_LINK	Unique identifier of Attitude Data Message linked to this Orbit Data Message.
ALTERNATE_NAMES	Alternate names fir this space object.
CATALOG_NAME	Specification of satellite catalog source.
CDM_MSG_LINK	Unique identifier of Conjunction Data Message linked to this Orbit Data Message.
CELESTIAL_SOURCE	Source and version of celestial body (e.g.
CONSTELLATION	Name of the constellation this space object belongs to.
COUNTRY	Name of the country where the space object owner is based.
EOP_SOURCE	Source and version of Earth Orientation Parameters.
EPOCH_TZERO	Default epoch to which all relative times are referenced in data blocks, unless overridden by block-specific EPOCH_TZERO values.
INTERNATIONAL_DESIGNATOR	International designator for the object as assigned by the UN Committee on Space Research (COSPAR) and the US National Space Science Data Center (NSSDC).
INTERP_METHOD_EOP	Interpolation method for Earth Orientation Parameters.
NEXT_LEAP_EPOCH	Epoch of next leap second.
NEXT_LEAP_TAIMUTC	Difference (TAI – UTC) in seconds incorporated at NEXT_LEAP_EPOCH.
NEXT_MESSAGE_EPOCH	Creation date of next message from a given originator.
NEXT_MESSAGE_ID	Unique ID identifying next message from a given originator.
OBJECT_DESIGNATOR	Unique satellite identification designator for the object.
OBJECT_TYPE	Type of object.
OCM_DATA_ELEMENTS	List of elements of information data blocks included in this message.
OPERATOR	Operator of the space object.
OPS_STATUS	Operational status.
ORBIT_CATEGORY	Orbit category.
ORIGINATOR_ADDRESS	Address of Programmatic Point Of Contact at originator.
ORIGINATOR_EMAIL	Email address of Programmatic Point Of Contact at originator.
ORIGINATOR_PHONE	Phone number of Programmatic Point Of Contact at originator.
ORIGINATOR_POC	Programmatic Point Of Contact at originator.
ORIGINATOR_POSITION	Position of Programmatic Point Of Contact at originator.
OWNER	Owner of the space object.
PREVIOUS_MESSAGE_EPOCH	Creation date of previous message from a given originator.
PREVIOUS_MESSAGE_ID	Unique ID identifying previous message from a given originator.
PRM_MSG_LINK	Unique identifier of Pointing Request Message linked to this Orbit Data Message.
RDM_MSG_LINK	Unique identifier of Reentry Data Message linked to this Orbit Data Message.
SCLK_OFFSET_AT_EPOCH	Spacecraft clock count at EPOCH_TZERO.
SCLK_SEC_PER_SI_SEC	Number of clock seconds occurring during one SI second.
START_TIME	Start time entry.
STOP_TIME	Stop time entry.
TAIMUTC_AT_TZERO	Difference (TAI – UTC) in seconds at epoch EPOCH_TZERO.
TDM_MSG_LINK	Unique identifier of Tracking Data Message linked to this Orbit Data Message.
TECH_ADDRESS	Address of Technical Point Of Contact at originator.
TECH_EMAIL	Email address of Technical Point Of Contact at originator.
TECH_ORG	Creating agency or operator.
TECH_PHONE	Phone number of Technical Point Of Contact at originator.
TECH_POC	Technical Point Of Contact at originator.
TECH_POSITION	Position of Technical Point Of Contact at originator.
TIME_SPAN	Span of time that the OCM covers.
UT1MUTC_AT_TZERO	Difference (UT1 – UTC) in seconds at epoch EPOCH_TZERO.

Method Summary

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

INTERNATIONAL_DESIGNATOR

public static final OcmMetadataKey INTERNATIONAL_DESIGNATOR

International designator for the object as assigned by the UN Committee on Space Research (COSPAR) and the US National Space Science Data Center (NSSDC).

CATALOG_NAME

public static final OcmMetadataKey CATALOG_NAME

Specification of satellite catalog source.

OBJECT_DESIGNATOR

public static final OcmMetadataKey OBJECT_DESIGNATOR

Unique satellite identification designator for the object.

ALTERNATE_NAMES

public static final OcmMetadataKey ALTERNATE_NAMES

Alternate names fir this space object.

ORIGINATOR_POC

public static final OcmMetadataKey ORIGINATOR_POC

Programmatic Point Of Contact at originator.

ORIGINATOR_POSITION

public static final OcmMetadataKey ORIGINATOR_POSITION

Position of Programmatic Point Of Contact at originator.

ORIGINATOR_PHONE

public static final OcmMetadataKey ORIGINATOR_PHONE

Phone number of Programmatic Point Of Contact at originator.

ORIGINATOR_EMAIL

public static final OcmMetadataKey ORIGINATOR_EMAIL

Email address of Programmatic Point Of Contact at originator.

Since:

11.2

ORIGINATOR_ADDRESS

public static final OcmMetadataKey ORIGINATOR_ADDRESS

Address of Programmatic Point Of Contact at originator.

TECH_ORG

public static final OcmMetadataKey TECH_ORG

Creating agency or operator.

TECH_POC

public static final OcmMetadataKey TECH_POC

Technical Point Of Contact at originator.

TECH_POSITION

public static final OcmMetadataKey TECH_POSITION

Position of Technical Point Of Contact at originator.

TECH_PHONE

public static final OcmMetadataKey TECH_PHONE

Phone number of Technical Point Of Contact at originator.

TECH_EMAIL

public static final OcmMetadataKey TECH_EMAIL

Email address of Technical Point Of Contact at originator.

Since:

11.2

TECH_ADDRESS

public static final OcmMetadataKey TECH_ADDRESS

Address of Technical Point Of Contact at originator.

PREVIOUS_MESSAGE_ID

public static final OcmMetadataKey PREVIOUS_MESSAGE_ID

Unique ID identifying previous message from a given originator.

NEXT_MESSAGE_ID

public static final OcmMetadataKey NEXT_MESSAGE_ID

Unique ID identifying next message from a given originator.

ADM_MSG_LINK

public static final OcmMetadataKey ADM_MSG_LINK

Unique identifier of Attitude Data Message linked to this Orbit Data Message.

CDM_MSG_LINK

public static final OcmMetadataKey CDM_MSG_LINK

Unique identifier of Conjunction Data Message linked to this Orbit Data Message.

PRM_MSG_LINK

public static final OcmMetadataKey PRM_MSG_LINK

Unique identifier of Pointing Request Message linked to this Orbit Data Message.

RDM_MSG_LINK

public static final OcmMetadataKey RDM_MSG_LINK

Unique identifier of Reentry Data Message linked to this Orbit Data Message.

TDM_MSG_LINK

public static final OcmMetadataKey TDM_MSG_LINK

Unique identifier of Tracking Data Message linked to this Orbit Data Message.

OPERATOR

public static final OcmMetadataKey OPERATOR

Operator of the space object.

OWNER

public static final OcmMetadataKey OWNER

Owner of the space object.

COUNTRY

public static final OcmMetadataKey COUNTRY

Name of the country where the space object owner is based.

CONSTELLATION

public static final OcmMetadataKey CONSTELLATION

Name of the constellation this space object belongs to.

OBJECT_TYPE

public static final OcmMetadataKey OBJECT_TYPE

Type of object.

See Also:

• ObjectType

EPOCH_TZERO

public static final OcmMetadataKey EPOCH_TZERO

Default epoch to which all relative times are referenced in data blocks, unless overridden by block-specific EPOCH_TZERO values.

OPS_STATUS

public static final OcmMetadataKey OPS_STATUS

Operational status.

See Also:

• OpsStatus

ORBIT_CATEGORY

public static final OcmMetadataKey ORBIT_CATEGORY

Orbit category.

See Also:

• OrbitCategory

OCM_DATA_ELEMENTS

public static final OcmMetadataKey OCM_DATA_ELEMENTS

List of elements of information data blocks included in this message.

SCLK_OFFSET_AT_EPOCH

public static final OcmMetadataKey SCLK_OFFSET_AT_EPOCH

Spacecraft clock count at EPOCH_TZERO.

SCLK_SEC_PER_SI_SEC

public static final OcmMetadataKey SCLK_SEC_PER_SI_SEC

Number of clock seconds occurring during one SI second.

PREVIOUS_MESSAGE_EPOCH

public static final OcmMetadataKey PREVIOUS_MESSAGE_EPOCH

Creation date of previous message from a given originator.

NEXT_MESSAGE_EPOCH

public static final OcmMetadataKey NEXT_MESSAGE_EPOCH

Creation date of next message from a given originator.

START_TIME

public static final OcmMetadataKey START_TIME

Start time entry.

STOP_TIME

public static final OcmMetadataKey STOP_TIME

Stop time entry.

TIME_SPAN

public static final OcmMetadataKey TIME_SPAN

Span of time that the OCM covers.

TAIMUTC_AT_TZERO

public static final OcmMetadataKey TAIMUTC_AT_TZERO

Difference (TAI – UTC) in seconds at epoch EPOCH_TZERO.

NEXT_LEAP_EPOCH

public static final OcmMetadataKey NEXT_LEAP_EPOCH

Epoch of next leap second.

Since:

11.2

NEXT_LEAP_TAIMUTC

public static final OcmMetadataKey NEXT_LEAP_TAIMUTC

Difference (TAI – UTC) in seconds incorporated at NEXT_LEAP_EPOCH.

Since:

11.2

UT1MUTC_AT_TZERO

public static final OcmMetadataKey UT1MUTC_AT_TZERO

Difference (UT1 – UTC) in seconds at epoch EPOCH_TZERO.

EOP_SOURCE

public static final OcmMetadataKey EOP_SOURCE

Source and version of Earth Orientation Parameters.

INTERP_METHOD_EOP

public static final OcmMetadataKey INTERP_METHOD_EOP

Interpolation method for Earth Orientation Parameters.

CELESTIAL_SOURCE

public static final OcmMetadataKey CELESTIAL_SOURCE

Source and version of celestial body (e.g. Sun/Earth/Planetary).

Method Details

values

public static OcmMetadataKey[] 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 OcmMetadataKey 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,
 OcmMetadata container)

Process an token.

Parameters:

token - token to process

context - context binding

container - container to fill

Returns:

true of token was accepted