agi.foundation.access

(agi.foundation.core-2024r2.jar)

Enum AccessSignalModel

java.lang.Object

java.lang.Enum<AccessSignalModel>

agi.foundation.access.AccessSignalModel

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AccessSignalModel>

public enum AccessSignalModel
extends Enum<AccessSignalModel>
implements Enumeration

Indicates which effects are to be consider in modeling the signal path and observation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME Model the apparent relative position of the objects accounting for light travel time.
APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME_AND_ABERRATION Model the apparent relative position of the objects accounting for light travel time and aberration.
TRUE_POSITION Model the true relative position of the objects.

Method Summary

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

TRUE_POSITION

public static final AccessSignalModel TRUE_POSITION

Model the true relative position of the objects.

APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME

public static final AccessSignalModel APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME

Model the apparent relative position of the objects accounting for light travel time.

APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME_AND_ABERRATION

public static final AccessSignalModel APPARENT_POSITION_WITH_LIGHT_TRAVEL_TIME_AND_ABERRATION

Model the apparent relative position of the objects accounting for light travel time and aberration.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.