fr.cnes.sirius.patrius.frames

Class FactoryManagedFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.FactoryManagedFrame

All Implemented Interfaces:

Serializable

public class FactoryManagedFrame
extends Frame

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

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Predefined	getFactoryKey() Get the key of the frame within the factory.

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

getAncestor, getDepth, getFrozenFrame, getName, getParent, getRoot, getTransformJacobian, getTransformProvider, getTransformTo, getTransformTo, getTransformTo, getTransformTo, isChildOf, isPseudoInertial, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FactoryManagedFrame

public FactoryManagedFrame(Frame parent,
                           TransformProvider transformProvider,
                           boolean pseudoInertial,
                           Predefined 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 Predefined getFactoryKey()

Get the key of the frame within the factory.

Returns:

key of the frame within the factory