Package org.orekit.attitudes

Enum Class PredefinedTarget

java.lang.Object

java.lang.Enum<PredefinedTarget>

org.orekit.attitudes.PredefinedTarget

All Implemented Interfaces:

Serializable, Comparable<PredefinedTarget>, Constable, TargetProvider

public enum PredefinedTarget
extends Enum<PredefinedTarget>
implements TargetProvider

Predefined targets for AlignedAndConstrained.

Since:

12.2

Author:

Luc Maisonobe

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EARTH	Earth direction (assumes the frame is Earth centered).
EAST	East direction.
MOMENTUM	Satellite orbital momentum.
NADIR	Nadir.
NORTH	North direction.
SUN	Sun direction.
VELOCITY	Satellite velocity.

Method Summary

Modifier and Type	Method	Description
static PredefinedTarget	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PredefinedTarget[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.orekit.attitudes.TargetProvider

getDerivative2TargetDirection, getDerivative2TargetDirection, getTargetDirection, getTargetDirection

Enum Constant Details

SUN

public static final PredefinedTarget SUN

Sun direction.

EARTH

public static final PredefinedTarget EARTH

Earth direction (assumes the frame is Earth centered).

NADIR

public static final PredefinedTarget NADIR

Nadir.

NORTH

public static final PredefinedTarget NORTH

North direction.

EAST

public static final PredefinedTarget EAST

East direction.

VELOCITY

public static final PredefinedTarget VELOCITY

Satellite velocity.

MOMENTUM

public static final PredefinedTarget MOMENTUM

Satellite orbital momentum.

Method Details

values

public static PredefinedTarget[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PredefinedTarget valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null