Module com.marginallyclever.robotoverlord

Package com.marginallyclever.convenience

Enum Class KSPDirections

java.lang.Object

java.lang.Enum<KSPDirections>

com.marginallyclever.convenience.KSPDirections

All Implemented Interfaces:

Serializable, Comparable<KSPDirections>, Constable

public enum KSPDirections
extends Enum<KSPDirections>

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
ANTINORMAL	Antinormal is the opposite direction of the orbit's normal vector.
NORMAL	Normal is the direction of the orbit's normal vector.
PROGRADE	Prograde is the direction of travel.
RADIAL_IN	Radial is the direction of the orbit's radial vector.
RADIAL_OUT	Antiradial is the opposite direction of the orbit's radial vector.
RETROGRADE	Retrograde is the opposite direction of travel.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROGRADE

public static final KSPDirections PROGRADE

Prograde is the direction of travel. +Z

RETROGRADE

public static final KSPDirections RETROGRADE

Retrograde is the opposite direction of travel. -Z

NORMAL

public static final KSPDirections NORMAL

Normal is the direction of the orbit's normal vector. +Y

ANTINORMAL

public static final KSPDirections ANTINORMAL

Antinormal is the opposite direction of the orbit's normal vector. -Y

RADIAL_IN

public static final KSPDirections RADIAL_IN

Radial is the direction of the orbit's radial vector. +X

RADIAL_OUT

public static final KSPDirections RADIAL_OUT

Antiradial is the opposite direction of the orbit's radial vector. -X

Method Details

values

public static KSPDirections[] 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 KSPDirections 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