Inheritance diagram for org.ros.internal.node.parameter.DefaultParameterTree:

Public Member Functions
void	addParameterListener (GraphName name, ParameterListener listener)
void	addParameterListener (String name, ParameterListener listener)
void	delete (GraphName name)
void	delete (String name)
boolean	getBoolean (GraphName name)
boolean	getBoolean (String name)
boolean	getBoolean (GraphName name, boolean defaultValue)
boolean	getBoolean (String name, boolean defaultValue)
double	getDouble (GraphName name)
double	getDouble (String name)
double	getDouble (GraphName name, double defaultValue)
double	getDouble (String name, double defaultValue)
int	getInteger (GraphName name)
int	getInteger (String name)
int	getInteger (GraphName name, int defaultValue)
int	getInteger (String name, int defaultValue)
List<?>	getList (GraphName name)
List<?>	getList (String name)
List<?>	getList (GraphName name, List<?> defaultValue)
List<?>	getList (String name, List<?> defaultValue)
Map<?,?>	getMap (GraphName name)
Map<?,?>	getMap (String name)
Map<?,?>	getMap (GraphName name, Map<?,?> defaultValue)
Map<?,?>	getMap (String name, Map<?,?> defaultValue)
List< GraphName >	getNames ()
String	getString (GraphName name)
String	getString (String name)
String	getString (GraphName name, String defaultValue)
String	getString (String name, String defaultValue)
boolean	has (GraphName name)
boolean	has (String name)
GraphName	search (GraphName name)
GraphName	search (String name)
void	set (GraphName name, boolean value)
void	set (String name, boolean value)
void	set (GraphName name, int value)
void	set (String name, int value)
void	set (GraphName name, double value)
void	set (String name, double value)
void	set (GraphName name, String value)
void	set (String name, String value)
void	set (GraphName name, List<?> value)
void	set (String name, List<?> value)
void	set (GraphName name, Map<?,?> value)
void	set (String name, Map<?,?> value)
Static Public Member Functions
static DefaultParameterTree	newFromNodeIdentifier (NodeIdentifier nodeIdentifier, URI masterUri, NameResolver resolver, ParameterManager parameterManager)
Package Functions
private< T > T	get (GraphName name, Class< T > type)
private< T > T	get (GraphName name, T defaultValue)
Private Member Functions
	DefaultParameterTree (ParameterClient parameterClient, ParameterManager parameterManager, NameResolver resolver)
Private Attributes
final ParameterClient	parameterClient
final ParameterManager	parameterManager
final NameResolver	resolver

Detailed Description

Provides access to the ROS ParameterServer.

Author:: kwc@willowgarage.com (Ken Conley); damonkohler@google.com (Damon Kohler)

Definition at line 44 of file DefaultParameterTree.java.

Constructor & Destructor Documentation

org.ros.internal.node.parameter.DefaultParameterTree.DefaultParameterTree	(	ParameterClient	parameterClient,
		ParameterManager	parameterManager,
		NameResolver	resolver
	)		`[inline, private]`

Definition at line 56 of file DefaultParameterTree.java.

Member Function Documentation

void org.ros.internal.node.parameter.DefaultParameterTree.addParameterListener	(	GraphName	name,
		ParameterListener	listener
	)		`[inline]`

Subscribes to changes to the specified parameter.

Parameters:

name	the parameter name to subscribe to
listener	a ParameterListener that will be called when the subscribed parameter changes

Implements org.ros.node.parameter.ParameterTree.

Definition at line 107 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.addParameterListener	(	String	name,
		ParameterListener	listener
	)		`[inline]`

See also:: addParameterListener(GraphName, ParameterListener)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 113 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.delete ( GraphName name ) [inline]

Deletes a specified parameter.

Parameters:

name	the parameter name

Implements org.ros.node.parameter.ParameterTree.

Definition at line 75 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.delete ( String name ) [inline]

