Package roshlaunch :: Module core :: Class Machine
[frames] | no frames]

Class Machine

source code

object --+
         |
        Machine

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

Instance Methods
 
__init__(self, name, ros_root, ros_package_path, address, ros_ip=None, ssh_port=22, user=None, password=None, assignable=True, env_args=[], timeout=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__str__(self)
str(x)
source code
 
__eq__(self, m2) source code
str
config_key(self)
Get a key that represents the configuration of the machine.
source code
bool
config_equals(self, m2)
Returns: True if machines have identical configurations
source code
 
__ne__(self, m2) source code

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

Properties

Inherited from object: __class__

Method Details

__init__(self, name, ros_root, ros_package_path, address, ros_ip=None, ssh_port=22, user=None, password=None, assignable=True, env_args=[], timeout=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • name (str) - machine name
  • ros_root (str) - ROS_ROOT on machine
  • ros_package_path (str) - ROS_PACKAGE_PATH on machine
  • address (str) - network address of machine
  • ros_ip (str) - ROS_IP on machine
  • ssh_port (int) - SSH port number
  • user (str) - SSH username
  • password (str) - SSH password. Not recommended for use. Use SSH keys instead.
Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

config_key(self)

source code 

Get a key that represents the configuration of the machine. machines with identical configurations have identical keys

Returns: str
configuration key

config_equals(self, m2)

source code 
Returns: bool
True if machines have identical configurations