fr.cnes.sirius.patrius.frames

Class LocalOrbitalFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.LocalOrbitalFrame

All Implemented Interfaces:

Serializable

public class LocalOrbitalFrame
extends Frame

Class for frames moving with an orbiting satellite.

There are several local orbital frames available. They are specified by the LOFType enumerate.

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalOrbitalFrame(Frame parent, LOFType type, PVCoordinatesProvider provider, String name) Build a new instance.

Method Summary

Modifier and Type	Method and Description
LOFType	getLofType() Returns the local orbital frame type.

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

LocalOrbitalFrame

public LocalOrbitalFrame(Frame parent,
                         LOFType type,
                         PVCoordinatesProvider provider,
                         String name)

Build a new instance.

Parameters:

parent - parent frame. Local orbital frame is defined relatively to this parent frame. Parent frame is usually inertial or quasi-inertial, although non-inertial frame can also be used (in this case, this is not exactly a local orbital frame).

type - frame type

provider - provider used to compute frame motion

name - name of the frame

Throws:

IllegalArgumentException - if the parent frame is null

Method Detail

getLofType

public LOFType getLofType()

Returns the local orbital frame type.

Returns:

the local orbital frame type