Public Member Functions
	Client (ConnectedNode node, String name)
	Client (ConnectedNode node, String name, MessageListener< ConfigDescription > descriptionCallback, MessageListener< Config > configCallback)
void	close ()
MessageListener< Config >	getConfigCallback ()
ConfigDescription	getConfigDescription ()
Config	getConfiguration ()
MessageListener < ConfigDescription >	getDescriptionCallback ()
Group	getGroupDescription ()
void	setConfigCallback (MessageListener< Config > listener)
void	setDescriptionCallback (MessageListener< ConfigDescription > listener)
void	updateConfiguration (TConfig config)
void	updateGroups ()
Protected Member Functions
void	descriptionsMsg ()
Class<?>	paramTypeFromString (String type)
void	updatesMsg (Config config)
Package Functions
protected< T extends Message, U extends Message > ServiceClient< T, U >	getService (String suffix, String type)
protected< T extends Message > Subscriber< T >	getSubscriber (String suffix, String type)
Private Attributes
Config	config = null
Subscriber< Config >	configSubscriber
ConfigDescription	description = null
Subscriber< ConfigDescription >	descriptionSubscriber
Group	groupDescription = null
MessageListener< Config >	internalConfigCallback
MessageListener < ConfigDescription >	internalDescriptionCallback
String	name
ConnectedNode	node
ServiceClient < ReconfigureRequest, ReconfigureResponse >	service

Detailed Description

Java dynamic_reconfigure client API.

Author:: erwanlehuitouze@gmail.com (Erwan Lehuitouze); mick.gaillard@gmail.com (Mickael Gaillard)

Definition at line 41 of file Client.java.

Constructor & Destructor Documentation

org.ros.dynamic_reconfigure.client.Client< TConfig >.Client	(	ConnectedNode	node,
		String	name
	)		`[inline]`

Definition at line 60 of file Client.java.

org.ros.dynamic_reconfigure.client.Client< TConfig >.Client	(	ConnectedNode	node,
		String	name,
		MessageListener< ConfigDescription >	descriptionCallback,
		MessageListener< Config >	configCallback
	)		`[inline]`

Connect to dynamic_reconfigure server and return a client object

Parameters:

node	current node.
name	name of the server to connect to (usually the node name).
descriptionCallback	internal use only as the API has not stabilized.
configCallback	callback for server parameter changes.

Definition at line 71 of file Client.java.

Member Function Documentation

void org.ros.dynamic_reconfigure.client.Client< TConfig >.close ( ) [inline]

Close connections to the server.

Definition at line 161 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.descriptionsMsg ( ) [inline, protected]

Definition at line 228 of file Client.java.

MessageListener<Config> org.ros.dynamic_reconfigure.client.Client< TConfig >.getConfigCallback ( ) [inline]

Retrieve the configuration callback.

Returns:: the listener.

Definition at line 171 of file Client.java.

ConfigDescription org.ros.dynamic_reconfigure.client.Client< TConfig >.getConfigDescription ( ) [inline]

UNSTABLE. Return a description of the parameters for the server. Do not use this method as the type that is returned may change.

Returns:: Configuration Description instance.

Definition at line 119 of file Client.java.

Config org.ros.dynamic_reconfigure.client.Client< TConfig >.getConfiguration ( ) [inline]

Return the latest received server configuration (wait to receive one if none have been received).

Returns:: Configuration instance.

Definition at line 110 of file Client.java.

MessageListener<ConfigDescription> org.ros.dynamic_reconfigure.client.Client< TConfig >.getDescriptionCallback ( ) [inline]

Get the current description callback.

Returns:: the listener.

Definition at line 190 of file Client.java.

Group org.ros.dynamic_reconfigure.client.Client< TConfig >.getGroupDescription ( ) [inline]

Definition at line 123 of file Client.java.

protected<T extends Message, U extends Message> ServiceClient<T, U> org.ros.dynamic_reconfigure.client.Client< TConfig >.getService	(	String	suffix,
		String	type
	)		`[inline, package]`

Definition at line 204 of file Client.java.

protected<T extends Message> Subscriber<T> org.ros.dynamic_reconfigure.client.Client< TConfig >.getSubscriber	(	String	suffix,
		String	type
	)		`[inline, package]`

Definition at line 216 of file Client.java.

Class<?> org.ros.dynamic_reconfigure.client.Client< TConfig >.paramTypeFromString ( String type ) [inline, protected]

Parameters:

type

Returns:

Definition at line 237 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.setConfigCallback ( MessageListener< Config > listener ) [inline]

Set the configuration callback.

Parameters:

listener to define.

Definition at line 179 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.setDescriptionCallback ( MessageListener< ConfigDescription > listener ) [inline]

UNSTABLE. Set the description callback. Do not use as the type of the description callback may change.

Definition at line 197 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.updateConfiguration ( TConfig config ) [inline]

Change the server's configuration.

Parameters:

config

Definition at line 131 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.updateGroups ( ) [inline]

Changes the servers group configuration.

Definition at line 154 of file Client.java.

void org.ros.dynamic_reconfigure.client.Client< TConfig >.updatesMsg ( Config config ) [inline, protected]

Definition at line 224 of file Client.java.

Member Data Documentation

Config org.ros.dynamic_reconfigure.client.Client< TConfig >.config = null [private]

Definition at line 57 of file Client.java.

Subscriber<Config> org.ros.dynamic_reconfigure.client.Client< TConfig >.configSubscriber [private]

Definition at line 51 of file Client.java.

ConfigDescription org.ros.dynamic_reconfigure.client.Client< TConfig >.description = null [private]

Definition at line 56 of file Client.java.

Subscriber<ConfigDescription> org.ros.dynamic_reconfigure.client.Client< TConfig >.descriptionSubscriber [private]

Definition at line 50 of file Client.java.

Group org.ros.dynamic_reconfigure.client.Client< TConfig >.groupDescription = null [private]

Definition at line 58 of file Client.java.

MessageListener<Config> org.ros.dynamic_reconfigure.client.Client< TConfig >.internalConfigCallback [private]

Definition at line 54 of file Client.java.

MessageListener<ConfigDescription> org.ros.dynamic_reconfigure.client.Client< TConfig >.internalDescriptionCallback [private]

Definition at line 53 of file Client.java.

String org.ros.dynamic_reconfigure.client.Client< TConfig >.name [private]

Definition at line 46 of file Client.java.

ConnectedNode org.ros.dynamic_reconfigure.client.Client< TConfig >.node [private]

Connected Node

Definition at line 45 of file Client.java.

ServiceClient<ReconfigureRequest, ReconfigureResponse> org.ros.dynamic_reconfigure.client.Client< TConfig >.service [private]

Definition at line 47 of file Client.java.

The documentation for this class was generated from the following file:

Client.java

Public Member Functions

Protected Member Functions

Package Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation