org.orekit.frames
Class LocalOrbitalFrame

java.lang.Object
  org.orekit.frames.Frame
      org.orekit.frames.LocalOrbitalFrame

All Implemented Interfaces:

java.io.Serializable

public class LocalOrbitalFrame
extends Frame

Class for frames moving with an orbiting satellite.

There are two main local orbital frames:

• the (t, n, w) frame has its X axis along velocity (tangential), its Z axis along orbital momentum and its Y axis completes the right-handed trihedra (it is roughly pointing towards the central body)
• the (q, s, w) frame has its X axis along position (radial), its Z axis along orbital momentum and its Y axis completes the right-handed trihedra (it is roughly along velocity)

Version:

$Revision: 3201 $ $Date: 2010-05-03 10:14:39 +0200 (lun. 03 mai 2010) $

Author:

Luc Maisonobe

See Also:

Serialized Form

Nested Class Summary

static class

LocalOrbitalFrame.LOFType List of supported frames types.

Constructor Summary

LocalOrbitalFrame(Frame parent, LocalOrbitalFrame.LOFType type, PVCoordinatesProvider provider, java.lang.String name)
Build a new instance.

Method Summary

protected void

updateFrame(AbsoluteDate date) Update the frame to the given date.

Methods inherited from class org.orekit.frames.Frame

getCIRF2000, getEME2000, getITRF2005, getJ2000, getName, getParent, getRoot, getTIRF2000, getTransformTo, getVeis1950, isChildOf, isQuasiInertial, setTransform, toString, updateTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalOrbitalFrame

public LocalOrbitalFrame(Frame parent,
                         LocalOrbitalFrame.LOFType type,
                         PVCoordinatesProvider provider,
                         java.lang.String name)
                  throws java.lang.IllegalArgumentException

Build a new instance.

Parameters:

parent - parent frame (must be non-null)

type - frame type

provider - provider used to compute frame motion

name - name of the frame

Throws:

java.lang.IllegalArgumentException - if the parent frame is null

Method Detail

updateFrame

protected void updateFrame(AbsoluteDate date)
                    throws OrekitException

Update the frame to the given date.

This method is called each time Frame.getTransformTo(Frame, AbsoluteDate) is called. The base implementation in the Frame class does nothing. The proper way to build a date-dependent frame is to extend the Frame class and implement this method which will have to call Frame.setTransform(Transform) with the new transform

Overrides:

updateFrame in class Frame

Parameters:

date - new value of the date

Throws:

OrekitException - if some frame specific error occurs