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

Class Cdm

java.lang.Object

org.orekit.files.ccsds.ndm.NdmConstituent<CdmHeader,CdmSegment>

org.orekit.files.ccsds.ndm.cdm.Cdm

public class Cdm
extends NdmConstituent<CdmHeader,CdmSegment>

This class stores all the information of the Conjunction Data Message (CDM) File parsed by CdmParser. It contains the header and a list of segments each containing metadata and a list of data lines.

Since:

11.2

Author:

Melina Vanel

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORMAT_VERSION_KEY	Key for format version.
static String	ROOT	Root element for XML files.

Constructor Summary

Constructors

Constructor	Description
Cdm(CdmHeader header, List<CdmSegment> segments, IERSConventions conventions, DataContext dataContext)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
CdmData	getDataObject1()	Get the file data.
CdmData	getDataObject2()	Get the file data.
CdmMetadata	getMetadataObject1()	Get the file metadata.
CdmMetadata	getMetadataObject2()	Get the file metadata.
CdmRelativeMetadata	getRelativeMetadata()	Get the file metadata.
UserDefined	getUserDefinedParameters()	Get user defined parameters.

Methods inherited from class org.orekit.files.ccsds.ndm.NdmConstituent

getConventions, getDataContext, getHeader, getSegments, setHeader, setSegments, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT

public static final String ROOT

Root element for XML files.

See Also:

Constant Field Values

FORMAT_VERSION_KEY

public static final String FORMAT_VERSION_KEY

Key for format version.

See Also:

Constant Field Values

Constructor Detail

Cdm

public Cdm(CdmHeader header,
           List<CdmSegment> segments,
           IERSConventions conventions,
           DataContext dataContext)

Simple constructor.

Parameters:

header - file header

segments - file segments

conventions - IERS conventions

dataContext - used for creating frames, time scales, etc.

Method Detail

getRelativeMetadata

public CdmRelativeMetadata getRelativeMetadata()

Get the file metadata.

Returns:

file metadata

getMetadataObject1

public CdmMetadata getMetadataObject1()

Get the file metadata.

Returns:

file metadata

getMetadataObject2

public CdmMetadata getMetadataObject2()

Get the file metadata.

Returns:

file metadata

getDataObject1

public CdmData getDataObject1()

Get the file data.

Returns:

file data

getDataObject2

public CdmData getDataObject2()

Get the file data.

Returns:

file data

getUserDefinedParameters

public UserDefined getUserDefinedParameters()

Get user defined parameters.

This method will return null if the user defined block is not present in the CDM

Returns:

file data