Package org.orekit.files.ccsds.definitions

Class ModifiedFrame

java.lang.Object

org.orekit.frames.Frame

org.orekit.files.ccsds.definitions.ModifiedFrame

public class ModifiedFrame
extends Frame

A reference frame created from the REF_FRAME and CENTER_NAME is a CCSDS OPM, OMM, or OEM file.

Author:

Evan Ward

Constructor Summary

Constructors

Constructor	Description
ModifiedFrame(Frame frame, CelestialBodyFrame refFrame, CelestialBody body, String centerName)	Create a CCSDS reference frame that is centered on body and aligned with frame.
ModifiedFrame(Frame frame, CelestialBodyFrame refFrame, CelestialBody body, String centerName, String frameName)	Create a CCSDS reference frame that is centered on body and aligned with frame.

Method Summary

Modifier and Type	Method	Description
String	getCenterName()	Get the CCSDS center name.
CelestialBodyFrame	getRefFrame()	Get the CCSDS reference frame.

Methods inherited from class org.orekit.frames.Frame

getAncestor, getDepth, getFrozenFrame, getKinematicTransformTo, getKinematicTransformTo, getName, getParent, getPeer, getRoot, getStaticTransformTo, getStaticTransformTo, getTransformProvider, getTransformTo, getTransformTo, isChildOf, isPseudoInertial, setPeerCaching, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifiedFrame

public ModifiedFrame(Frame frame,
                     CelestialBodyFrame refFrame,
                     CelestialBody body,
                     String centerName)

Create a CCSDS reference frame that is centered on body and aligned with frame.

Callers should check that the requested frame is not already stored somewhere else. For example, Earth-centered ICRF is Frames.getGCRF(). OrekitCcsdsFrameMapper performs the checking for CCSDS frames that Orekit implements.

Parameters:

frame - the existing frame that specifies the orientation.

refFrame - the reference frame used to create frame.

body - the origin.

centerName - the value of the CENTER_NAME key word used to create body.

See Also:

ModifiedFrame(Frame, CelestialBodyFrame, CelestialBody, String, String)

ModifiedFrame

public ModifiedFrame(Frame frame,
                     CelestialBodyFrame refFrame,
                     CelestialBody body,
                     String centerName,
                     String frameName)

Create a CCSDS reference frame that is centered on body and aligned with frame.

Callers should check that the requested frame is not already stored somewhere else. For example, Earth-centered ICRF is Frames.getGCRF(). OrekitCcsdsFrameMapper performs the checking for CCSDS frames that Orekit implements.

Parameters:

frame - the existing frame that specifies the orientation.

refFrame - the reference frame used to create frame.

body - the origin.

centerName - the value of the CENTER_NAME key word used to create body.

frameName - the name of this frame, returned by Frame.getName().

Since:

14.0

See Also:

ModifiedFrame(Frame, CelestialBodyFrame, CelestialBody, String)

Method Detail

getRefFrame

public CelestialBodyFrame getRefFrame()

Get the CCSDS reference frame.

Returns:

the reference frame used to create this frame.

getCenterName

public String getCenterName()

Get the CCSDS center name.

Returns:

the value of the CENTER_NAME key word used to specify the origin of this frame.