Package org.orekit.tutorials.estimation.common

Enum AttitudeMode

java.lang.Object

java.lang.Enum<AttitudeMode>

org.orekit.tutorials.estimation.common.AttitudeMode

All Implemented Interfaces:

Serializable, Comparable<AttitudeMode>

public enum AttitudeMode
extends Enum<AttitudeMode>

Attitude modes.

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTER_POINTING_WITH_YAW_STEERING	Body center pointing with yaw compensation.
DEFAULT_LAW	Default law.
LOF_ALIGNED_LVLH	Aligned with Local Vertical, Local Horizontal frame.
LOF_ALIGNED_QSW	Aligned with QSW frame.
LOF_ALIGNED_TNW	Aligned with TNW frame.
LOF_ALIGNED_VNC	aligned with Velocity - Normal - Co-normal frame.
LOF_ALIGNED_VVLH	Aligned with Vehicle Velocity, Local Horizontal frame.
NADIR_POINTING_WITH_YAW_COMPENSATION	Nadir pointing with yaw compensation.

Method Summary

Modifier and Type	Method	Description
abstract org.orekit.attitudes.AttitudeProvider	getProvider(org.orekit.frames.Frame inertialFrame, org.orekit.bodies.OneAxisEllipsoid body)	Get attitude provider.
static AttitudeMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttitudeMode[]	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

DEFAULT_LAW

public static final AttitudeMode DEFAULT_LAW

Default law.

NADIR_POINTING_WITH_YAW_COMPENSATION

public static final AttitudeMode NADIR_POINTING_WITH_YAW_COMPENSATION

Nadir pointing with yaw compensation.

CENTER_POINTING_WITH_YAW_STEERING

public static final AttitudeMode CENTER_POINTING_WITH_YAW_STEERING

Body center pointing with yaw compensation.

LOF_ALIGNED_LVLH

public static final AttitudeMode LOF_ALIGNED_LVLH

Aligned with Local Vertical, Local Horizontal frame.

LOF_ALIGNED_QSW

public static final AttitudeMode LOF_ALIGNED_QSW

Aligned with QSW frame.

LOF_ALIGNED_TNW

public static final AttitudeMode LOF_ALIGNED_TNW

Aligned with TNW frame.

LOF_ALIGNED_VNC

public static final AttitudeMode LOF_ALIGNED_VNC

aligned with Velocity - Normal - Co-normal frame.

LOF_ALIGNED_VVLH

public static final AttitudeMode LOF_ALIGNED_VVLH

Aligned with Vehicle Velocity, Local Horizontal frame.

Method Detail

values

public static AttitudeMode[] 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 (AttitudeMode c : AttitudeMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AttitudeMode 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

getProvider

public abstract org.orekit.attitudes.AttitudeProvider getProvider(org.orekit.frames.Frame inertialFrame,
                                                                  org.orekit.bodies.OneAxisEllipsoid body)

Get attitude provider.

Parameters:

inertialFrame - inertial frame

body - central body

Returns:

attitude provider