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

public class CelestialBodyFrame
extends Frame

Frame centered on a CelestialPoint.
This frames contains a CelestialPoint. For FactoryManagedFrame such as GCRF frame, Earth celestial body is not attached, so users need to attach it using #setCelestialPoint(CelestialPoint).

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

Field Summary

Fields

Modifier and Type	Field and Description
protected CelestialPoint	celestialPoint Celestial point centered on this frame.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CelestialPoint	getCelestialPoint() Getter for the celestial point centered on this frame.

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

Field Detail

celestialPoint

protected CelestialPoint celestialPoint

Celestial point centered on this frame.

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,
                          CelestialPoint celestialPoint)

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

celestialPoint - celestial point centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          TransformProvider transformProvider,
                          String name,
                          CelestialPoint celestialPoint)

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

celestialPoint - celestial point centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          Transform transform,
                          String name,
                          boolean pseudoInertial,
                          CelestialPoint celestialPoint)

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)

celestialPoint - celestial point centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

CelestialBodyFrame

public CelestialBodyFrame(Frame parent,
                          TransformProvider transformProvider,
                          String name,
                          boolean pseudoInertial,
                          CelestialPoint celestialPoint)

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)

celestialPoint - celestial point centered on this frame

Throws:

IllegalArgumentException - if the parent frame is null

Method Detail

getCelestialPoint

public CelestialPoint getCelestialPoint()
                                 throws PatriusException

Getter for the celestial point centered on this frame.

Returns:

the celestial point centered on this frame

Throws:

PatriusException - if point could not be built