Home       Trees       Indices       Help   
Package master_discovery_fkie :: Module master_info :: Class NodeInfo
[frames] | no frames]

Class NodeInfo

source code

object --+
         |
        NodeInfo

The NodeInfo class stores informations about a ROS node.

Instance Methods
 
__init__(self, name, masteruri)
Creates a new NodeInfo for a node with given name.		 source code
NodeInfo
copy(self)
Creates a copy this object and returns it.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
 
local_(masteruri, org_masteruri, uri) source code
Instance Variables
  pid
the process id of the node.
Properties
str name
Returns the name of the node.
str uri
Returns the URI of the RPC API of the node.
str masteruri
Returns the URI of the ROS master where the node is registered.
boolean isLocal
Returns True if the node and the ROS master are running on the same machine.
[str, ...] publishedTopics
Returns the list of all published topics by this node.
[str, ...] subscribedTopics
Returns the list of all subscribed topics by this node.
[str, ...] services
Returns the list of all services provided by this node.

Inherited from object: __class__

Method Details

__init__(self, name, masteruri)
(Constructor)

source code 

Creates a new NodeInfo for a node with given name.

Parameters:
  • name (str) - the name of the node
  • masteruri (str) - the URI of the ROS master, where the node is registered. This masteruri will be used to determine, whether the ROS master and the node are running on the same machine.
Overrides: object.__init__

Instance Variable Details

pid

the process id of the node. Invalid id has a None value

Property Details

name

Returns the name of the node.

Get Method:
unreachable.name(self) - Returns the name of the node.
Type:
str

uri

Returns the URI of the RPC API of the node.

Get Method:
unreachable.uri(self) - Returns the URI of the RPC API of the node.
Set Method:
unreachable.uri(self, uri) - Sets the URI of the RPC API of the node.
Type:
str

masteruri

Returns the URI of the ROS master where the node is registered.

Get Method:
unreachable.masteruri(self) - Returns the URI of the ROS master where the node is registered.
Set Method:
unreachable.masteruri(self, uri) - Sets the ROS master URI.
Type:
str

isLocal

Returns True if the node and the ROS master are running on the same machine.

Get Method:
unreachable.isLocal(self) - Returns True if the node and the ROS master are running on the same machine.
Type:
boolean

publishedTopics

Returns the list of all published topics by this node.

Get Method:
unreachable.publishedTopics(self) - Returns the list of all published topics by this node.
Set Method:
unreachable.publishedTopics(self, name) - Append a new published topic to this node.
Type:
[str, ...]

subscribedTopics

Returns the list of all subscribed topics by this node.

Get Method:
unreachable.subscribedTopics(self) - Returns the list of all subscribed topics by this node.
Set Method:
unreachable.subscribedTopics(self, name) - Append a new subscribed topic to this node.
Type:
[str, ...]

services

Returns the list of all services provided by this node.

Get Method:
unreachable.services(self) - Returns the list of all services provided by this node.
Set Method:
unreachable.services(self, name) - Append a new service to this node.
Type:
[str, ...]

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Apr 12 02:00:09 2013 http://epydoc.sourceforge.net