agi.foundation.geometry.shapes

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

Enum SensorSpaceProjection

java.lang.Object

java.lang.Enum<SensorSpaceProjection>

agi.foundation.geometry.shapes.SensorSpaceProjection

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SensorSpaceProjection>

public enum SensorSpaceProjection
extends Enum<SensorSpaceProjection>
implements Enumeration

Specifies the type of projection to use when projecting a sensor into space.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PROJECT_TO_PLANE The sensor is projected into a plane orthogonal to the sensor boresight axis.
PROJECT_TO_RADIUS The sensor is projected to a radial limit from the sensor origin.

Method Summary

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

PROJECT_TO_RADIUS

public static final SensorSpaceProjection PROJECT_TO_RADIUS

The sensor is projected to a radial limit from the sensor origin.

PROJECT_TO_PLANE

public static final SensorSpaceProjection PROJECT_TO_PLANE

The sensor is projected into a plane orthogonal to the sensor boresight axis.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.