Package org.ros.internal.node.client

Class ParameterClient

java.lang.Object

org.ros.internal.node.client.ParameterClient

public class ParameterClient
extends Object

Provide access to the XML-RPC API for a ROS ParameterServer.

Author:

kwc@willowgarage.com (Ken Conley), damonkohler@google.com (Damon Kohler)

Field Summary

Fields

Modifier and Type	Field	Description
protected final ParameterServerXmlRpcEndpoint	xmlRpcEndpoint

Constructor Summary

Constructors

Constructor	Description
ParameterClient(NodeIdentifier nodeIdentifier, URI uri)	Create a new ParameterClient connected to the specified ParameterServer URI.

Method Summary

Modifier and Type	Method	Description
Response<Void>	deleteParam(GraphName parameterName)
Response<Object>	getParam(GraphName parameterName)
Response<List<GraphName>>	getParamNames()
URI	getRemoteUri()
Response<Boolean>	hasParam(GraphName parameterName)
Response<GraphName>	searchParam(GraphName parameterName)
Response<Void>	setParam(GraphName parameterName, Boolean parameterValue)
Response<Void>	setParam(GraphName parameterName, Double parameterValue)
Response<Void>	setParam(GraphName parameterName, Integer parameterValue)
Response<Void>	setParam(GraphName parameterName, String parameterValue)
Response<Void>	setParam(GraphName parameterName, List<?> parameterValue)
Response<Void>	setParam(GraphName parameterName, Map<?,?> parameterValue)
Response<Object>	subscribeParam(GraphName parameterName)
Response<Integer>	unsubscribeParam(GraphName parameterName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

xmlRpcEndpoint

protected final ParameterServerXmlRpcEndpoint xmlRpcEndpoint

Constructor Details

ParameterClient

public ParameterClient(NodeIdentifier nodeIdentifier,
 URI uri)

Create a new ParameterClient connected to the specified ParameterServer URI.

Parameters:

uri - the URI of the ParameterServer to connect to

Method Details

getParam

public Response<Object> getParam(GraphName parameterName)

setParam

public Response<Void> setParam(GraphName parameterName,
 Boolean parameterValue)

setParam

public Response<Void> setParam(GraphName parameterName,
 Integer parameterValue)

setParam

public Response<Void> setParam(GraphName parameterName,
 Double parameterValue)

setParam

public Response<Void> setParam(GraphName parameterName,
 String parameterValue)

setParam

public Response<Void> setParam(GraphName parameterName,
 List<?> parameterValue)

setParam

public Response<Void> setParam(GraphName parameterName,
 Map<?,?> parameterValue)

searchParam

public Response<GraphName> searchParam(GraphName parameterName)

subscribeParam

public Response<Object> subscribeParam(GraphName parameterName)

unsubscribeParam

public Response<Integer> unsubscribeParam(GraphName parameterName)

hasParam

public Response<Boolean> hasParam(GraphName parameterName)

deleteParam

public Response<Void> deleteParam(GraphName parameterName)

getParamNames

public Response<List<GraphName>> getParamNames()

getRemoteUri

public URI getRemoteUri()

Returns:

the URI of the remote XmlRpcServer