Package dynamic_reconfigure :: Module client :: Class Client

Class Client

object --+
         |
        Client

Python dynamic_reconfigure client API

Instance Methods

__init__(self, name, timeout=None, config_callback=None, description_callback=None)
Connect to dynamic_reconfigure server and return a client object

source code

{str: value}

get_configuration(self, timeout=None)
Return the latest received server configuration (wait to receive one if none have been received)

source code

get_parameter_descriptions(self, timeout=None)
UNSTABLE.

source code

get_group_descriptions(self, timeout=None)

source code

update_configuration(self, changes)
Change the server's configuration

source code

update_groups(self, changes)
Changes the servers group configuration

source code

close(self)
Close connections to the server

source code

get_config_callback(self)
Retrieve the config_callback

source code

set_config_callback(self, value)
Set the config_callback

source code

get_description_callback(self)
Get the current description_callback

source code

set_description_callback(self, value)
UNSTABLE.

source code

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

Class Variables
	config_callback = `property(get_config_callback, set_config_cal...`
	description_callback = `property(get_description_callback, set_...`

Properties
Inherited from `object`: `__class__`

Method Details

init(self, name, timeout=None, config_callback=None, description_callback=None)
(Constructor)

source code

Connect to dynamic_reconfigure server and return a client object

Parameters:

name (str) - name of the server to connect to (usually the node name)
timeout (float) - time to wait before giving up
config_callback - callback for server parameter changes
description_callback - internal use only as the API has not stabilized

Overrides: object.__init__

get_configuration(self, timeout=None)

source code

Return the latest received server configuration (wait to receive one if none have been received)

Parameters:

timeout (float) - time to wait before giving up

Returns: {str: value}

dictionary mapping parameter names to values or None if unable to retrieve config.

get_parameter_descriptions(self, timeout=None)

source code

UNSTABLE. Return a description of the parameters for the server. Do not use this method as the type that is returned may change.

Parameters:

timeout (float) - time to wait before giving up

update_configuration(self, changes)

source code

Change the server's configuration

Parameters:

changes ({str: value}) - dictionary of key value pairs for the parameters that are changing

update_groups(self, changes)

source code

Changes the servers group configuration

Parameters:

changes ({str: value}) - dictionary of key value pairs for the parameters that are changing

set_description_callback(self, value)

source code

UNSTABLE. Set the description callback. Do not use as the type of the description callback may change.

Class Variable Details

config_callback

Value:

property(get_config_callback, set_config_callback)

description_callback

Value:

property(get_description_callback, set_description_callback)

Class Client

__init__(self, name, timeout=None, config_callback=None, description_callback=None) (Constructor)

get_configuration(self, timeout=None)

get_parameter_descriptions(self, timeout=None)

update_configuration(self, changes)

update_groups(self, changes)

set_description_callback(self, value)

config_callback

description_callback

init(self, name, timeout=None, config_callback=None, description_callback=None)
(Constructor)