org.orekit.frames
Enum LOFType

java.lang.Object
  java.lang.Enum<LOFType>
      org.orekit.frames.LOFType

All Implemented Interfaces:

Serializable, Comparable<LOFType>

public enum LOFType
extends Enum<LOFType>

Enumerate for different types of Local Orbital Frames.

Author:

Luc Maisonobe

Enum Constant Summary

LVLH
Constant for Local Vertical, Local Horizontal frame CCSDS definition (Z axis aligned with opposite of position, Y axis aligned with opposite of orbital momentum).

QSW
Constant for QSW frame (X axis aligned with position, Z axis aligned with orbital momentum).

TNW
Constant for TNW frame (X axis aligned with velocity, Z axis aligned with orbital momentum).

VNC
Constant for Velocity - Normal - Co-normal frame (X axis aligned with velocity, Y axis aligned with orbital momentum).

Method Summary

protected abstract Rotation	rotationFromInertial(PVCoordinates pv) Get the rotation from inertial frame to local orbital frame.
Transform	transformFromInertial(AbsoluteDate date, PVCoordinates pv) Get the transform from an inertial frame defining position-velocity and the local orbital frame.
Transform	transformFromInertial(AbsoluteDate date, PVCoordinates pv, boolean computeSpinDerivatives) Get the transform from an inertial frame defining position-velocity and the local orbital frame.
static LOFType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LOFType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TNW

public static final LOFType TNW

Constant for TNW frame (X axis aligned with velocity, Z axis aligned with orbital momentum).

The axes of this frame are parallel to the axes of the VNC frame:

• X_TNW = X_VNC
• Y_TNW = -Z_VNC
• Z_TNW = Y_VNC

See Also:

VNC

QSW

public static final LOFType QSW

Constant for QSW frame (X axis aligned with position, Z axis aligned with orbital momentum).

This frame is also known as the LVLH frame, both constants are equivalent.

The axes of these frames are parallel to the axes of the LVLH frame:

• X_QSW/LVLH = -Z_LVLH
• Y_QSW/LVLH = X_LVLH
• Z_QSW/LVLH = -Y_LVLH

See Also:

LVLH

LVLH

public static final LOFType LVLH

Constant for Local Vertical, Local Horizontal frame CCSDS definition (Z axis aligned with opposite of position, Y axis aligned with opposite of orbital momentum).

The axes of this frame are parallel to the axes of the QSW frame:

• X_LVLH = Y_QSW
• Y_LVLH = -Z_QSW
• Z_LVLH = -X_QSW

WARNING : The current LVLH frame replaces the VVLH frame from old versions.

See Also:

QSW

VNC

public static final LOFType VNC

Constant for Velocity - Normal - Co-normal frame (X axis aligned with velocity, Y axis aligned with orbital momentum).

The axes of this frame are parallel to the axes of the TNW frame:

• X_VNC = X_TNW
• Y_VNC = Z_TNW
• Z_VNC = -Y_TNW

See Also:

TNW

Method Detail

values

public static LOFType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LOFType c : LOFType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LOFType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

transformFromInertial

public Transform transformFromInertial(AbsoluteDate date,
                                       PVCoordinates pv,
                                       boolean computeSpinDerivatives)

Get the transform from an inertial frame defining position-velocity and the local orbital frame.

Parameters:

date - current date

pv - position-velocity of the spacecraft in some inertial frame

computeSpinDerivatives - true if spin derivatives has to be computed

Returns:

transform from the frame where position-velocity are defined to local orbital frame

transformFromInertial

public Transform transformFromInertial(AbsoluteDate date,
                                       PVCoordinates pv)

Get the transform from an inertial frame defining position-velocity and the local orbital frame.

Parameters:

date - current date

pv - position-velocity of the spacecraft in some inertial frame

Returns:

transform from the frame where position-velocity are defined to local orbital frame

rotationFromInertial

protected abstract Rotation rotationFromInertial(PVCoordinates pv)

Get the rotation from inertial frame to local orbital frame.

Parameters:

pv - position-velocity of the spacecraft in some inertial frame

Returns:

rotation from inertial frame to local orbital frame