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

Class CdmMetadata

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.section.Metadata
org.orekit.files.ccsds.ndm.cdm.CdmMetadata
All Implemented Interfaces:
Section
public class CdmMetadata extends Metadata
This class gathers the meta-data present in the Conjunction Data Message (CDM).
Since:
11.2
Author:
Melina Vanel

  • Constructor Details

    • CdmMetadata

      public CdmMetadata(DataContext dataContext, CcsdsFrameMapper frameMapper)
      Simple constructor.
      Parameters:
      dataContext - data context
      frameMapper - for creating an Orekit Frame.
      Since:
      13.1.5

  • Method Details

    • validate

      public void validate(double version)
      Check is all mandatory entries have been initialized.

      This method should throw an exception if some mandatory entries are missing or not compatible with version number.

      Specified by:
      validate in interface Section
      Overrides:
      validate in class Metadata
      Parameters:
      version - format version

    • getRelativeMetadata

      public CdmRelativeMetadata getRelativeMetadata()
      Get the relative metadata following header, they are the common metadata for the CDM.
      Returns:
      relativeMetadata relative metadata

    • setRelativeMetadata

      public void setRelativeMetadata(CdmRelativeMetadata relativeMetadata)
      Set the relative metadata following header, they are the common metadata for the CDM.
      Parameters:
      relativeMetadata - relative metadata

    • getObject

      public String getObject()
      Get the object name for which metadata are given.
      Returns:
      the object name

    • setObject

      public void setObject(String object)
      Set the object name for which metadata are given.
      Parameters:
      object - = object 1 or 2 to be set

    • getObjectDesignator

      public String getObjectDesignator()
      Get the object satellite catalog designator for which metadata are given.
      Returns:
      the satellite catalog designator for the object

    • setObjectDesignator

      public void setObjectDesignator(String objectDesignator)
      Set the satellite designator for the object for which metadata are given.
      Parameters:
      objectDesignator - for the spacecraft to be set

    • getCatalogName

      public String getCatalogName()
      Get the satellite catalog used for the object.
      Returns:
      the catalog name

    • setCatalogName

      public void setCatalogName(String catalogName)
      Set the satellite catalog name used for object.
      Parameters:
      catalogName - for the spacecraft to be set

    • getObjectName

      public String getObjectName()
      Get the spacecraft name for the object.
      Returns:
      the spacecraft name

    • setObjectName

      public void setObjectName(String objectName)
      Set the spacecraft name used for object.
      Parameters:
      objectName - for the spacecraft to be set

    • getInternationalDes

      public String getInternationalDes()
      Get the international designator for the object.
      Returns:
      the international designator

    • setInternationalDes

      public void setInternationalDes(String internationalDes)
      Set the international designator used for object.
      Parameters:
      internationalDes - for the object to be set

    • getObjectType

      public ObjectType getObjectType()
      Get the type of object.
      Returns:
      the object type

    • setObjectType

      public void setObjectType(ObjectType objectType)
      Set the type of object.
      Parameters:
      objectType - type of object

    • getOperatorContactPosition

      public String getOperatorContactPosition()
      Get the contact position of the owner / operator of the object.
      Returns:
      the contact position

    • setOperatorContactPosition

      public void setOperatorContactPosition(String opContact)
      Set the contact position for the object owner / operator.
      Parameters:
      opContact - for the object to be set

    • getOperatorOrganization

      public String getOperatorOrganization()
      Get the contact organisation of the object.
      Returns:
      the contact organisation

    • setOperatorOrganization

      public void setOperatorOrganization(String operatorOrganization)
      Set the contact organisation of the object.
      Parameters:
      operatorOrganization - contact organisation for the object to be set

    • getOperatorPhone

      public String getOperatorPhone()
      Get the contact phone of the operator of the object.
      Returns:
      the operator phone

    • setOperatorPhone

      public void setOperatorPhone(String operatorPhone)
      Set the operator phone of the object.
      Parameters:
      operatorPhone - contact phone for the object to be set

    • getOperatorEmail

      public String getOperatorEmail()
      Get the email of the operator of the object.
      Returns:
      the operator email

    • setOperatorEmail

      public void setOperatorEmail(String operatorEmail)
      Set the object operator email.
      Parameters:
      operatorEmail - operator email for the object to be set

    • getEphemName

      public String getEphemName()
      Get the unique name of the external ephemeris used for OD.
      Returns:
      the name of ephemeris used

    • setEphemName

      public void setEphemName(String ephemName)
      Set the name of external ephemeris used for OD.
      Parameters:
      ephemName - me of external ephemeris used

    • getCovarianceMethod

      public CovarianceMethod getCovarianceMethod()
      Get the method name used to calculate covariance during OD.
      Returns:
      the name of covariance calculation method

    • setCovarianceMethod

      public void setCovarianceMethod(CovarianceMethod covarianceMethod)
      Set the method name used to calculate covariance during OD.
      Parameters:
      covarianceMethod - method name for covariance calculation

    • getManeuverable

      public Maneuvrable getManeuverable()
      Get the ability of object to maneuver or not.
      Returns:
      the ability to maneuver

    • setManeuverable

      public void setManeuverable(Maneuvrable maneuverable)
      Set the object maneuver ability.
      Parameters:
      maneuverable - ability to maneuver

    • getOrbitCenter

      public BodyFacade getOrbitCenter()
      Get the central body for object 1 and 2.
      Returns:
      the name of the central body

    • setOrbitCenter

      public void setOrbitCenter(BodyFacade orbitCenter)
      Set the central body name for object 1 and 2.
      Parameters:
      orbitCenter - name of the central body

    • getFrame

      public Frame getFrame()
      Get the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).
      Returns:
      the reference frame

    • getRefFrame

      public FrameFacade getRefFrame()
      Get the value of REF_FRAME as an Orekit Frame. The ORBIT_CENTER key word has not been applied yet, so the returned frame may not correspond to the reference frame of the data in the file.
      Returns:
      the reference frame

    • setRefFrame

      public void setRefFrame(FrameFacade refFrame)
      Set the name of the reference frame in which the state vector data are given.
      Parameters:
      refFrame - reference frame

    • getGravityModel

      public String getGravityModel()
      Get gravity model name.
      Returns:
      gravity model name

    • getGravityDegree

      public int getGravityDegree()
      Get degree of the gravity model.
      Returns:
      degree of the gravity model

    • getGravityOrder

      public int getGravityOrder()
      Get order of the gravity model.
      Returns:
      order of the gravity model

    • setGravityModel

      public void setGravityModel(String name, int degree, int order)
      Set gravity model.
      Parameters:
      name - name of the model
      degree - degree of the model
      order - order of the model

    • getAtmosphericModel

      public String getAtmosphericModel()
      Get name of atmospheric model.
      Returns:
      name of atmospheric model

    • setAtmosphericModel

      public void setAtmosphericModel(String atmosphericModel)
      Set name of atmospheric model.
      Parameters:
      atmosphericModel - name of atmospheric model

    • getNBodyPerturbations

      public List<BodyFacade> getNBodyPerturbations()
      Get n-body perturbation bodies.
      Returns:
      n-body perturbation bodies

    • setNBodyPerturbations

      public void setNBodyPerturbations(List<BodyFacade> nBody)
      Set n-body perturbation bodies.
      Parameters:
      nBody - n-body perturbation bodies

    • getSolarRadiationPressure

      public YesNoUnknown getSolarRadiationPressure()
      Get Enum YesNoUnknown that indicates if Solar Radiation Pressure is taken into account or not.
      Returns:
      isSolarRadPressure YesNoUnknown

    • setSolarRadiationPressure

      public void setSolarRadiationPressure(YesNoUnknown isSolRadPressure)
      Set Enum that indicates if Solar Radiation Pressure is taken into account or not.
      Parameters:
      isSolRadPressure - YesNoUnknown

    • getEarthTides

      public YesNoUnknown getEarthTides()
      Get Enum YesNoUnknown that indicates if Earth and ocean tides are taken into account or not.
      Returns:
      isEarthTides YesNoUnknown

    • setEarthTides

      public void setEarthTides(YesNoUnknown EarthTides)
      Set Enum YesNoUnknown that indicates if Earth and ocean tides are taken into account or not.
      Parameters:
      EarthTides - YesNoUnknown

    • getIntrackThrust

      public YesNoUnknown getIntrackThrust()
      Get Enum YesNoUnknown that indicates if intrack thrust modeling was into account or not.
      Returns:
      isEarthTides YesNoUnknown

    • setIntrackThrust

      public void setIntrackThrust(YesNoUnknown IntrackThrustModeled)
      Set boolean that indicates if intrack thrust modeling was into account or not.
      Parameters:
      IntrackThrustModeled - YesNoUnknown

    • getCovarianceSource

      public String getCovarianceSource()
      Get the source of the covariance data.
      Returns:
      the covarianceSource

    • setCovarianceSource

      public void setCovarianceSource(String covarianceSource)
      Set the source of the covariance data.
      Parameters:
      covarianceSource - the covarianceSource to set

    • getAltCovType

      public AltCovarianceType getAltCovType()
      Get the flag indicating the type of alternate covariance information provided.
      Returns:
      the altCovType

    • setAltCovType

      public void setAltCovType(AltCovarianceType altCovType)
      Set the flag indicating the type of alternate covariance information provided.
      Parameters:
      altCovType - the altCovType to set

    • getAltCovRefFrame

      public FrameFacade getAltCovRefFrame()
      Get the value of ALT_COV_REF_FRAME as an Orekit Frame.
      Returns:
      the reference frame

    • setAltCovRefFrame

      public void setAltCovRefFrame(FrameFacade altCovRefFrame)
      Set the name of the reference frame in which the alternate covariance data are given.
      Parameters:
      altCovRefFrame - alternate covariance reference frame

    • getAltCovFrame

      public Frame getAltCovFrame()
      Get the reference frame in which the alternative covariance data is given.
      Returns:
      alternative covariance reference frame.
      Since:
      13.1.5
      See Also:

    • getOdmMsgLink

      public String getOdmMsgLink()
      Get the unique identifier of Orbit Data Message(s) that are linked (relevant) to this Conjunction Data Message.
      Returns:
      the odmMsgLink

    • setOdmMsgLink

      public void setOdmMsgLink(String odmMsgLink)
      Set the unique identifier of Orbit Data Message(s) that are linked (relevant) to this Conjunction Data Message.
      Parameters:
      odmMsgLink - the odmMsgLink to set

    • getAdmMsgLink

      public String getAdmMsgLink()
      Get the unique identifier of Attitude Data Message(s) that are linked (relevant) to this Conjunction Data Message.
      Returns:
      the admMsgLink

    • setAdmMsgLink

      public void setAdmMsgLink(String admMsgLink)
      Set the unique identifier of Attitude Data Message(s) that are linked (relevant) to this Conjunction Data Message.
      Parameters:
      admMsgLink - the admMsgLink to set

    • getObsBeforeNextMessage

      public YesNoUnknown getObsBeforeNextMessage()
      Get the flag indicating whether new tracking observations are anticipated prior to the issue of the next CDM associated with the event specified by CONJUNCTION_ID.
      Returns:
      the obsBeforeNextMessage

    • setObsBeforeNextMessage

      public void setObsBeforeNextMessage(YesNoUnknown obsBeforeNextMessage)
      Set the flag indicating whether new tracking observations are anticipated prior to the issue of the next CDM associated with the event specified by CONJUNCTION_ID.
      Parameters:
      obsBeforeNextMessage - the obsBeforeNextMessage to set