CdmRelativeMetadata (ORbit Extrapolation KIT 11.2.1 API)

java.lang.Object
- org.orekit.files.ccsds.ndm.cdm.CdmRelativeMetadata

```
public class CdmRelativeMetadata
extends Object
```
This class gathers the relative meta-data present in the Conjunction Data Message (CDM).

Since:

11.2

Author:

Melina Vanel

Constructor Summary

Constructors
Constructor and Description

CdmRelativeMetadata()
Simple constructor.

Constructors
Constructor and Description
`CdmRelativeMetadata()` Simple constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComment(String comments)` Set comment for relative metadata.
`void`	`checkNotNull(Object field, Enum<?> key)` Complain if a field is null.
`double`	`getCollisionProbability()` Get the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
`PocMethodFacade`	`getCollisionProbaMethod()` Get the method that was used to calculate the collision probability.
`List<String>`	`getComment()` Get comment for relative metadata.
`double`	`getMissDistance()` Get the norm of relative position vector at TCA.
`Vector3D`	`getRelativePosition()` Get the Object2’s position vector relative to Object1's at TCA in RTN frame, getX for R component, getY for T component, getZ for N component.
`double`	`getRelativeSpeed()` Get the norm of relative velocity vector at TCA.
`Vector3D`	`getRelativeVelocity()` Get the Object2’s velocity vector relative to Object1's at TCA in RTN frame, getX for R component, getY for T component, getZ for N component.
`AbsoluteDate`	`getScreenEntryTime()` Get the time in UTC when Object2 enters the screening volume.
`AbsoluteDate`	`getScreenExitTime()` Get the time in UTC when Object2 exits the screening volume.
`ScreenVolumeFrame`	`getScreenVolumeFrame()` Get the name of the Object1 centered reference frame in which the screening volume data are given.
`ScreenVolumeShape`	`getScreenVolumeShape()` Get the shape of the screening volume.
`double`	`getScreenVolumeX()` Get the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
`double`	`getScreenVolumeY()` Get the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
`double`	`getScreenVolumeZ()` Get the N component size of the screening volume in the corresponding frame.
`AbsoluteDate`	`getStartScreenPeriod()` Get the start time in UTC of the screening period for the conjunction assessment.
`AbsoluteDate`	`getStopScreenPeriod()` Get the stop time in UTC of the screening period for the conjunction assessment.
`AbsoluteDate`	`getTca()` Get the date and time in UTC of the closest approach.
`TimeSystem`	`getTimeSystem()` Get the Time System that: for CDM, is used for relative metadata, metadata, OD parameters, state vector.
`void`	`setCollisionProbability(double collisionProbability)` Set the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
`void`	`setCollisionProbaMethod(PocMethodFacade collisionProbaMethod)` Set the method that was used to calculate the collision probability.
`void`	`setMissDistance(double missDistance)` Set the norm of relative position vector at TCA.
`void`	`setRelativePositionN(double relativePositionN)` Set the N component of Object2’s position relative to Object1’s in RTN frame.
`void`	`setRelativePositionR(double relativePositionR)` Set the R component of Object2’s position relative to Object1’s in RTN frame.
`void`	`setRelativePositionT(double relativePositionT)` Set the T component of Object2’s position relative to Object1’s in RTN frame.
`void`	`setRelativeSpeed(double relativeSpeed)` Set the norm of relative velocity vector at TCA.
`void`	`setRelativeVelocityN(double relativeVelocityN)` Set the N component of Object2’s velocity relative to Object1’s in RTN frame.
`void`	`setRelativeVelocityR(double relativeVelocityR)` Set the R component of Object2’s velocity relative to Object1’s in RTN frame.
`void`	`setRelativeVelocityT(double relativeVelocityT)` Set the T component of Object2’s velocity relative to Object1’s in RTN frame.
`void`	`setScreenEntryTime(AbsoluteDate screenEntryTime)` Set the time in UTC when Object2 enters the screening volume.
`void`	`setScreenExitTime(AbsoluteDate screenExitTime)` Set the time in UTC when Object2 exits the screening volume.
`void`	`setScreenVolumeFrame(ScreenVolumeFrame screenVolumeFrame)` Set the name of the Object1 centered reference frame in which the screening volume data are given.
`void`	`setScreenVolumeShape(ScreenVolumeShape screenVolumeShape)` Set the shape of the screening volume.
`void`	`setScreenVolumeX(double screenVolumeX)` Set the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
`void`	`setScreenVolumeY(double screenVolumeY)` Set the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
`void`	`setScreenVolumeZ(double screenVolumeZ)` Set the N component size of the screening volume in the corresponding frame.
`void`	`setStartScreenPeriod(AbsoluteDate startScreenPeriod)` Set the start time in UTC of the screening period for the conjunction assessment.
`void`	`setStopScreenPeriod(AbsoluteDate stopScreenPeriod)` Set the stop time in UTC of the screening period for the conjunction assessment.
`void`	`setTca(AbsoluteDate tca)` Set the date and time in UTC of the closest approach.
`void`	`setTimeSystem(TimeSystem timeSystem)` Set the Time System that: for CDM, is used for relative metadata, metadata, OD parameters, state vector.
`void`	`validate()` Check is all mandatory entries have been initialized.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CdmRelativeMetadata
```
public CdmRelativeMetadata()
```
    Simple constructor.
- Method Detail
  - validate
```
public void validate()
```
    Check is all mandatory entries have been initialized.
  - getTca
```
public AbsoluteDate getTca()
```
    Get the date and time in UTC of the closest approach.
    
    Returns:
    
    time of closest approach
  - setTca
```
public void setTca(AbsoluteDate tca)
```
    Set the date and time in UTC of the closest approach.
    
    Parameters:
    
    tca - time of closest approach to be set
  - getMissDistance
```
public double getMissDistance()
```
    Get the norm of relative position vector at TCA.
    
    Returns:
    
    the miss distance (in m)
  - setMissDistance
```
public void setMissDistance(double missDistance)
```
    Set the norm of relative position vector at TCA.
    
    Parameters:
    
    missDistance - the miss distance to be set (in m)
  - getRelativeSpeed
```
public double getRelativeSpeed()
```
    Get the norm of relative velocity vector at TCA.
    
    Returns:
    
    the relative speed at TCA (in m/s)
  - setRelativeSpeed
```
public void setRelativeSpeed(double relativeSpeed)
```
    Set the norm of relative velocity vector at TCA.
    
    Parameters:
    
    relativeSpeed - the relative speed (in m/s) at TCA to be set
  - getRelativeVelocity
```
public Vector3D getRelativeVelocity()
```
    Get the Object2’s velocity vector relative to Object1's at TCA in RTN frame, getX for R component, getY for T component, getZ for N component.
    
    Returns:
    
    the relative speed vector at TCA (in m/s)
  - getRelativePosition
```
public Vector3D getRelativePosition()
```
    Get the Object2’s position vector relative to Object1's at TCA in RTN frame, getX for R component, getY for T component, getZ for N component.
    
    Returns:
    
    the relative position vector at TCA (in m)
  - setRelativePositionR
```
public void setRelativePositionR(double relativePositionR)
```
    Set the R component of Object2’s position relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativePositionR - the R component (in m) of Object2’s position relative to Object1’s
  - setRelativePositionT
```
public void setRelativePositionT(double relativePositionT)
```
    Set the T component of Object2’s position relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativePositionT - the T component (in m) of Object2’s position relative to Object1’s
  - setRelativePositionN
```
public void setRelativePositionN(double relativePositionN)
```
    Set the N component of Object2’s position relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativePositionN - the N component (in m) of Object2’s position relative to Object1’s
  - setRelativeVelocityR
```
public void setRelativeVelocityR(double relativeVelocityR)
```
    Set the R component of Object2’s velocity relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativeVelocityR - the R component (in m/s) of Object2’s velocity relative to Object1’s
  - setRelativeVelocityT
```
public void setRelativeVelocityT(double relativeVelocityT)
```
    Set the T component of Object2’s velocity relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativeVelocityT - the T component (in m/s) of Object2’s velocity relative to Object1’s
  - setRelativeVelocityN
```
public void setRelativeVelocityN(double relativeVelocityN)
```
    Set the N component of Object2’s velocity relative to Object1’s in RTN frame.
    
    Parameters:
    
    relativeVelocityN - the N component (in m/s) of Object2’s velocity relative to Object1’s
  - getStartScreenPeriod
```
public AbsoluteDate getStartScreenPeriod()
```
    Get the start time in UTC of the screening period for the conjunction assessment.
    
    Returns:
    
    start time in UTC of the screening period
  - setStartScreenPeriod
```
public void setStartScreenPeriod(AbsoluteDate startScreenPeriod)
```
    Set the start time in UTC of the screening period for the conjunction assessment.
    
    Parameters:
    
    startScreenPeriod - start time in UTC of the screening period to be set
  - getStopScreenPeriod
```
public AbsoluteDate getStopScreenPeriod()
```
    Get the stop time in UTC of the screening period for the conjunction assessment.
    
    Returns:
    
    stop time in UTC of the screening period
  - setStopScreenPeriod
```
public void setStopScreenPeriod(AbsoluteDate stopScreenPeriod)
```
    Set the stop time in UTC of the screening period for the conjunction assessment.
    
    Parameters:
    
    stopScreenPeriod - stop time in UTC of the screening period to be set
  - getScreenVolumeFrame
```
public ScreenVolumeFrame getScreenVolumeFrame()
```
    Get the name of the Object1 centered reference frame in which the screening volume data are given.
    
    Returns:
    
    name of screen volume frame
  - setScreenVolumeFrame
```
public void setScreenVolumeFrame(ScreenVolumeFrame screenVolumeFrame)
```
    Set the name of the Object1 centered reference frame in which the screening volume data are given.
    
    Parameters:
    
    screenVolumeFrame - name of screen volume frame
  - getScreenVolumeShape
```
public ScreenVolumeShape getScreenVolumeShape()
```
    Get the shape of the screening volume.
    
    Returns:
    
    shape of the screening volume
  - setScreenVolumeShape
```
public void setScreenVolumeShape(ScreenVolumeShape screenVolumeShape)
```
    Set the shape of the screening volume.
    
    Parameters:
    
    screenVolumeShape - shape of the screening volume
  - getScreenVolumeX
```
public double getScreenVolumeX()
```
    Get the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
    
    Returns:
    
    first component size of the screening volume (in m)
  - setScreenVolumeX
```
public void setScreenVolumeX(double screenVolumeX)
```
    Set the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
    
    Parameters:
    
    screenVolumeX - first component size of the screening volume (in m)
  - getScreenVolumeY
```
public double getScreenVolumeY()
```
    Get the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
    
    Returns:
    
    second component size of the screening volume (in m)
  - setScreenVolumeY
```
public void setScreenVolumeY(double screenVolumeY)
```
    Set the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
    
    Parameters:
    
    screenVolumeY - second component size of the screening volume (in m)
  - getScreenVolumeZ
```
public double getScreenVolumeZ()
```
    Get the N component size of the screening volume in the corresponding frame.
    
    Returns:
    
    third component size of the screening volume (in m)
  - setScreenVolumeZ
```
public void setScreenVolumeZ(double screenVolumeZ)
```
    Set the N component size of the screening volume in the corresponding frame.
    
    Parameters:
    
    screenVolumeZ - third component size of the screening volume (in m)
  - getScreenEntryTime
```
public AbsoluteDate getScreenEntryTime()
```
    Get the time in UTC when Object2 enters the screening volume.
    
    Returns:
    
    time in UTC when Object2 enters the screening volume
  - setScreenEntryTime
```
public void setScreenEntryTime(AbsoluteDate screenEntryTime)
```
    Set the time in UTC when Object2 enters the screening volume.
    
    Parameters:
    
    screenEntryTime - time in UTC when Object2 enters the screening volume
  - getScreenExitTime
```
public AbsoluteDate getScreenExitTime()
```
    Get the time in UTC when Object2 exits the screening volume.
    
    Returns:
    
    time in UTC when Object2 exits the screening volume
  - setScreenExitTime
```
public void setScreenExitTime(AbsoluteDate screenExitTime)
```
    Set the time in UTC when Object2 exits the screening volume.
    
    Parameters:
    
    screenExitTime - time in UTC when Object2 exits the screening volume
  - getCollisionProbability
```
public double getCollisionProbability()
```
    Get the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
    
    Returns:
    
    probability of collision
  - setCollisionProbability
```
public void setCollisionProbability(double collisionProbability)
```
    Set the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
    
    Parameters:
    
    collisionProbability - first component size of the screening volume
  - getCollisionProbaMethod
```
public PocMethodFacade getCollisionProbaMethod()
```
    Get the method that was used to calculate the collision probability.
    
    Returns:
    
    method to calculate probability of collision
  - setCollisionProbaMethod
```
public void setCollisionProbaMethod(PocMethodFacade collisionProbaMethod)
```
    Set the method that was used to calculate the collision probability.
    
    Parameters:
    
    collisionProbaMethod - method used to calculate probability of collision
  - checkNotNull
```
public void checkNotNull(Object field,
                         Enum<?> key)