See also:: delete(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 81 of file DefaultParameterTree.java.

private<T> T org.ros.internal.node.parameter.DefaultParameterTree.get	(	GraphName	name,
		Class< T >	type
	)		`[inline, package]`

Definition at line 183 of file DefaultParameterTree.java.

private<T> T org.ros.internal.node.parameter.DefaultParameterTree.get	(	GraphName	name,
		T	defaultValue
	)		`[inline, package]`

Definition at line 197 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.getBoolean ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 214 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.getBoolean ( String name ) [inline]

See also:: getBoolean(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 219 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.getBoolean	(	GraphName	name,
		boolean	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 224 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.getBoolean	(	String	name,
		boolean	defaultValue
	)		`[inline]`

See also:: getBoolean(GraphName, boolean)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 229 of file DefaultParameterTree.java.

double org.ros.internal.node.parameter.DefaultParameterTree.getDouble ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 254 of file DefaultParameterTree.java.

double org.ros.internal.node.parameter.DefaultParameterTree.getDouble ( String name ) [inline]

See also:: getDouble(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 259 of file DefaultParameterTree.java.

double org.ros.internal.node.parameter.DefaultParameterTree.getDouble	(	GraphName	name,
		double	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 264 of file DefaultParameterTree.java.

double org.ros.internal.node.parameter.DefaultParameterTree.getDouble	(	String	name,
		double	defaultValue
	)		`[inline]`

See also:: getDouble(GraphName, double)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 269 of file DefaultParameterTree.java.

int org.ros.internal.node.parameter.DefaultParameterTree.getInteger ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 234 of file DefaultParameterTree.java.

int org.ros.internal.node.parameter.DefaultParameterTree.getInteger ( String name ) [inline]

See also:: getInteger(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 239 of file DefaultParameterTree.java.

int org.ros.internal.node.parameter.DefaultParameterTree.getInteger	(	GraphName	name,
		int	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 244 of file DefaultParameterTree.java.

int org.ros.internal.node.parameter.DefaultParameterTree.getInteger	(	String	name,
		int	defaultValue
	)		`[inline]`

See also:: getInteger(GraphName, int)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 249 of file DefaultParameterTree.java.

List<?> org.ros.internal.node.parameter.DefaultParameterTree.getList ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 294 of file DefaultParameterTree.java.

List<?> org.ros.internal.node.parameter.DefaultParameterTree.getList ( String name ) [inline]

See also:: getList(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 299 of file DefaultParameterTree.java.

List<?> org.ros.internal.node.parameter.DefaultParameterTree.getList	(	GraphName	name,
		List<?>	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 304 of file DefaultParameterTree.java.

List<?> org.ros.internal.node.parameter.DefaultParameterTree.getList	(	String	name,
		List<?>	defaultValue
	)		`[inline]`

See also:: #getList(GraphName, List)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 309 of file DefaultParameterTree.java.

Map<?, ?> org.ros.internal.node.parameter.DefaultParameterTree.getMap ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 314 of file DefaultParameterTree.java.

Map<?, ?> org.ros.internal.node.parameter.DefaultParameterTree.getMap ( String name ) [inline]

See also:: getMap(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 319 of file DefaultParameterTree.java.

Map<?, ?> org.ros.internal.node.parameter.DefaultParameterTree.getMap	(	GraphName	name,
		Map<?,?>	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 324 of file DefaultParameterTree.java.

Map<?, ?> org.ros.internal.node.parameter.DefaultParameterTree.getMap	(	String	name,
		Map<?,?>	defaultValue
	)		`[inline]`

See also:: #getMap(GraphName, Map)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 329 of file DefaultParameterTree.java.

List<GraphName> org.ros.internal.node.parameter.DefaultParameterTree.getNames ( ) [inline]

Returns:: all known parameter names

Implements org.ros.node.parameter.ParameterTree.

Definition at line 102 of file DefaultParameterTree.java.

String org.ros.internal.node.parameter.DefaultParameterTree.getString ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:: the parameter value:w

Exceptions:

ParameterNotFoundException	if the parameter is not found
ParameterClassCastException	if the parameter is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 274 of file DefaultParameterTree.java.

String org.ros.internal.node.parameter.DefaultParameterTree.getString ( String name ) [inline]

See also:: getString(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 279 of file DefaultParameterTree.java.

String org.ros.internal.node.parameter.DefaultParameterTree.getString	(	GraphName	name,
		String	defaultValue
	)		`[inline]`

Parameters:

name	the parameter name
defaultValue	the default value

Returns:: the parameter value or the default value if the parameter does not exist

Exceptions:

ParameterClassCastException if the parameter exists and is not the expected type

Implements org.ros.node.parameter.ParameterTree.

Definition at line 284 of file DefaultParameterTree.java.

String org.ros.internal.node.parameter.DefaultParameterTree.getString	(	String	name,
		String	defaultValue
	)		`[inline]`

See also:: getString(GraphName, String)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 289 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.has ( GraphName name ) [inline]

Parameters:

name	the parameter name

Returns:

 true

if a parameter with the given name exists,

 false

otherwise

Implements org.ros.node.parameter.ParameterTree.

Definition at line 64 of file DefaultParameterTree.java.

boolean org.ros.internal.node.parameter.DefaultParameterTree.has ( String name ) [inline]

See also:: has(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 70 of file DefaultParameterTree.java.

static DefaultParameterTree org.ros.internal.node.parameter.DefaultParameterTree.newFromNodeIdentifier	(	NodeIdentifier	nodeIdentifier,
		URI	masterUri,
		NameResolver	resolver,
		ParameterManager	parameterManager
	)		`[inline, static]`

Definition at line 50 of file DefaultParameterTree.java.

GraphName org.ros.internal.node.parameter.DefaultParameterTree.search ( GraphName name ) [inline]

Search for parameter key on the Parameter Server. Search starts in caller's namespace and proceeds upwards through parent namespaces until the ParameterServer finds a matching key.

Parameters:

name	the parameter name to search for

Returns:

the name of the found parameter or

 null

if no matching parameter was found

Implements org.ros.node.parameter.ParameterTree.

Definition at line 86 of file DefaultParameterTree.java.

GraphName org.ros.internal.node.parameter.DefaultParameterTree.search ( String name ) [inline]

See also:: search(GraphName)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 97 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		boolean	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 118 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		boolean	value
	)		`[inline]`

See also:: set(GraphName, boolean)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 124 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		int	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 129 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		int	value
	)		`[inline]`

See also:: set(GraphName, int)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 135 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		double	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 140 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		double	value
	)		`[inline]`

See also:: set(GraphName, double)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 146 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		String	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 151 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		String	value
	)		`[inline]`

See also:: set(GraphName, String)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 157 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		List<?>	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 162 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		List<?>	value
	)		`[inline]`

See also:: #set(GraphName, List)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 168 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	GraphName	name,
		Map<?,?>	value
	)		`[inline]`

Parameters:

name	the parameter name
value	the value that the parameter will be set to

Implements org.ros.node.parameter.ParameterTree.

Definition at line 173 of file DefaultParameterTree.java.

void org.ros.internal.node.parameter.DefaultParameterTree.set	(	String	name,
		Map<?,?>	value
	)		`[inline]`

See also:: #set(GraphName, Map)

Implements org.ros.node.parameter.ParameterTree.

Definition at line 179 of file DefaultParameterTree.java.

Member Data Documentation

final ParameterClient org.ros.internal.node.parameter.DefaultParameterTree.parameterClient [private]

Definition at line 46 of file DefaultParameterTree.java.

final ParameterManager org.ros.internal.node.parameter.DefaultParameterTree.parameterManager [private]

Definition at line 47 of file DefaultParameterTree.java.

final NameResolver org.ros.internal.node.parameter.DefaultParameterTree.resolver [private]

Definition at line 48 of file DefaultParameterTree.java.

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

DefaultParameterTree.java

Public Member Functions

Static Public Member Functions

Package Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation