Class Opm
- java.lang.Object
-
- org.orekit.files.ccsds.ndm.NdmConstituent<OdmHeader,Segment<OdmCommonMetadata,OpmData>>
-
- org.orekit.files.ccsds.ndm.odm.opm.Opm
-
- All Implemented Interfaces:
TimeStamped
public class Opm extends NdmConstituent<OdmHeader,Segment<OdmCommonMetadata,OpmData>> implements TimeStamped
This class gathers the informations present in the Orbital Parameter Message (OPM).- Since:
- 6.1
- Author:
- sports
-
-
Field Summary
Fields Modifier and Type Field Description static String
FORMAT_VERSION_KEY
Key for format version.static String
ROOT
Root element for XML files.
-
Constructor Summary
Constructors Constructor Description Opm(OdmHeader header, List<Segment<OdmCommonMetadata,OpmData>> segments, IERSConventions conventions, DataContext dataContext, double mu)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CartesianOrbit
generateCartesianOrbit()
Generate a Cartesian orbit.KeplerianOrbit
generateKeplerianOrbit()
Generate a keplerian orbit.SpacecraftState
generateSpacecraftState()
Generate spacecraft state from theCartesianOrbit
generated by generateCartesianOrbit.OpmData
getData()
Get the file data.AbsoluteDate
getDate()
Get the date.Maneuver
getManeuver(int index)
Get a maneuver.List<Maneuver>
getManeuvers()
Get a list of all maneuvers.OdmCommonMetadata
getMetadata()
Get the file metadata.int
getNbManeuvers()
Get the number of maneuvers present in the OPM.TimeStampedPVCoordinates
getPVCoordinates()
Get the position/velocity coordinates contained in the OPM.boolean
hasManeuvers()
check whether the OPM contains at least one maneuver.-
Methods inherited from class org.orekit.files.ccsds.ndm.NdmConstituent
getConventions, getDataContext, getHeader, getSegments, setHeader, setSegments, validate
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.time.TimeStamped
durationFrom
-
-
-
-
Field Detail
-
ROOT
public static final String ROOT
Root element for XML files.- See Also:
- Constant Field Values
-
FORMAT_VERSION_KEY
public static final String FORMAT_VERSION_KEY
Key for format version.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Opm
public Opm(OdmHeader header, List<Segment<OdmCommonMetadata,OpmData>> segments, IERSConventions conventions, DataContext dataContext, double mu)
Simple constructor.- Parameters:
header
- file headersegments
- file segmentsconventions
- IERS conventionsdataContext
- used for creating frames, time scales, etc.mu
- gravitational coefficient to use for building Cartesian/Keplerian orbits
-
-
Method Detail
-
getMetadata
public OdmCommonMetadata getMetadata()
Get the file metadata.- Returns:
- file metadata
-
getData
public OpmData getData()
Get the file data.- Returns:
- file data
-
getDate
public AbsoluteDate getDate()
Get the date.- Specified by:
getDate
in interfaceTimeStamped
- Returns:
- date attached to the object
-
getNbManeuvers
public int getNbManeuvers()
Get the number of maneuvers present in the OPM.- Returns:
- the number of maneuvers
-
getManeuvers
public List<Maneuver> getManeuvers()
Get a list of all maneuvers.- Returns:
- unmodifiable list of all maneuvers.
-
getManeuver
public Maneuver getManeuver(int index)
Get a maneuver.- Parameters:
index
- maneuver index, counting from 0- Returns:
- maneuver
-
hasManeuvers
public boolean hasManeuvers()
check whether the OPM contains at least one maneuver.- Returns:
- true if OPM contains at least one maneuver false otherwise
-
getPVCoordinates
public TimeStampedPVCoordinates getPVCoordinates()
Get the position/velocity coordinates contained in the OPM.- Returns:
- the position/velocity coordinates contained in the OPM
-
generateCartesianOrbit
public CartesianOrbit generateCartesianOrbit()
Generate a Cartesian orbit.- Returns:
- generated orbit
-
generateKeplerianOrbit
public KeplerianOrbit generateKeplerianOrbit()
Generate a keplerian orbit.- Returns:
- generated orbit
-
generateSpacecraftState
public SpacecraftState generateSpacecraftState()
Generate spacecraft state from theCartesianOrbit
generated by generateCartesianOrbit.- Returns:
- the spacecraft state of the OPM
-
-