org.onosproject.ui.model.topo

Class UiDevice

java.lang.Object

org.onosproject.ui.model.topo.UiElement

org.onosproject.ui.model.topo.UiNode

org.onosproject.ui.model.topo.UiDevice

public class UiDevice
extends UiNode

Represents a device.

Field Summary

Fields inherited from class org.onosproject.ui.model.topo.UiNode

LAYER_DEFAULT, LAYER_OPTICAL, LAYER_PACKET

Constructor Summary

Constructors

Constructor and Description
UiDevice(UiTopology topology, Device device) Creates a new UI device.

Method Summary

Modifier and Type	Method and Description
Device	backingDevice() Returns the device instance backing this UI device.
DeviceId	id() Returns the identity of the device.
String	idAsString() Returns a string representation of the element identifier.
RegionId	regionId() Returns the identifier of the region to which this device belongs.
void	setRegionId(RegionId regionId) Sets the ID of the region to which this device belongs.
String	toString()
String	type() Returns a string representation of the type of the backing device.
UiRegion	uiRegion() Returns the UI region to which this device belongs.

Methods inherited from class org.onosproject.ui.model.topo.UiNode

layer, setLayer

Methods inherited from class org.onosproject.ui.model.topo.UiElement

destroy, name

Methods inherited from class java.lang.Object

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

Constructor Detail

UiDevice

public UiDevice(UiTopology topology,
                Device device)

Creates a new UI device.

Parameters:

topology - parent topology

device - backing device

Method Detail

setRegionId

public void setRegionId(RegionId regionId)

Sets the ID of the region to which this device belongs.

Parameters:

regionId - region identifier

toString

public String toString()

Overrides:

toString in class Object

id

public DeviceId id()

Returns the identity of the device.

Returns:

device ID

idAsString

public String idAsString()

Description copied from class: UiElement

Returns a string representation of the element identifier.

Specified by:

idAsString in class UiElement

Returns:

the element unique identifier

backingDevice

public Device backingDevice()

Returns the device instance backing this UI device.

Returns:

the backing device instance

regionId

public RegionId regionId()

Returns the identifier of the region to which this device belongs. This will be null if the device does not belong to any region.

Returns:

region ID

uiRegion

public UiRegion uiRegion()

Returns the UI region to which this device belongs.

Returns:

the UI region

type

public String type()

Returns a string representation of the type of the backing device.

Returns:

the device type