OGMFile (ORbit Extrapolation KIT 9.2 API)

java.lang.Object
- org.orekit.files.ccsds.ODMFile
- - org.orekit.files.ccsds.OGMFile

Direct Known Subclasses:

OMMFile, OPMFile
```
public abstract class OGMFile
extends ODMFile
```
This class gathers the general state data present in both OPM and OMM files.
This class does not appear in the CCSDS standard, it is only a design feature of Orekit to reduce code duplication.

Since:

6.1

Author:

sports

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getA()`	Get the orbit semi-major axis.
`double`	`getAnomaly()`	Get the orbit anomaly.
`PositionAngle`	`getAnomalyType()`	Get the type of anomaly (true or mean).
`List<String>`	`getCovarianceComment()`	Get the comment for covariance.
`RealMatrix`	`getCovarianceMatrix()`	Get the Position/Velocity covariance matrix.
`Frame`	`getCovRefFrame()`	Get coordinate system for covariance matrix, for absolute frames.
`LOFType`	`getCovRefLofType()`	Get coordinate system for covariance matrix, for Local Orbital Frames.
`double`	`getDragArea()`	Get the drag area.
`double`	`getDragCoeff()`	Get the drag coefficient.
`double`	`getE()`	Get the orbit eccentricity.
`AbsoluteDate`	`getEpoch()`	Get epoch of state vector, Keplerian elements and covariance matrix data.
`List<String>`	`getEpochComment()`	Get the comment for epoch.
`double`	`getI()`	Get the orbit inclination.
`List<String>`	`getKeplerianElementsComment()`	Get the comment for Keplerian elements.
`double`	`getMass()`	Get the spacecraft mass.
`abstract ODMMetaData`	`getMetaData()`	Get the meta data.
`double`	`getPa()`	Get the orbit argument of pericenter.
`double`	`getRaan()`	Get the orbit right ascension of ascending node.
`double`	`getSolarRadArea()`	Get the solar radiation pressure area.
`double`	`getSolarRadCoeff()`	Get the solar radiation pressure coefficient.
`List<String>`	`getSpacecraftComment()`	Get the comment for spacecraft.
`Map<String,String>`	`getUserDefinedParameters()`	Get the map of user defined parameter keywords and their corresponding values.
`boolean`	`hasCovarianceMatrix()`	Check whether the OPM contains covariance matrix data.
`boolean`	`hasKeplerianElements()`	Check whether the OPM contains Keplerian elements data.

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

Methods inherited from class org.orekit.files.ccsds.ODMFile
getConventions, getCreationDate, getFormatVersion, getHeaderComment, getMissionReferenceDate, getMuCreated, getMuParsed, getMuSet, getMuUsed, getOriginator, setMuUsed

- Method Detail
  - getEpoch
```
public AbsoluteDate getEpoch()
```
    Get epoch of state vector, Keplerian elements and covariance matrix data.
    
    Returns:
    
    epoch the epoch
  - getA
```
public double getA()
```
    Get the orbit semi-major axis.
    
    Returns:
    
    the orbit semi-major axis
  - getE
```
public double getE()
```
    Get the orbit eccentricity.
    
    Returns:
    
    the orbit eccentricity
  - getI
```
public double getI()
```
    Get the orbit inclination.
    
    Returns:
    
    the orbit inclination
  - getRaan
```
public double getRaan()
```
    Get the orbit right ascension of ascending node.
    
    Returns:
    
    the orbit right ascension of ascending node
  - getPa
```
public double getPa()
```
    Get the orbit argument of pericenter.
    
    Returns:
    
    the orbit argument of pericenter
  - getAnomaly
```
public double getAnomaly()
```
    Get the orbit anomaly.
    
    Returns:
    
    the orbit anomaly
  - getAnomalyType
```
public PositionAngle getAnomalyType()
```
    Get the type of anomaly (true or mean).
    
    Returns:
    
    the type of anomaly
  - getMass
```
public double getMass()
               throws OrekitException
```
    Get the spacecraft mass.
    
    Returns:
    
    the spacecraft mass
    
    Throws:
    
    OrekitException - if mass is unknown
  - getSolarRadArea
```
public double getSolarRadArea()
```
    Get the solar radiation pressure area.
    
    Returns:
    
    the solar radiation pressure area
  - getSolarRadCoeff
```
public double getSolarRadCoeff()
```
    Get the solar radiation pressure coefficient.
    
    Returns:
    
    the solar radiation pressure coefficient
  - getDragArea
```
public double getDragArea()
```
    Get the drag area.
    
    Returns:
    
    the drag area
  - getDragCoeff
```
public double getDragCoeff()
```
    Get the drag coefficient.
    
    Returns:
    
    the drag coefficient
  - getCovRefLofType
```
public LOFType getCovRefLofType()
```
    Get coordinate system for covariance matrix, for Local Orbital Frames.
    The value returned is null if the covariance matrix is given in an absolute frame rather than a Local Orbital Frame. In this case, the method getCovRefFrame() must be used instead.
    
    Returns:
    
    the coordinate system for covariance matrix, or null if the covariance matrix is given in an absolute frame rather than a Local Orbital Frame
  - getCovRefFrame
```
public Frame getCovRefFrame()
```
    Get coordinate system for covariance matrix, for absolute frames.
    The value returned is null if the covariance matrix is given in a Local Orbital Frame rather than an absolute frame. In this case, the method getCovRefLofType() must be used instead.
    
    Returns:
    
    the coordinate system for covariance matrix
  - getCovarianceMatrix
```
public RealMatrix getCovarianceMatrix()
```
    Get the Position/Velocity covariance matrix.
    
    Returns:
    
    the Position/Velocity covariance matrix
  - getUserDefinedParameters
```
public Map<String,String> getUserDefinedParameters()
```
    Get the map of user defined parameter keywords and their corresponding values.
    
    Returns:
    
    the map of user defined parameter keywords and their corresponding values.
  - hasKeplerianElements
```
public boolean hasKeplerianElements()
```
    Check whether the OPM contains Keplerian elements data.
    
    Returns:
    
    true if OPM contains Keplerian elements data.
  - hasCovarianceMatrix
```
public boolean hasCovarianceMatrix()
```
    Check whether the OPM contains covariance matrix data.
    
    Returns:
    
    true if OPM contains covariance matrix data.
  - getEpochComment
```
public List<String> getEpochComment()
```
    Get the comment for epoch.
    
    Returns:
    
    comment for epoch
  - getKeplerianElementsComment
```
public List<String> getKeplerianElementsComment()
```
    Get the comment for Keplerian elements.
    
    Returns:
    
    comment for Keplerian elements
  - getSpacecraftComment
```
public List<String> getSpacecraftComment()
```
    Get the comment for spacecraft.
    
    Returns:
    
    comment for spacecraft
  - getCovarianceComment
```
public List<String> getCovarianceComment()
```
    Get the comment for covariance.
    
    Returns:
    
    comment for covariance
  - getMetaData
```
public abstract ODMMetaData getMetaData()
```
    Get the meta data.
    
    Returns:
    
    meta data

Class OGMFile

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.orekit.files.ccsds.ODMFile

Method Detail

getEpoch

getA

getE

getI

getRaan

getPa

getAnomaly

getAnomalyType

getMass

getSolarRadArea

getSolarRadCoeff

getDragArea

getDragCoeff

getCovRefLofType

getCovRefFrame

getCovarianceMatrix

getUserDefinedParameters

hasKeplerianElements

hasCovarianceMatrix

getEpochComment

getKeplerianElementsComment

getSpacecraftComment

getCovarianceComment

getMetaData