```
    Complain if a field is null.
    
    Parameters:
    
    field - field to check
    
    key - key associated with the field
  - setTimeSystem
```
public void setTimeSystem(TimeSystem timeSystem)
```
    Set the Time System that: for CDM, is used for relative metadata, metadata, OD parameters, state vector. In CDM all date are given in UTC.
    
    Parameters:
    
    timeSystem - the time system to be set
  - getTimeSystem
```
public TimeSystem getTimeSystem()
```
    Get the Time System that: for CDM, is used for relative metadata, metadata, OD parameters, state vector. In CDM all date are given in UTC.
    
    Returns:
    
    the time system
  - addComment
```
public void addComment(String comments)
```
    Set comment for relative metadata.
    
    Parameters:
    
    comments - to be set
  - getComment
```
public List<String> getComment()
```
    Get comment for relative metadata.
    
    Returns:
    
    the time system

Class CdmRelativeMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CdmRelativeMetadata

Method Detail

validate

getTca

setTca

getMissDistance

setMissDistance

getRelativeSpeed

setRelativeSpeed

getRelativeVelocity

getRelativePosition

setRelativePositionR

setRelativePositionT

setRelativePositionN

setRelativeVelocityR

setRelativeVelocityT

setRelativeVelocityN

getStartScreenPeriod

setStartScreenPeriod

getStopScreenPeriod

setStopScreenPeriod

getScreenVolumeFrame

setScreenVolumeFrame

getScreenVolumeShape

setScreenVolumeShape

getScreenVolumeX

setScreenVolumeX

getScreenVolumeY

setScreenVolumeY

getScreenVolumeZ

setScreenVolumeZ

getScreenEntryTime

setScreenEntryTime

getScreenExitTime

setScreenExitTime

getCollisionProbability

setCollisionProbability

getCollisionProbaMethod

setCollisionProbaMethod

checkNotNull

setTimeSystem

getTimeSystem

addComment

getComment