fr.cnes.sirius.patrius.frames

Class FrozenFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.FrozenFrame

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

public final class FrozenFrame
extends Frame

Provide a wrapper frame between a reference and a coordinate frame, so that it has no angular velocity

Author:

GMV

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FrozenFrame(Frame coordinate, Frame reference, String name) Build a non-inertial frame that has zero linear/angular velocity to a given reference frame.

Method Summary

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

FrozenFrame

public FrozenFrame(Frame coordinate,
                   Frame reference,
                   String name)
            throws IllegalArgumentException

Build a non-inertial frame that has zero linear/angular velocity to a given reference frame.
Represents a frame that returns always as a frozenFrame (so that function actually has no use for this frame).
Note that frame is internally declared inertial if reference is so as to allow computation of "osculating" keplerian elements, but this frame CANNOT be used for propagation (or any time-variable usage).

Parameters:

coordinate - represented frame

reference - (inertial) frame from which the coordinate frame is frozen

name - name of the frame (eg coordinate.getName()+".Frozen")

Throws:

IllegalArgumentException - if the parent frame is null