agi.foundation.communications.signalpropagation

(agi.foundation.tirem-2024r1.jar)

Enum TiremPropagationMode

java.lang.Object

java.lang.Enum<TiremPropagationMode>

agi.foundation.communications.signalpropagation.TiremPropagationMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TiremPropagationMode>

public enum TiremPropagationMode
extends Enum<TiremPropagationMode>
implements Enumeration

The different modes of propagation TIREM reports.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIFFRACTION The Diffraction propagation mode.
LINE_OF_SIGHT The Line of Sight propagation mode.
TROPOSPHERIC_SCATTER The Tropospheric Scatter propagation mode.

Method Summary

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

LINE_OF_SIGHT

public static final TiremPropagationMode LINE_OF_SIGHT

The Line of Sight propagation mode.

DIFFRACTION

public static final TiremPropagationMode DIFFRACTION

The Diffraction propagation mode.

TROPOSPHERIC_SCATTER

public static final TiremPropagationMode TROPOSPHERIC_SCATTER

The Tropospheric Scatter propagation mode.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.