Package roslaunch :: 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, address, env_loader=None, ssh_port=22, user=None, password=None, assignable=True, env_args=[], timeout=None)
:param name: machine name, ``str`` :param address: network address of machine, ``str`` :param env_loader: Path to environment loader, ``str`` :param ssh_port: SSH port number, ``int`` :param user: SSH username, ``str`` :param password: SSH password.
source code
 
__str__(self)
str(x)
source code
 
__eq__(self, m2) source code
 
config_key(self)
Get a key that represents the configuration of the machine.
source code
 
config_equals(self, m2)
:returns:: True if machines have identical configurations, ``bool``
source code
 
__ne__(self, m2) source code

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

Properties
  address
  assignable
  env_loader
  name
  password
  ssh_port
  timeout
  user

Inherited from object: __class__

Method Details

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

source code 

:param name: machine name, ``str`` :param address: network address of machine, ``str`` :param env_loader: Path to environment loader, ``str`` :param ssh_port: SSH port number, ``int`` :param user: SSH username, ``str`` :param password: SSH password. Not recommended for use. Use SSH keys instead., ``str``

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:: configuration key, ``str``