java.lang.Object
- org.orekit.files.ccsds.section.CommentsContainer
- - org.orekit.files.ccsds.ndm.odm.ocm.OrbitCovarianceHistoryMetadata

All Implemented Interfaces:

Section
```
public class OrbitCovarianceHistoryMetadata
extends CommentsContainer
```
Metadata for covariance history.
Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors
Constructor Description

OrbitCovarianceHistoryMetadata(AbsoluteDate epochT0)
Simple constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCovBasis()`	Get basis of this covariance time history data.
`String`	`getCovBasisID()`	Get identification number of the orbit determination or simulation upon which this covariance is based.
`double`	`getCovConfidence()`	Get the measure of confidence in covariance error matching reality.
`AbsoluteDate`	`getCovFrameEpoch()`	Get epoch of the `covariance reference frame`.
`String`	`getCovID()`	Get covariance identification number.
`String`	`getCovNextID()`	Get identification number of next covariance.
`Ordering`	`getCovOrdering()`	Get covariance ordering.
`String`	`getCovPrevID()`	Get identification number of previous covariance.
`FrameFacade`	`getCovReferenceFrame()`	Get reference frame of the covariance.
`double`	`getCovScaleMax()`	Get the maximum scale factor to apply to achieve realism.
`double`	`getCovScaleMin()`	Get the minimum scale factor to apply to achieve realism.
`OrbitElementsType`	`getCovType()`	Get covariance element set type.
`List<Unit>`	`getCovUnits()`	Get covariance element set units.
`void`	`setCovBasis(String covBasis)`	Set basis of this covariance time history data.
`void`	`setCovBasisID(String covBasisID)`	Set identification number of the orbit determination or simulation upon which this covariance is based.
`void`	`setCovConfidence(double covConfidence)`	Set the measure of confidence in covariance error matching reality.
`void`	`setCovFrameEpoch(AbsoluteDate covFrameEpoch)`	Set epoch of the `covariance reference frame`.
`void`	`setCovID(String covID)`	Set covariance identification number.
`void`	`setCovNextID(String covNextID)`	Set identification number of next covariance.
`void`	`setCovOrdering(Ordering covOrdering)`	Set covariance ordering.
`void`	`setCovPrevID(String covPrevID)`	Set identification number of previous covariance.
`void`	`setCovReferenceFrame(FrameFacade covReferenceFrame)`	Set reference frame of the covariance.
`void`	`setCovScaleMax(double covScaleMax)`	Set the maximum scale factor to apply to achieve realism.
`void`	`setCovScaleMin(double covScaleMin)`	Set the minimum scale factor to apply to achieve realism.
`void`	`setCovType(OrbitElementsType covType)`	Set covariance element set type.
`void`	`setCovUnits(List<Unit> covUnits)`	Set covariance element set units.
`void`	`validate(double version)`	Check is all mandatory entries have been initialized.

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer
acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments, setComments

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

- Constructor Detail
  - OrbitCovarianceHistoryMetadata
```
public OrbitCovarianceHistoryMetadata(AbsoluteDate epochT0)
```
    Simple constructor.
    
    Parameters:
    
    epochT0 - T0 epoch from file metadata
- Method Detail
  - 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 CommentsContainer
    
    Parameters:
    
    version - format version
  - getCovID
```
public String getCovID()
```
    Get covariance identification number.
    
    Returns:
    
    covariance identification number
  - setCovID
```
public void setCovID(String covID)
```
    Set covariance identification number.
    
    Parameters:
    
    covID - covariance identification number
  - getCovPrevID
```
public String getCovPrevID()
```
    Get identification number of previous covariance.
    
    Returns:
    
    identification number of previous covariance
  - setCovPrevID
```
public void setCovPrevID(String covPrevID)
```
    Set identification number of previous covariance.
    
    Parameters:
    
    covPrevID - identification number of previous covariance
  - getCovNextID
```
public String getCovNextID()
```
    Get identification number of next covariance.
    
    Returns:
    
    identification number of next covariance
  - setCovNextID
```
public void setCovNextID(String covNextID)
```
    Set identification number of next covariance.
    
    Parameters:
    
    covNextID - identification number of next covariance
  - getCovBasis
```
public String getCovBasis()
```
    Get basis of this covariance time history data.
    
    Returns:
    
    basis of this covariance time history data
  - setCovBasis
```
public void setCovBasis(String covBasis)
```
    Set basis of this covariance time history data.
    
    Parameters:
    
    covBasis - basis of this covariance time history data
  - getCovBasisID
```
public String getCovBasisID()
```
    Get identification number of the orbit determination or simulation upon which this covariance is based.
    
    Returns:
    
    identification number of the orbit determination or simulation upon which this covariance is based
  - setCovBasisID
```
public void setCovBasisID(String covBasisID)
```
    Set identification number of the orbit determination or simulation upon which this covariance is based.
    
    Parameters:
    
    covBasisID - identification number of the orbit determination or simulation upon which this covariance is based
  - getCovReferenceFrame
```
public FrameFacade getCovReferenceFrame()
```
    Get reference frame of the covariance.
    
    Returns:
    
    reference frame of the covariance
  - setCovReferenceFrame
```
public void setCovReferenceFrame(FrameFacade covReferenceFrame)
```
    Set reference frame of the covariance.
    
    Parameters:
    
    covReferenceFrame - the reference frame to be set
  - getCovFrameEpoch
```
public AbsoluteDate getCovFrameEpoch()
```
    Get epoch of the covariance reference frame.
    
    Returns:
    
    epoch of the covariance reference frame
  - setCovFrameEpoch
```
public void setCovFrameEpoch(AbsoluteDate covFrameEpoch)
```
    Set epoch of the covariance reference frame.
    
    Parameters:
    
    covFrameEpoch - epoch of the covariance reference frame
  - setCovScaleMin
```
public void setCovScaleMin(double covScaleMin)
```
    Set the minimum scale factor to apply to achieve realism.
    
    Parameters:
    
    covScaleMin - minimum scale factor to apply to achieve realism
  - getCovScaleMin
```
public double getCovScaleMin()
```
    Get the minimum scale factor to apply to achieve realism.
    
    Returns:
    
    minimum scale factor to apply to achieve realism
  - setCovScaleMax
```
public void setCovScaleMax(double covScaleMax)
```
    Set the maximum scale factor to apply to achieve realism.
    
    Parameters:
    
    covScaleMax - maximum scale factor to apply to achieve realism
  - getCovScaleMax
```
public double getCovScaleMax()
```
    Get the maximum scale factor to apply to achieve realism.
    
    Returns:
    
    maximum scale factor to apply to achieve realism
  - setCovConfidence
```
public void setCovConfidence(double covConfidence)
```
    Set the measure of confidence in covariance error matching reality.
    
    Parameters:
    
    covConfidence - measure of confidence in covariance error matching reality
  - getCovConfidence
```
public double getCovConfidence()
```
    Get the measure of confidence in covariance error matching reality.
    
    Returns:
    
    measure of confidence in covariance error matching reality
  - getCovType
```
public OrbitElementsType getCovType()
```
    Get covariance element set type.
    
    Returns:
    
    covariance element set type
  - setCovType
```
public void setCovType(OrbitElementsType covType)
```
    Set covariance element set type.
    
    Parameters:
    
    covType - covariance element set type
  - getCovOrdering
```
public Ordering getCovOrdering()
```
    Get covariance ordering.
    
    Returns:
    
    covariance ordering
  - setCovOrdering
```
public void setCovOrdering(Ordering covOrdering)
```
    Set covariance ordering.
    
    Parameters:
    
    covOrdering - covariance ordering
  - getCovUnits
```
public List<Unit> getCovUnits()
```
    Get covariance element set units.
    
    Returns:
    
    covariance element set units
  - setCovUnits
```
public void setCovUnits(List<Unit> covUnits)
```
    Set covariance element set units.
    
    Parameters:
    
    covUnits - covariance element set units

Class OrbitCovarianceHistoryMetadata

Constructor Summary

Method Summary

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer

Methods inherited from class java.lang.Object

Constructor Detail

OrbitCovarianceHistoryMetadata

Method Detail

validate

getCovID

setCovID

getCovPrevID

setCovPrevID

getCovNextID

setCovNextID

getCovBasis

setCovBasis

getCovBasisID

setCovBasisID

getCovReferenceFrame

setCovReferenceFrame

getCovFrameEpoch

setCovFrameEpoch

setCovScaleMin

getCovScaleMin

setCovScaleMax

getCovScaleMax

setCovConfidence

getCovConfidence

getCovType

setCovType

getCovOrdering

setCovOrdering

getCovUnits

setCovUnits