fr.cnes.sirius.patrius.frames

Class PredefinedFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.CelestialBodyFrame

fr.cnes.sirius.patrius.frames.PredefinedFrame

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

public class PredefinedFrame
extends CelestialBodyFrame

Base class for the predefined frames that are managed by FramesFactory.

Author:

Luc Maisonobe

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.frames.CelestialBodyFrame

celestialPoint

Constructor Summary

Constructors

Constructor and Description
PredefinedFrame(Frame parent, TransformProvider transformProvider, boolean pseudoInertial, PredefinedFrameType factoryKeyIn) Simple constructor.

Method Summary

Modifier and Type	Method and Description
CelestialPoint	getCelestialPoint() Returns the celestial point centered on this frame.
PredefinedFrameType	getFactoryKey() Get the key of the frame within the factory.

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

getAncestor, getDepth, getFirstCommonPseudoInertialAncestor, getFirstPseudoInertialAncestor, getFrozenFrame, 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

PredefinedFrame

public PredefinedFrame(Frame parent,
                       TransformProvider transformProvider,
                       boolean pseudoInertial,
                       PredefinedFrameType factoryKeyIn)

Simple constructor.

Parameters:

parent - parent frame (must be non-null)

transformProvider - provider for transform from parent frame to instance

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

factoryKeyIn - key of the frame within the factory

Method Detail

getFactoryKey

public PredefinedFrameType getFactoryKey()

Get the key of the frame within the factory.

Returns:

key of the frame within the factory

getCelestialPoint

public CelestialPoint getCelestialPoint()
                                 throws PatriusException

Returns the celestial point centered on this frame. Built on the fly (lazy initialization).

Overrides:

getCelestialPoint in class CelestialBodyFrame

Returns:

the celestial point centered on this frame

Throws:

PatriusException - thrown if the celestial point could not be built