org.onosproject.net.device

Class OmsPortDescription

java.lang.Object

org.onosproject.net.AbstractDescription

org.onosproject.net.device.DefaultPortDescription

org.onosproject.net.device.OmsPortDescription

All Implemented Interfaces:

Annotated, Description, PortDescription

public class OmsPortDescription
extends DefaultPortDescription

Default implementation of immutable OMS port description.

Constructor Summary

Constructors

Constructor and Description
OmsPortDescription(PortDescription base, org.onlab.util.Frequency minFrequency, org.onlab.util.Frequency maxFrequency, org.onlab.util.Frequency grid, SparseAnnotations annotations) Creates OMS port description based on the supplied information.
OmsPortDescription(PortNumber number, boolean isEnabled, org.onlab.util.Frequency minFrequency, org.onlab.util.Frequency maxFrequency, org.onlab.util.Frequency grid, SparseAnnotations... annotations) Creates OMS port description based on the supplied information.

Method Summary

Modifier and Type	Method and Description
org.onlab.util.Frequency	grid() Returns grid spacing frequency.
org.onlab.util.Frequency	maxFrequency() Returns maximum frequency.
org.onlab.util.Frequency	minFrequency() Returns minimum frequency.
String	toString()

Methods inherited from class org.onosproject.net.device.DefaultPortDescription

isEnabled, portNumber, portSpeed, type

Methods inherited from class org.onosproject.net.AbstractDescription

annotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.Description

annotations

Constructor Detail

OmsPortDescription

public OmsPortDescription(PortNumber number,
                          boolean isEnabled,
                          org.onlab.util.Frequency minFrequency,
                          org.onlab.util.Frequency maxFrequency,
                          org.onlab.util.Frequency grid,
                          SparseAnnotations... annotations)

Creates OMS port description based on the supplied information.

Parameters:

number - port number

isEnabled - port enabled state

minFrequency - minimum frequency

maxFrequency - maximum frequency

grid - grid spacing frequency

annotations - optional key/value annotations map

OmsPortDescription

public OmsPortDescription(PortDescription base,
                          org.onlab.util.Frequency minFrequency,
                          org.onlab.util.Frequency maxFrequency,
                          org.onlab.util.Frequency grid,
                          SparseAnnotations annotations)

Creates OMS port description based on the supplied information.

Parameters:

base - PortDescription to get basic information from

minFrequency - minimum frequency

maxFrequency - maximum frequency

grid - grid spacing frequency

annotations - optional key/value annotations map

Method Detail

minFrequency

public org.onlab.util.Frequency minFrequency()

Returns minimum frequency.

Returns:

minimum frequency

maxFrequency

public org.onlab.util.Frequency maxFrequency()

Returns maximum frequency.

Returns:

maximum frequency

grid

public org.onlab.util.Frequency grid()

Returns grid spacing frequency.

Returns:

grid spacing frequency

toString

public String toString()

Overrides:

toString in class DefaultPortDescription