fr.cnes.sirius.patrius.frames

Class CelestialBodyFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.CelestialBodyFrame

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

Direct Known Subclasses:

FactoryManagedFrame

public class CelestialBodyFrame
extends Frame

Frame centered on a CelestialBody. This frames contains a CelestialBody. For FactoryManagedFrame such as GCRF frame, Earth celestial body is not attached, so users need to attach it using setCelestialBody(CelestialBody). Warning: this class does not check if provided celestial body is indeed centered on this frame.

Since:

4.10

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	CelestialBodyFrame(Frame parent, TransformProvider transformProvider, String name, boolean pseudoInertial, CelestialBody celestialBody) Generic constructor.
	CelestialBodyFrame(Frame parent, TransformProvider transformProvider, String name, CelestialBody celestialBody) Constructor.
	CelestialBodyFrame(Frame parent, Transform transform, String name, boolean pseudoInertial, CelestialBody celestialBody) Constructor.
	CelestialBodyFrame(Frame parent, Transform transform, String name, CelestialBody celestialBody) Constructor.
protected	CelestialBodyFrame(String name, boolean pseudoInertial) Protected constructor used only for the root frame.

Method Summary

Modifier and Type	Method and Description
CelestialBody	getCelestialBody() Returns the celestial body centered on this frame.
void	setCelestialBody(CelestialBody celestialBody) Set the celestial body.

Methods inherited from class fr.cnes.sirius.patrius.frames.Frame

getAncestor, getDepth, getFirstCommonPseudoInertialAncestor, getFirstPseudoInertialAncestor, getFrozenFrame, getName, getNativeFrame, getParent, getPVCoordinates, getRoot, getTransformJacobian, getTransformProvider, getTransformTo, getTransformTo, getTransformTo, getTransformTo, isChildOf, isPseudoInertial, setName, setReferential, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CelestialBodyFrame

protected CelestialBodyFrame(String name,
                             boolean pseudoInertial)

Protected constructor used only for the root frame.

Parameters:

name - name of the frame

pseudoInertial - true if frame is considered pseudo-inertial (i.e. suitable for propagating orbit)

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          Transform transform,
                          String name,
                          CelestialBody celestialBody)

Constructor. Warning: this class does not check if provided celestial body is indeed centered on this frame.

Parameters:

parent - parent frame (must be non-null)

transform - transform from parent frame to instance

name - name of the frame

celestialBody - celestial body centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          TransformProvider transformProvider,
                          String name,
                          CelestialBody celestialBody)

Constructor. Warning: this class does not check if provided celestial body is indeed centered on this frame.

Parameters:

parent - parent frame (must be non-null)

transformProvider - provider for transform from parent frame to instance

name - name of the frame

celestialBody - celestial body centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          Transform transform,
                          String name,
                          boolean pseudoInertial,
                          CelestialBody celestialBody)

Constructor. Warning: this class does not check if provided celestial body is indeed centered on this frame.

Parameters:

parent - parent frame (must be non-null)

transform - transform from parent frame to instance

name - name of the frame

pseudoInertial - true if frame is considered pseudo-inertial (i.e. suitable for propagating orbit)

celestialBody - celestial body centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          TransformProvider transformProvider,
                          String name,
                          boolean pseudoInertial,
                          CelestialBody celestialBody)

Generic constructor. Warning: this class does not check if provided celestial body is indeed centered on this frame.

Parameters:

parent - parent frame (must be non-null)

transformProvider - provider for transform from parent frame to instance

name - name of the frame

pseudoInertial - true if frame is considered pseudo-inertial (i.e. suitable for propagating orbit)

celestialBody - celestial body centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

Method Detail

getCelestialBody

public CelestialBody getCelestialBody()

Returns the celestial body centered on this frame.

Returns:

the celestial body centered on this frame

setCelestialBody

public void setCelestialBody(CelestialBody celestialBody)

Set the celestial body.

Parameters:

celestialBody - the celestial body to set