Package roslaunch :: Module core :: Class Node
[frames] | no frames]

Class Node

source code

object --+
         |
        Node
Known Subclasses:

Data structure for storing information about a desired node in the ROS system Corresponds to the 'node' tag in the launch specification.

Instance Methods
 
__init__(self, package, node_type, name=None, namespace='/', machine_name=None, args='', respawn=False, remap_args=None, env_args=None, output=None, cwd=None, launch_prefix=None, required=False, filename='<unknown>')
:param package: node package name, ``str`` :param node_type: node type, ``str`` :param name: node name, ``str`` :param namespace: namespace for node, ``str`` :param machine_name: name of machine to run node on, ``str`` :param args: argument string to pass to node executable, ``str`` :param respawn: if True, respawn node if it dies, ``bool`` :param remap_args: list of [(from, to)] remapping arguments, ``[(str, str)]`` :param env_args: list of [(key, value)] of additional environment vars to set for node, ``[(str, str)]`` :param output: where to log output to, either Node, 'screen' or 'log', ``str`` :param cwd: current working directory of node, either 'node', 'ROS_HOME'.
source code
 
xmltype(self) source code
 
xmlattrs(self) source code
 
to_xml(self)
convert representation into XML representation.
source code
 
to_remote_xml(self)
convert representation into remote representation.
source code

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

Properties
  args
  cwd
  env_args
  filename
  launch_prefix
  machine
  machine_name
  name
  namespace
  output
  package
  process_name
  remap_args
  required
  respawn
  type

Inherited from object: __class__

Method Details

__init__(self, package, node_type, name=None, namespace='/', machine_name=None, args='', respawn=False, remap_args=None, env_args=None, output=None, cwd=None, launch_prefix=None, required=False, filename='<unknown>')
(Constructor)

source code 

:param package: node package name, ``str`` :param node_type: node type, ``str`` :param name: node name, ``str`` :param namespace: namespace for node, ``str`` :param machine_name: name of machine to run node on, ``str`` :param args: argument string to pass to node executable, ``str`` :param respawn: if True, respawn node if it dies, ``bool`` :param remap_args: list of [(from, to)] remapping arguments, ``[(str, str)]`` :param env_args: list of [(key, value)] of additional environment vars to set for node, ``[(str, str)]`` :param output: where to log output to, either Node, 'screen' or 'log', ``str`` :param cwd: current working directory of node, either 'node', 'ROS_HOME'. Default: ROS_HOME, ``str`` :param launch_prefix: launch command/arguments to prepend to node executable arguments, ``str`` :param required: node is required to stay running (launch fails if node dies), ``bool`` :param filename: name of file Node was parsed from, ``str``

:raises: :exc:`ValueError` If parameters do not validate

Overrides: object.__init__

to_xml(self)

source code 

convert representation into XML representation. Currently cannot represent private parameters. :returns:: XML representation for remote machine, ``str``

to_remote_xml(self)

source code 

convert representation into remote representation. Remote representation does not include parameter settings or 'machine' attribute :returns:: XML representation for remote machine, ``str``