Package node_manager_fkie :: Module node_tree_model :: Class HostItem
[frames] | no frames]

Class HostItem

source code

PySide.QtGui.QStandardItem --+    
                             |    
                     GroupItem --+
                                 |
                                HostItem

The HostItem stores the information about a host.

Instance Methods
 
__init__(self, masteruri, address, local, parent=None)
Initialize the HostItem object with given values.
source code
str
updateTooltip(self)
Creates a tooltip description based on text set by updateDescription() and all childs of this host with valid sensor description.
source code
 
generateDescription(self, extended=True) source code
 
type(self) source code
 
__eq__(self, item)
Compares the address of the host.
source code
 
__gt__(self, item)
Compares the address of the host.
source code
 
addCapabilities(self, config, capabilities, masteruri)
Add new capabilities. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
addNode(self, node, cfg='')
Adds a new node with given name. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
clearUp(self, fixed_node_names=None)
Removes not running and not configured nodes. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
dict(config : [str])
getCapabilityGroups(self, node_name, cfg='')
Returns the names of groups, which contains the given node. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
GroupItem
getGroupItem(self, group_name)
Returns a GroupItem with given name. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
[GroupItem]
getGroupItems(self)
Returns all group items this group (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
[PySide.QtGui.QStandardItem]
getNodeItems(self)
Returns all nodes in this group and subgroups. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
[PySide.QtGui.QStandardItem]
getNodeItemsByName(self, node_name, recursive=True)
Since the same node can be included by different groups, this method searches for all nodes with given name and returns these items. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
[str]
getRunningNodes(self)
Returns the names of all running nodes. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
markNodesAsDuplicateOf(self, running_nodes)
While a synchronization same node on different hosts have the same name, the nodes with the same on other host are marked. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
name(self, new_name)
Set the new name of this group and updates the displayed name of the item. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
remCapablities(self, config)
Removes internal entry of the capability, so the new nodes are not grouped. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
updateDescription(self, descr_type, descr_name, descr)
Sets the description of the robot. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
updateDisplayedConfig(self)
Updates the configuration representation in other column. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
 
updateIcon(self) (Inherited from node_manager_fkie.node_tree_model.GroupItem) source code
 
updateRunningNodeState(self, nodes)
Updates the running state of the nodes given in a dictionary. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
Class Methods
 
hostNameFrom(cls, masteruri, address)
Returns the name generated from masteruri and address
source code
str
toHTML(cls, group_name)
Creates a HTML representation of the group name. (Inherited from node_manager_fkie.node_tree_model.GroupItem)
source code
Class Variables
  ITEM_TYPE = QtCore.Qt.UserRole+ 26
Method Details

__init__(self, masteruri, address, local, parent=None)
(Constructor)

source code 

Initialize the HostItem object with given values.

Parameters:
  • masteruri (str) - URI of the ROS master assigned to the host
  • address (str) - the address of the host
  • local (bool) - is this host the localhost where the node_manager is running.
Overrides: GroupItem.__init__

hostNameFrom(cls, masteruri, address)
Class Method

source code 

Returns the name generated from masteruri and address

Parameters:
  • masteruri (str) - URI of the ROS master assigned to the host
  • address (str) - the address of the host

updateTooltip(self)

source code 

Creates a tooltip description based on text set by updateDescription() and all childs of this host with valid sensor description. The result is returned as a HTML part.

Returns: str
the tooltip description coded as a HTML part
Overrides: GroupItem.updateTooltip

generateDescription(self, extended=True)

source code 
Overrides: GroupItem.generateDescription

type(self)

source code 
Overrides: GroupItem.type

__eq__(self, item)
(Equality operator)

source code 

Compares the address of the host.

Overrides: GroupItem.__eq__

__gt__(self, item)
(Greater-than operator)

source code 

Compares the address of the host.

Overrides: GroupItem.__gt__