agi.foundation.celestial

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

Enum CoefficientOfReflectivityType

java.lang.Object

java.lang.Enum<CoefficientOfReflectivityType>

agi.foundation.celestial.CoefficientOfReflectivityType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CoefficientOfReflectivityType>

public enum CoefficientOfReflectivityType
extends Enum<CoefficientOfReflectivityType>
implements Enumeration

Defines the type of Reflectivity Coefficient used in initializing SimpleSolarRadiationForce.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK_BODY This type of Cr is normally used in black body calculations.
RADIATION_PRESSURE This type of Cr is usually used for radiation pressure calculations, as it represents the modifier to the momentum imparted onto the body by the light.

Method Summary

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

BLACK_BODY

public static final CoefficientOfReflectivityType BLACK_BODY

This type of Cr is normally used in black body calculations. A Black Body Cr of 0.0 means the body absorbs all light incident on it, and a Cr of 1.0 means it reflects all light.

RADIATION_PRESSURE

public static final CoefficientOfReflectivityType RADIATION_PRESSURE

This type of Cr is usually used for radiation pressure calculations, as it represents the modifier to the momentum imparted onto the body by the light. A RP Cr of 1.0 means that the body absorbs all light incident on it. A RP Cr of 2.0 means that the body reflects all light, which doubles the momentum imparted to the body.

Method Detail

values

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

Returns:

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

valueOf

public static CoefficientOfReflectivityType 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 CoefficientOfReflectivityType 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 CoefficientOfReflectivityType getDefault()

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

Returns:

The default enum constant.