com.kuka.nav.fleet.graph
Class TopologyNode

java.lang.Object
  com.kuka.nav.fleet.graph.TopologyNodeId
      com.kuka.nav.fleet.graph.TopologyNode

public final class TopologyNode
extends TopologyNodeId

Topology graph node implementation.

Method Summary

String	getCustomUserData() Returns the CustomUserData value as a String if exist.
int	getMapId() Returns the id of the map this node is located on.
com.kuka.nav.Position	getPosition() Gets the position of the node.
PropertyHolder	getProperties() Gets the properties of the node.
com.kuka.nav.provider.util.ObjectMap<String>	getTags() Gets the tags of the node.
TopologyNode	inGraph(int graphId) Creates a new topology node identifier based on this one and "connecting" it (logically) to the graph with given id.
TopologyNode	inGraph(String graphName) Creates a new topology node identifier based on this one and "connecting" it (logically) to the graph with given name.
protected void	resetOwner() Removes the current owner.
void	setName(String name) Sets the name of the node.
protected void	setOwner(TopologyGraph graph) Sets the graph containing this node.
static TopologyNode	withId(int id) Creates a new topology node with given ID.
static TopologyNode	withName(String name) Creates a new topology graph node with given name.

Methods inherited from class com.kuka.nav.fleet.graph.TopologyNodeId

getGraphId, getGraphName, getId, getName, hasGraphName, hasName, toString

Methods inherited from class java.lang.Object

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

Method Detail

withId

public static TopologyNode withId(int id)

Creates a new topology node with given ID.

Note that the object created with this static factory method is only an identifier and does not reflect the state of the corresponding element in the data source, i.e. most of the getters will fail.

A TopologyNode returned by this method can be used to parameterize a GraphMotion#GraphMotion(TopologyGraph, TopologyNode).

Parameters:

id - the node ID

Returns:

the node

See Also:

GraphMotion#GraphMotion(TopologyGraph, TopologyNode)

withName

public static TopologyNode withName(String name)

Creates a new topology graph node with given name.

Note that the object created with this static factory method is only an identifier and does not reflect the state of the corresponding element in the data source, i.e. most of the getters will fail.

A TopologyNode returned by this method can be used to parameterize a GraphMotion#GraphMotion(TopologyGraph, TopologyNode).

Parameters:

name - the name

Returns:

the node

See Also:

GraphMotion#GraphMotion(TopologyGraph, TopologyNode)

getProperties

public PropertyHolder getProperties()

Description copied from class: TopologyNodeId

Gets the properties of the node.

Overrides:

getProperties in class TopologyNodeId

Returns:

the properties

getTags

public com.kuka.nav.provider.util.ObjectMap<String> getTags()

Description copied from class: TopologyNodeId

Gets the tags of the node.

Overrides:

getTags in class TopologyNodeId

Returns:

the tags

getMapId

public int getMapId()

Returns the id of the map this node is located on.

Returns:

the id of the corresponding map

setName

public void setName(String name)

Description copied from class: TopologyNodeId

Sets the name of the node.

Overrides:

setName in class TopologyNodeId

Parameters:

name - the name

getPosition

public com.kuka.nav.Position getPosition()

Gets the position of the node.

Returns:

the position

getCustomUserData

public String getCustomUserData()

Returns the CustomUserData value as a String if exist. Returns with null if not exist.

Returns:

the CustomUserData

inGraph

public TopologyNode inGraph(int graphId)

Description copied from class: TopologyNodeId

Creates a new topology node identifier based on this one and "connecting" it (logically) to the graph with given id.

Overrides:

inGraph in class TopologyNodeId

Parameters:

graphId - the graph ID

Returns:

the new node identifier

inGraph

public TopologyNode inGraph(String graphName)

Description copied from class: TopologyNodeId

Creates a new topology node identifier based on this one and "connecting" it (logically) to the graph with given name.

Overrides:

inGraph in class TopologyNodeId

Parameters:

graphName - the graph name

Returns:

the new node identifier

setOwner

protected void setOwner(TopologyGraph graph)

Sets the graph containing this node.

Parameters:

graph - the graph containing this node

resetOwner

protected void resetOwner()

Removes the current owner.