agi.foundation.propagators

(agi.foundation.models-2024r3.jar)

Enum GeneralPerturbationObjectType

java.lang.Object

java.lang.Enum<GeneralPerturbationObjectType>

agi.foundation.propagators.GeneralPerturbationObjectType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<GeneralPerturbationObjectType>

public enum GeneralPerturbationObjectType
extends Enum<GeneralPerturbationObjectType>
implements Enumeration

The classification of an orbiting body for a UsafGeneralPerturbationElements.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBRIS The orbiting body is debris.
PAYLOAD The orbiting body is an active or inactive payload.
PLATFORM The orbiting body is a platform.
ROCKET_BODY The orbiting body is the spent upper stage of a launch vehicle, an apogee kick motor, a perigee kick motor, or a payload assist module.
UNKNOWN The orbiting body does not have a known classification.

Method Summary

Modifier and Type	Method and Description
static GeneralPerturbationObjectType	getDefault() Get the enum constant that is considered to be the default.
static GeneralPerturbationObjectType	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static GeneralPerturbationObjectType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeneralPerturbationObjectType[]	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

UNKNOWN

public static final GeneralPerturbationObjectType UNKNOWN

The orbiting body does not have a known classification.

PAYLOAD

public static final GeneralPerturbationObjectType PAYLOAD

The orbiting body is an active or inactive payload.

ROCKET_BODY

public static final GeneralPerturbationObjectType ROCKET_BODY

The orbiting body is the spent upper stage of a launch vehicle, an apogee kick motor, a perigee kick motor, or a payload assist module.

PLATFORM

public static final GeneralPerturbationObjectType PLATFORM

The orbiting body is a platform.

DEBRIS

public static final GeneralPerturbationObjectType DEBRIS

The orbiting body is debris.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static GeneralPerturbationObjectType getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static GeneralPerturbationObjectType getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.