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

Class CdmData

java.lang.Object
org.orekit.files.ccsds.ndm.cdm.CdmData
All Implemented Interfaces:
Data, Section
public class CdmData extends Object implements Data
Container for Conjunction Data Message data.
Since:
11.2
Author:
Melina Vanel

  • Constructor Details

    • CdmData

      public CdmData(CommentsContainer commentsBlock, ODParameters ODParametersBlock, AdditionalParameters additionalParametersBlock, StateVector stateVectorBlock, RTNCovariance covarianceMatrixBlock)
      Constructor with RTN covariance.
      Parameters:
      commentsBlock - general comments block
      ODParametersBlock - OD parameters block (may be null)
      additionalParametersBlock - additionnal parameters block (may be null)
      stateVectorBlock - state vector block
      covarianceMatrixBlock - covariance matrix in RTN coordinates frame block

    • CdmData

      public CdmData(CommentsContainer commentsBlock, ODParameters ODParametersBlock, AdditionalParameters additionalParametersBlock, StateVector stateVectorBlock, RTNCovariance covarianceMatrixBlock, AdditionalCovarianceMetadata additionalCovMetadata)
      Constructor with RTN covariance.
      Parameters:
      commentsBlock - general comments block
      ODParametersBlock - OD parameters block (may be null)
      additionalParametersBlock - additionnal parameters block (may be null)
      stateVectorBlock - state vector block
      covarianceMatrixBlock - covariance matrix in RTN coordinates frame block
      additionalCovMetadata - additional covariance metadata

    • CdmData

      public CdmData(CommentsContainer commentsBlock, ODParameters ODParametersBlock, AdditionalParameters additionalParametersBlock, StateVector stateVectorBlock, RTNCovariance covarianceMatrixBlock, XYZCovariance xyzCovarianceBlock, AdditionalCovarianceMetadata additionalCovMetadata)
      Constructor with RTN and XYZ covariance.
      Parameters:
      commentsBlock - general comments block
      ODParametersBlock - OD parameters block (may be null)
      additionalParametersBlock - additionnal parameters block (may be null)
      stateVectorBlock - state vector block
      covarianceMatrixBlock - covariance matrix in RTN coordinates frame block
      xyzCovarianceBlock - XYZ covariance matrix block
      additionalCovMetadata - additional covariance metadata

    • CdmData

      public CdmData(CommentsContainer commentsBlock, ODParameters ODParametersBlock, AdditionalParameters additionalParametersBlock, StateVector stateVectorBlock, RTNCovariance covarianceMatrixBlock, SigmaEigenvectorsCovariance sig3EigVec3CovarianceBlock, AdditionalCovarianceMetadata additionalCovMetadata)
      Constructor with RTN and sigma/eigenvector covariance.
      Parameters:
      commentsBlock - general comments block
      ODParametersBlock - OD parameters block (may be null)
      additionalParametersBlock - additionnal parameters block (may be null)
      stateVectorBlock - state vector block
      covarianceMatrixBlock - covariance matrix in RTN coordinates frame block
      sig3EigVec3CovarianceBlock - sigma/eigenvector covariance block
      additionalCovMetadata - additional covariance metadata

  • 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
      Parameters:
      version - format version

    • getComments

      public List<String> getComments()
      Get the comments.
      Returns:
      comments

    • getODParametersBlock

      public ODParameters getODParametersBlock()
      Get the OD parameters logical block.
      Returns:
      OD parameters block (may be null)

    • setODParametersBlock

      public void setODParametersBlock(ODParameters ODParametersBlock)
      Set the OD parameters logical block.
      Parameters:
      ODParametersBlock - the OD Parameters logical block

    • getAdditionalParametersBlock

      public AdditionalParameters getAdditionalParametersBlock()
      Get the additional parameters logical block.
      Returns:
      additional parameters block (may be null)

    • setAdditionalParametersBlock

      public void setAdditionalParametersBlock(AdditionalParameters additionalParametersBlock)
      Set the additional parameters logical block.
      Parameters:
      additionalParametersBlock - the additional parameters logical block

    • getStateVectorBlock

      public StateVector getStateVectorBlock()
      Get the state vector logical block.
      Returns:
      state vector block

    • getRTNCovarianceBlock

      public RTNCovariance getRTNCovarianceBlock()
      Get the covariance matrix logical block.

      The RTN Covariance Matrix is provided in the 9×9 Lower Triangular Form. All parameters of the 6×6 position/velocity submatrix are mandatory. The remaining elements will return NaN if not provided.

      Returns:
      covariance matrix block

    • getXYZCovarianceBlock

      public XYZCovariance getXYZCovarianceBlock()
      Get the Covariance Matrix in the XYZ Coordinate Frame (defined by value of CdmMetadataKey.ALT_COV_REF_FRAME).

      This block is not mandatory and on condition that CdmMetadataKey.ALT_COV_TYPE = AltCovarianceType.XYZ.

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

      Returns:
      XYZ covariance matrix block

    • getSig3EigVec3CovarianceBlock

      public SigmaEigenvectorsCovariance getSig3EigVec3CovarianceBlock()
      Get the Sigma / Eigenvector covariance logical block.

      This block is not mandatory and on condition that CdmMetadataKey.ALT_COV_TYPE = AltCovarianceType.CSIG3EIGVEC3.

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

      Returns:
      the Sigma / Eigenvector covariance block

    • getAdditionalCovMetadataBlock

      public AdditionalCovarianceMetadata getAdditionalCovMetadataBlock()
      Get the additional covariance metadata logical block.

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

      Returns:
      the additional covariance metadata logical block

    • setCovarianceMatrixBlock

      public void setCovarianceMatrixBlock(RTNCovariance covarianceMatrixBlock)
      Set the additional covariance metadata logical block.
      Parameters:
      covarianceMatrixBlock - the additional covariance metadata logical block

    • getUserDefinedBlock

      public UserDefined getUserDefinedBlock()
      Get the user defined logical block.

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

      Returns:
      the additional covariance metadata logical block

    • setUserDefinedBlock

      public void setUserDefinedBlock(UserDefined userDefinedBlock)
      Set the user defined logical block.

      This block is added at the end of the CDM parsing as common to both Object 1 and 2.

      Parameters:
      userDefinedBlock - the user defined block to set