Package org.orekit.files.ccsds
Class ODMMetaData
- java.lang.Object
-
- org.orekit.files.ccsds.ODMMetaData
-
- Direct Known Subclasses:
OMMFile.OMMMetaData
public class ODMMetaData extends Object
This class gathers the meta-data present in the Orbital Data Message (ODM).- Since:
- 6.1
- Author:
- sports
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CelestialBodygetCenterBody()Get theCelestialBodycorresponding to the center name.StringgetCenterName()Get the origin of reference frame.List<String>getComment()Get the meta-data comment.FramegetFrame()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).AbsoluteDategetFrameEpoch()Get epoch of reference frame, if not intrinsic to the definition of the reference frame.StringgetFrameEpochString()Get epoch of reference frame, if not intrinsic to the definition of the reference frame.StringgetFrameString()Get the reference frame specifier as it appeared in the file.booleangetHasCreatableBody()Get boolean testing whether the body corresponding to the centerName attribute can be created through theCelestialBodyFactory.intgetLaunchNumber()Get the launch number.StringgetLaunchPiece()Get the piece of launch.intgetLaunchYear()Get the launch year.StringgetObjectID()Get the spacecraft ID for which the orbit state is provided.StringgetObjectName()Get the spacecraft name for which the orbit state is provided.ODMFilegetODMFile()Get the ODM file to which these meta-data belong.FramegetRefFrame()Get the the value ofREF_FRAMEas an OrekitFrame.CcsdsTimeScalegetTimeSystem()Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
-
-
-
Method Detail
-
getODMFile
public ODMFile getODMFile()
Get the ODM file to which these meta-data belong.- Returns:
- ODM file to which these meta-data belong
-
getTimeSystem
public CcsdsTimeScale getTimeSystem()
Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.- Returns:
- the time system
-
getObjectName
public String getObjectName()
Get the spacecraft name for which the orbit state is provided.- Returns:
- the spacecraft name
-
getObjectID
public String getObjectID()
Get the spacecraft ID for which the orbit state is provided.- Returns:
- the spacecraft ID
-
getLaunchYear
public int getLaunchYear()
Get the launch year.- Returns:
- launch year
-
getLaunchNumber
public int getLaunchNumber()
Get the launch number.- Returns:
- launch number
-
getLaunchPiece
public String getLaunchPiece()
Get the piece of launch.- Returns:
- piece of launch
-
getCenterName
public String getCenterName()
Get the origin of reference frame.- Returns:
- the origin of reference frame.
-
getCenterBody
public CelestialBody getCenterBody()
Get theCelestialBodycorresponding to the center name.- Returns:
- the center body
-
getHasCreatableBody
public boolean getHasCreatableBody()
Get boolean testing whether the body corresponding to the centerName attribute can be created through theCelestialBodyFactory.- Returns:
- true if
CelestialBodycan be created from centerName false otherwise
-
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 Frame getRefFrame()
Get the the value ofREF_FRAMEas an OrekitFrame. TheCENTER_NAMEkey 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 specified by the
REF_FRAMEkeyword. - See Also:
getFrame()
-
getFrameString
public String getFrameString()
Get the reference frame specifier as it appeared in the file.- Returns:
- the frame name as it appeared in the file.
- See Also:
getFrame()
-
getFrameEpochString
public String getFrameEpochString()
Get epoch of reference frame, if not intrinsic to the definition of the reference frame.- Returns:
- epoch of reference frame
-
getFrameEpoch
public AbsoluteDate getFrameEpoch()
Get epoch of reference frame, if not intrinsic to the definition of the reference frame.- Returns:
- epoch of reference frame
-
-