Module roslua.param_proxy
Parameter XML-RPC API proxy. This module contains the ParamProxy class to call methods provided via XML-RPC by the parameter server.
Copyright© Tim Niemueller, Carnegie Mellon University, Intel Research Pittsburgh
Release: Released under BSD license
Functions
| ParamProxy:delete_param (key) | Delete parameter. |
| ParamProxy:getParam (key) | Get parameter. |
| ParamProxy:get_param_names () | Get names of all available parameters. |
| ParamProxy:has_param (key) | Check if parameter exists. |
| ParamProxy:new (ros_master_uri, node_name) | Constructor. |
| ParamProxy:search_param (key) | Search for parameter. |
| ParamProxy:set_param (key, value) | Set parameter. |
| ParamProxy:subscribe_param (key) | Subscribe to parameter. |
| ParamProxy:unsubscribe_param (key) | Unsubscribe from parameter. |
Functions
- ParamProxy:delete_param (key)
-
Delete parameter.
Parameters
- key: key of the parameter to delete
- ParamProxy:getParam (key)
-
Get parameter.
Parameters
- key: key of the parameter to query
Return value:
value of the parameter - ParamProxy:get_param_names ()
-
Get names of all available parameters.
Return value:
array with names of all parameters - ParamProxy:has_param (key)
-
Check if parameter exists.
Parameters
- key: key of the parameter to query
Return value:
true if the parameter exists, false otherwise - ParamProxy:new (ros_master_uri, node_name)
-
Constructor.
Parameters
- ros_master_uri: XML-RPC HTTP URI of ROS master
- node_name: name of this node
- ParamProxy:search_param (key)
-
Search for parameter.
Parameters
- key: substring of the key to look for
Return value:
first key that matched - ParamProxy:set_param (key, value)
-
Set parameter.
Parameters
- key: key of the parameter to set
- value: value of the parameter to set
- ParamProxy:subscribe_param (key)
-
Subscribe to parameter.
Parameters
- key: key to subscribe to
- ParamProxy:unsubscribe_param (key)
-
Unsubscribe from parameter.
Parameters
- key: key to unsubscribe from