Inheritance diagram for org.ros.node.parameter.ParameterTree:

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)
Collection< 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)

Detailed Description

Provides access to a ParameterServer.

A parameter server is a shared, multi-variate dictionary that is accessible via network APIs. Nodes use this server to store and retrieve parameters at runtime. As it is not designed for high-performance, it is best used for static, non-binary data such as configuration parameters. It is meant to be globally viewable so that tools can easily inspect the configuration state of the system and modify if necessary.

See also:: Parameter server documentation

Author:: damonkohler@google.com (Damon Kohler)

Definition at line 44 of file ParameterTree.java.

Member Function Documentation

void org.ros.node.parameter.ParameterTree.addParameterListener	(	GraphName	name,
		ParameterListener	listener
	)

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.addParameterListener	(	String	name,
		ParameterListener	listener
	)

See also:: addParameterListener(GraphName, ParameterListener)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.delete ( GraphName name )

Deletes a specified parameter.

Parameters:

name	the parameter name

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.delete ( String name )

See also:: delete(GraphName)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

boolean org.ros.node.parameter.ParameterTree.getBoolean ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

boolean org.ros.node.parameter.ParameterTree.getBoolean ( String name )

See also:: getBoolean(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

boolean org.ros.node.parameter.ParameterTree.getBoolean	(	GraphName	name,
		boolean	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

boolean org.ros.node.parameter.ParameterTree.getBoolean	(	String	name,
		boolean	defaultValue
	)

See also:: getBoolean(GraphName, boolean)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

double org.ros.node.parameter.ParameterTree.getDouble ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

double org.ros.node.parameter.ParameterTree.getDouble ( String name )

See also:: getDouble(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

double org.ros.node.parameter.ParameterTree.getDouble	(	GraphName	name,
		double	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

double org.ros.node.parameter.ParameterTree.getDouble	(	String	name,
		double	defaultValue
	)

See also:: getDouble(GraphName, double)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

int org.ros.node.parameter.ParameterTree.getInteger ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

int org.ros.node.parameter.ParameterTree.getInteger ( String name )

See also:: getInteger(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

int org.ros.node.parameter.ParameterTree.getInteger	(	GraphName	name,
		int	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

int org.ros.node.parameter.ParameterTree.getInteger	(	String	name,
		int	defaultValue
	)

See also:: getInteger(GraphName, int)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

List<?> org.ros.node.parameter.ParameterTree.getList ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

List<?> org.ros.node.parameter.ParameterTree.getList ( String name )

See also:: getList(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

List<?> org.ros.node.parameter.ParameterTree.getList	(	GraphName	name,
		List<?>	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

List<?> org.ros.node.parameter.ParameterTree.getList	(	String	name,
		List<?>	defaultValue
	)

See also:: #getList(GraphName, List)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

Map<?, ?> org.ros.node.parameter.ParameterTree.getMap ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

Map<?, ?> org.ros.node.parameter.ParameterTree.getMap ( String name )

See also:: getMap(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

Map<?, ?> org.ros.node.parameter.ParameterTree.getMap	(	GraphName	name,
		Map<?,?>	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

Map<?, ?> org.ros.node.parameter.ParameterTree.getMap	(	String	name,
		Map<?,?>	defaultValue
	)

See also:: #getMap(GraphName, Map)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

Collection<GraphName> org.ros.node.parameter.ParameterTree.getNames ( )

Returns:: all known parameter names

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

String org.ros.node.parameter.ParameterTree.getString ( GraphName name )

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

String org.ros.node.parameter.ParameterTree.getString ( String name )

See also:: getString(GraphName)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

String org.ros.node.parameter.ParameterTree.getString	(	GraphName	name,
		String	defaultValue
	)

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

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

String org.ros.node.parameter.ParameterTree.getString	(	String	name,
		String	defaultValue
	)

See also:: getString(GraphName, String)

Implemented in org.ros.internal.node.parameter.DefaultParameterTree, and org.ros.node.AnonymousParmeterTree.

boolean org.ros.node.parameter.ParameterTree.has ( GraphName name )

Parameters:

name	the parameter name

Returns:

 true

if a parameter with the given name exists,

 false

otherwise

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

boolean org.ros.node.parameter.ParameterTree.has ( String name )

See also:: has(GraphName)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

GraphName org.ros.node.parameter.ParameterTree.search ( GraphName name )

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

GraphName org.ros.node.parameter.ParameterTree.search ( String name )

See also:: search(GraphName)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		boolean	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		boolean	value
	)

See also:: set(GraphName, boolean)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		int	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		int	value
	)

See also:: set(GraphName, int)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		double	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		double	value
	)

See also:: set(GraphName, double)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		String	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		String	value
	)

See also:: set(GraphName, String)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		List<?>	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		List<?>	value
	)

See also:: #set(GraphName, List)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	GraphName	name,
		Map<?,?>	value
	)

Parameters:

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

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

void org.ros.node.parameter.ParameterTree.set	(	String	name,
		Map<?,?>	value
	)

See also:: #set(GraphName, Map)

Implemented in org.ros.node.AnonymousParmeterTree, and org.ros.internal.node.parameter.DefaultParameterTree.

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

ParameterTree.java

Public Member Functions

Detailed Description

Member Function Documentation