Home       Trees       Indices       Help   
Package node_manager_fkie :: Module parameter_handler :: Class ParameterHandler
[frames] | no frames]

Class ParameterHandler

source code

       object --+            
                |            
sip.simplewrapper --+        
                    |        
          sip.wrapper --+    
                        |    
     PyQt4.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
 
parameter_list_signal(...)
parameter_list_signal is a signal, which is emitted if a new list with parameter names is retrieved.		 source code
 
parameter_values_signal(...)
parameter_values_signal is a signal, which is emitted if a new list with parameter names and their values is retrieved.		 source code
 
delivery_result_signal(...)
delivery_result_signal a signal is emitted after the parameter value was set.		 source code
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature		 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

Inherited from PyQt4.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connect, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, event, eventFilter, findChild, findChildren, inherits, installEventFilter, isWidgetType, killTimer, metaObject, moveToThread, objectName, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr, trUtf8

Inherited from sip.simplewrapper: __new__

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

Class Variables

Inherited from PyQt4.QtCore.QObject: staticMetaObject

Properties

Inherited from object: __class__

Method Details

parameter_list_signal(...)

source code 

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.

parameter_values_signal(...)

source code 

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.

delivery_result_signal(...)

source code 

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

__init__(self)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

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:

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Oct 6 11:14:54 2014 http://epydoc.sourceforge.net