agi.foundation

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

Enum SignalDirection

java.lang.Object

java.lang.Enum<SignalDirection>

agi.foundation.SignalDirection

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SignalDirection>

public enum SignalDirection
extends Enum<SignalDirection>
implements Enumeration

Indicates the sense of the direction of a signal with respect to an observer.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECEIVE The signal is received at the observer.
TRANSMIT The signal is transmitted at the observer.

Method Summary

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

RECEIVE

public static final SignalDirection RECEIVE

The signal is received at the observer.

TRANSMIT

public static final SignalDirection TRANSMIT

The signal is transmitted at the observer.

Method Detail

values

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

Returns:

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

valueOf

public static SignalDirection 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 SignalDirection 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

@Nullable
public static SignalDirection getDefault()

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

Returns:

The default enum constant.