org.onosproject.net.optical

Class OpticalAnnotations

java.lang.Object

org.onosproject.net.optical.OpticalAnnotations

@Beta
public final class OpticalAnnotations
extends Object

Collection of keys for annotation for optical devices.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_POWER Annotation key for optical port's current receiving power.
static String	GRID_HZ Annotation key for grid in Hz.
static String	INPUT_PORT_STATUS Annotation key for optical port's status in receiving direction.
static String	MAX_FREQ_HZ Annotation key for maximum frequency in Hz.
static String	MIN_FREQ_HZ Annotation key for minimum frequency in Hz.
static String	NEIGHBOR_ID Annotation key for optical port's neighbor's DeviceId#toString().
static String	NEIGHBOR_PORT Annotation key for optical port's neighbor's PortNumber#toString().
static String	OUTPUT_PORT_STATUS Annotation key for optical port's status in transmitting direction.
static String	OUTPUT_POWER Annotation key for bidirectional optical port's transmitting power.
static String	STATUS_IN_SERVICE Annotation value for optical port's in-service status.
static String	STATUS_OUT_SERVICE Annotation value for optical port's out-of-service status.
static String	TARGET_POWER Annotation key for optical port's target power.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_FREQ_HZ

public static final String MIN_FREQ_HZ

Annotation key for minimum frequency in Hz. Value is expected to be an integer.

See Also:

Constant Field Values

MAX_FREQ_HZ

public static final String MAX_FREQ_HZ

Annotation key for maximum frequency in Hz. Value is expected be an integer.

See Also:

Constant Field Values

GRID_HZ

public static final String GRID_HZ

Annotation key for grid in Hz. Value is expected to be an integer.

See Also:

Constant Field Values

TARGET_POWER

public static final String TARGET_POWER

Annotation key for optical port's target power. Value is expected to be an integer in 0.01 dBm unit.

See Also:

Constant Field Values

CURRENT_POWER

public static final String CURRENT_POWER

Annotation key for optical port's current receiving power. Value is expected to be an integer in 0.01 dBm unit.

See Also:

Constant Field Values

OUTPUT_POWER

public static final String OUTPUT_POWER

Annotation key for bidirectional optical port's transmitting power. Value is expected to be an integer in 0.01 dBm unit.

See Also:

Constant Field Values

NEIGHBOR_ID

public static final String NEIGHBOR_ID

Annotation key for optical port's neighbor's DeviceId#toString().

See Also:

Constant Field Values

NEIGHBOR_PORT

public static final String NEIGHBOR_PORT

Annotation key for optical port's neighbor's PortNumber#toString(). Value is expected to be an integer.

See Also:

Constant Field Values

INPUT_PORT_STATUS

public static final String INPUT_PORT_STATUS

Annotation key for optical port's status in receiving direction. Value is expected to be STATUS_IN_SERVICE or STATUS_OUT_SERVICE.

See Also:

Constant Field Values

OUTPUT_PORT_STATUS

public static final String OUTPUT_PORT_STATUS

Annotation key for optical port's status in transmitting direction. Value is expected to be STATUS_IN_SERVICE or STATUS_OUT_SERVICE.

See Also:

Constant Field Values

STATUS_IN_SERVICE

public static final String STATUS_IN_SERVICE

Annotation value for optical port's in-service status.

See Also:

Constant Field Values

STATUS_OUT_SERVICE

public static final String STATUS_OUT_SERVICE

Annotation value for optical port's out-of-service status.

See Also:

Constant Field Values