CdmRelativeMetadataKey (ORbit Extrapolation KIT 11.2.1 API)

java.lang.Object
- java.lang.Enum<CdmRelativeMetadataKey>
- - org.orekit.files.ccsds.ndm.cdm.CdmRelativeMetadataKey

All Implemented Interfaces:

Serializable, Comparable<CdmRelativeMetadataKey>
```
public enum CdmRelativeMetadataKey
extends Enum<CdmRelativeMetadataKey>
```
Keys for CDM container entries.

Since:

11.2

Author:

Melina Vanel

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COLLISION_PROBABILITY` The probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
`COLLISION_PROBABILITY_METHOD` The method that was used to calculate the collision probability.
`MISS_DISTANCE` Norm of relative position vector at TCA.
`RELATIVE_POSITION_N` The N component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
`RELATIVE_POSITION_R` The R component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
`RELATIVE_POSITION_T` The T component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
`RELATIVE_SPEED` Norm of relative velocity vector at TCA.
`RELATIVE_VELOCITY_N` The N component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
`RELATIVE_VELOCITY_R` The R component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
`RELATIVE_VELOCITY_T` The T component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
`SCREEN_ENTRY_TIME` The time in UTC when Object2 enters the screening volume.
`SCREEN_EXIT_TIME` The time in UTC when Object2 exits the screening volume.
`SCREEN_VOLUME_FRAME` Name of the Object1 centered reference frame in which the screening volume data are given.
`SCREEN_VOLUME_SHAPE` Shape of the screening volume.
`SCREEN_VOLUME_X` The R or T (depending on if RTN or TVN is selected) component size of the screening volume in the SCREEN_VOLUME_FRAME.
`SCREEN_VOLUME_Y` The T or V (depending on if RTN or TVN is selected) component size of the screening volume in the SCREEN_VOLUME_FRAME.
`SCREEN_VOLUME_Z` The N component size of the screening volume in the SCREEN_VOLUME_FRAME.
`START_SCREEN_PERIOD` The start time in UTC of the screening period for the conjunction assessment.
`STOP_SCREEN_PERIOD` The stop time in UTC of the screening period for the conjunction assessment.
`TCA` Date and time in UTC of the closest approach.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`process(ParseToken token, ContextBinding context, CdmRelativeMetadata container)` Process one token.
`static CdmRelativeMetadataKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CdmRelativeMetadataKey[]`	`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
  - TCA
```
public static final CdmRelativeMetadataKey TCA
```
    Date and time in UTC of the closest approach.
  - MISS_DISTANCE
```
public static final CdmRelativeMetadataKey MISS_DISTANCE
```
    Norm of relative position vector at TCA.
  - RELATIVE_SPEED
```
public static final CdmRelativeMetadataKey RELATIVE_SPEED
```
    Norm of relative velocity vector at TCA.
  - RELATIVE_POSITION_R
```
public static final CdmRelativeMetadataKey RELATIVE_POSITION_R
```
    The R component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
  - RELATIVE_POSITION_T
```
public static final CdmRelativeMetadataKey RELATIVE_POSITION_T
```
    The T component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
  - RELATIVE_POSITION_N
```
public static final CdmRelativeMetadataKey RELATIVE_POSITION_N
```
    The N component of Object2’s position relative to Object1’s position in the Radial/Transverse/Normal coordinate frame.
  - RELATIVE_VELOCITY_R
```
public static final CdmRelativeMetadataKey RELATIVE_VELOCITY_R
```
    The R component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
  - RELATIVE_VELOCITY_T
```
public static final CdmRelativeMetadataKey RELATIVE_VELOCITY_T
```
    The T component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
  - RELATIVE_VELOCITY_N
```
public static final CdmRelativeMetadataKey RELATIVE_VELOCITY_N
```
    The N component of Object2’s velocity relative to Object1’s veloity in the Radial/Transverse/Normal coordinate frame.
  - START_SCREEN_PERIOD
```
public static final CdmRelativeMetadataKey START_SCREEN_PERIOD
```
    The start time in UTC of the screening period for the conjunction assessment.
  - STOP_SCREEN_PERIOD
```
public static final CdmRelativeMetadataKey STOP_SCREEN_PERIOD
```
    The stop time in UTC of the screening period for the conjunction assessment.
  - SCREEN_VOLUME_FRAME
```
public static final CdmRelativeMetadataKey SCREEN_VOLUME_FRAME
```
    Name of the Object1 centered reference frame in which the screening volume data are given.
  - SCREEN_VOLUME_SHAPE
```
public static final CdmRelativeMetadataKey SCREEN_VOLUME_SHAPE
```
    Shape of the screening volume.
  - SCREEN_VOLUME_X
```
public static final CdmRelativeMetadataKey SCREEN_VOLUME_X
```
    The R or T (depending on if RTN or TVN is selected) component size of the screening volume in the SCREEN_VOLUME_FRAME.
  - SCREEN_VOLUME_Y
```
public static final CdmRelativeMetadataKey SCREEN_VOLUME_Y
```
    The T or V (depending on if RTN or TVN is selected) component size of the screening volume in the SCREEN_VOLUME_FRAME.
  - SCREEN_VOLUME_Z
```
public static final CdmRelativeMetadataKey SCREEN_VOLUME_Z
```
    The N component size of the screening volume in the SCREEN_VOLUME_FRAME.
  - SCREEN_ENTRY_TIME
```
public static final CdmRelativeMetadataKey SCREEN_ENTRY_TIME
```
    The time in UTC when Object2 enters the screening volume.
  - SCREEN_EXIT_TIME
```
public static final CdmRelativeMetadataKey SCREEN_EXIT_TIME
```
    The time in UTC when Object2 exits the screening volume.
  - COLLISION_PROBABILITY
```
public static final CdmRelativeMetadataKey COLLISION_PROBABILITY
```
    The probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
  - COLLISION_PROBABILITY_METHOD
```
public static final CdmRelativeMetadataKey COLLISION_PROBABILITY_METHOD
```
    The method that was used to calculate the collision probability.
- Method Detail
  - values
```
public static CdmRelativeMetadataKey[] 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 (CdmRelativeMetadataKey c : CdmRelativeMetadataKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CdmRelativeMetadataKey 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,
                       CdmRelativeMetadata container)
```
    Process one token.
    
    Parameters:
    
    token - token to process
    
    context - context binding
    
    container - container to fill
    
    Returns:
    
    true of token was accepted

Enum CdmRelativeMetadataKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TCA

MISS_DISTANCE

RELATIVE_SPEED

RELATIVE_POSITION_R

RELATIVE_POSITION_T

RELATIVE_POSITION_N

RELATIVE_VELOCITY_R

RELATIVE_VELOCITY_T

RELATIVE_VELOCITY_N

START_SCREEN_PERIOD

STOP_SCREEN_PERIOD

SCREEN_VOLUME_FRAME

SCREEN_VOLUME_SHAPE

SCREEN_VOLUME_X

SCREEN_VOLUME_Y

SCREEN_VOLUME_Z

SCREEN_ENTRY_TIME

SCREEN_EXIT_TIME

COLLISION_PROBABILITY

COLLISION_PROBABILITY_METHOD

Method Detail

values

valueOf

process