org.onosproject.net.pi.runtime

Class PiMeterCellHandle

java.lang.Object

org.onosproject.net.pi.runtime.PiHandle

org.onosproject.net.pi.runtime.PiMeterCellHandle

@Beta
public final class PiMeterCellHandle
extends PiHandle

Global identifier of a PI meter cell instantiated on a device, uniquely defined by a device ID and meter cell ID.

Method Summary

Modifier and Type	Method and Description
PiMeterCellId	cellId() Returns the cell ID associated with this handle.
PiEntityType	entityType() Returns the type of entity identified by this handle.
boolean	equals(Object o)
int	hashCode()
static PiMeterCellHandle	of(DeviceId deviceId, PiMeterCellConfig meterCellConfig) Creates a new handle for the given device ID and PI meter cell configuration.
static PiMeterCellHandle	of(DeviceId deviceId, PiMeterCellId meterCellId) Creates a new handle for the given device ID and PI meter cell ID.
String	toString()

Methods inherited from class org.onosproject.net.pi.runtime.PiHandle

deviceId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static PiMeterCellHandle of(DeviceId deviceId,
                                   PiMeterCellId meterCellId)

Creates a new handle for the given device ID and PI meter cell ID.

Parameters:

deviceId - device ID

meterCellId - meter cell ID

Returns:

PI meter handle

of

public static PiMeterCellHandle of(DeviceId deviceId,
                                   PiMeterCellConfig meterCellConfig)

Creates a new handle for the given device ID and PI meter cell configuration.

Parameters:

deviceId - device ID

meterCellConfig - meter config

Returns:

PI meter handle

cellId

public PiMeterCellId cellId()

Returns the cell ID associated with this handle.

Returns:

cell ID

entityType

public PiEntityType entityType()

Description copied from class: PiHandle

Returns the type of entity identified by this handle.

Specified by:

entityType in class PiHandle

Returns:

PI entity type

hashCode

public int hashCode()

Specified by:

hashCode in class PiHandle

equals

public boolean equals(Object o)

Specified by:

equals in class PiHandle

toString

public String toString()

Specified by:

toString in class PiHandle