Package node_manager_fkie :: Module parameter_handler :: Class ParameterHandler

Class ParameterHandler

python_qt_binding.QtCore.QObject --+
                                   |
                                  ParameterHandler

A class to retrieve the parameter list and their values from a ROS parameter server. The results are published by sending a QT signal. To parameter a new thread will be created.

Instance Methods

__init__(self)

source code

requestParameterList(self, masteruri, ns='/')
This method starts a thread to get the parameter list from ROS parameter server.

source code

requestParameterValues(self, masteruri, params)
This method starts a thread to get the parameter values from ROS parameter server.

source code

deliverParameter(self, masteruri, params)
This method starts a thread to load the parameter values into ROS parameter server.

source code

Class Variables
	parameter_list_signal = `Signal(str, int, str, list)` parameter_list_signal is a signal, which is emitted if a new list with parameter names is retrieved.
	parameter_values_signal = `Signal(str, int, str, dict)` parameter_values_signal is a signal, which is emitted if a new list with parameter names and their values is retrieved.
	delivery_result_signal = `Signal(str, int, str, dict)` delivery_result_signal a signal is emitted after the parameter value was set.

Method Details

requestParameterList(self, masteruri, ns='/')

source code

This method starts a thread to get the parameter list from ROS parameter server. If all informations are retrieved, a parameter_list_signal of this class will be emitted. This method is thread safe.

Parameters:

masteruri (str) - the URI of the ROS parameter server
ns (str) - the namespace of delivered parameter (Default: /)

requestParameterValues(self, masteruri, params)

source code

This method starts a thread to get the parameter values from ROS parameter server. If all informations are retrieved, a parameter_values_signal of this class will be emitted. This method is thread safe.

Parameters:

masteruri (str) - the URI of the ROS parameter server
params ([str]) - List with parameter names

deliverParameter(self, masteruri, params)

source code

This method starts a thread to load the parameter values into ROS parameter server. If all informations are retrieved, a delivery_result_signal of this class will be emitted. This method is thread safe.

Parameters:

masteruri (str) - the URI of the ROS parameter server
params (dict(str:value)) - The dictinary the parameter name and their value, see http://www.ros.org/wiki/ROS/Parameter%20Server%20API#setParam

Class Variable Details

parameter_list_signal

parameter_list_signal is a signal, which is emitted if a new list with parameter names is retrieved. The signal has the URI of the ROS parameter server and (code, statusMessage, parameterNameList) - the response of the server http://www.ros.org/wiki/ROS/Parameter%20Server%20API#getParamNames.

Value:

Signal(str, int, str, list)

parameter_values_signal

parameter_values_signal is a signal, which is emitted if a new list with parameter names and their values is retrieved. The signal has the URI of the ROS parameter server and (code, statusMessage, parameterNameValueDictionary) as parameter. The dictionary has the format dict(paramName : (code, statusMessage, parameterValue)). For details see http://www.ros.org/wiki/ROS/Parameter%20Server%20API#getParam.

Value:

Signal(str, int, str, dict)

delivery_result_signal

delivery_result_signal a signal is emitted after the parameter value was set. For format see parameter_values_signal signal.

Value:

Signal(str, int, str, dict)