Public Member Functions | |
| List< Object > | deleteParam (String callerId, String key) |
| List< Object > | getParam (String callerId, String key) |
| List< Object > | getParamNames (String callerId) |
| List< Object > | hasParam (String callerId, String key) |
| List< Object > | searchParam (String callerId, String key) |
| List< Object > | setParam (String callerId, String key, Boolean value) |
| List< Object > | setParam (String callerId, String key, Integer value) |
| List< Object > | setParam (String callerId, String key, Double value) |
| List< Object > | setParam (String callerId, String key, String value) |
| List< Object > | setParam (String callerId, String key, List<?> value) |
| List< Object > | setParam (String callerId, String key, Map<?,?> value) |
| List< Object > | subscribeParam (String callerId, String callerApi, String key) |
| List< Object > | unsubscribeParam (String callerId, String callerApi, String key) |
Detailed Description
XML-RPC endpoint for a parameter server.
Definition at line 30 of file ParameterServerXmlRpcEndpoint.java.
Member Function Documentation
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.deleteParam | ( | String | callerId, |
| String | key | ||
| ) |
Deletes a parameter.
- Parameters:
-
callerId ROS caller ID key parameter name
- Returns:
- void
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.getParam | ( | String | callerId, |
| String | key | ||
| ) |
Retrieve parameter value from server.
If code is not 1, parameterValue should be ignored. If key is a namespace, the return value will be a dictionary, where each key is a parameter in that namespace. Sub-namespaces are also represented as dictionaries.
- Parameters:
-
callerId ROS caller ID key Parameter name. If key is a namespace, getParam() will return a parameter tree.
- Returns:
- the parameter value
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.getParamNames | ( | String | callerId | ) |
Gets the list of all parameter names stored on this server.
- Parameters:
-
callerId ROS caller ID.
- Returns:
- a Collection of parameter names
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.hasParam | ( | String | callerId, |
| String | key | ||
| ) |
Check if parameter is stored on server.
- Parameters:
-
callerId ROS caller ID. key Parameter name.
- Returns:
- if the parameter exists
true
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.searchParam | ( | String | callerId, |
| String | key | ||
| ) |
Searches for a parameter key on the ParameterServer.
Search starts in caller's namespace and proceeds upwards through parent namespaces until Parameter Server finds a matching key. searchParam()'s behavior is to search for the first partial match. For example, imagine that there are two 'robot_description' parameters /robot_description /robot_description/arm /robot_description/base /pr2/robot_description /pr2/robot_description/base If I start in the namespace /pr2/foo and search for robot_description, searchParam() will match /pr2/robot_description. If I search for robot_description/arm it will return /pr2/robot_description/arm, even though that parameter does not exist (yet).
If code is not 1, foundKey should be ignored.
- Parameters:
-
callerId ROS caller ID key Parameter name to search for.
- Returns:
- the found key
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| Boolean | value | ||
| ) |
Sets a parameter.
NOTE: if value is a dictionary it will be treated as a parameter tree, where key is the parameter namespace. For example {'x':1,'y':2,'sub':{'z':3}} will set key/x=1, key/y=2, and key/sub/z=3. Furthermore, it will replace all existing parameters in the key parameter namespace with the parameters in value. You must set parameters individually if you wish to perform a union update.
- Parameters:
-
callerId ROS caller ID key Parameter name. value Parameter value.
- Returns:
- void
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| Integer | value | ||
| ) |
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| Double | value | ||
| ) |
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| String | value | ||
| ) |
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| List<?> | value | ||
| ) |
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.setParam | ( | String | callerId, |
| String | key, | ||
| Map<?,?> | value | ||
| ) |
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.subscribeParam | ( | String | callerId, |
| String | callerApi, | ||
| String | key | ||
| ) |
Retrieves the parameter value from server and subscribe to updates to that param. See paramUpdate() in the Node API.
If code is not 1, parameterValue should be ignored. parameterValue is an empty dictionary if the parameter has not been set yet.
- Parameters:
-
callerId ROS caller ID callerApi Node API URI of subscriber for paramUpdate callbacks. key
- Returns:
- the parameter value
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
| List<Object> org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.unsubscribeParam | ( | String | callerId, |
| String | callerApi, | ||
| String | key | ||
| ) |
Unsubscribes from updates to the specified param. See paramUpdate() in the Node API.
A return value of zero means that the caller was not subscribed to the parameter.
- Parameters:
-
callerId ROS caller ID callerApi Node API URI of subscriber key Parameter name
- Returns:
- the number of parameters that were unsubscribed
Implemented in org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.
The documentation for this interface was generated from the following file: