agi.foundation.communications

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

Enum AntennaTargetingResultReason

java.lang.Object

java.lang.Enum<AntennaTargetingResultReason>

agi.foundation.communications.AntennaTargetingResultReason

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AntennaTargetingResultReason>

public enum AntennaTargetingResultReason
extends Enum<AntennaTargetingResultReason>
implements Enumeration

Defines the reason attempting to orient a transmitter or receiver located within a CommunicationSystem has failed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ISET_ORIENTATION_AXES_NOT_AVAILABLE The antenna does not support the required ISetOrientationAxesService for setting orientation.
SUCCESS The antenna was oriented to target the antenna it is communicating with.
TARGETS_MULTIPLE_ANTENNAS The antenna could not be oriented because it is communicating with multiple antennas and the ideal orientation can not be automatically computed.

Method Summary

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

SUCCESS

public static final AntennaTargetingResultReason SUCCESS

The antenna was oriented to target the antenna it is communicating with.

TARGETS_MULTIPLE_ANTENNAS

public static final AntennaTargetingResultReason TARGETS_MULTIPLE_ANTENNAS

The antenna could not be oriented because it is communicating with multiple antennas and the ideal orientation can not be automatically computed.

ISET_ORIENTATION_AXES_NOT_AVAILABLE

public static final AntennaTargetingResultReason ISET_ORIENTATION_AXES_NOT_AVAILABLE

The antenna does not support the required ISetOrientationAxesService for setting orientation.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.