a string implementation of the parameter. This is used to handle strings of characters of variable length. Like string, each param value can hold up to 2^32-1 characters. More...

#include <dd_string_param.h>

Inheritance diagram for ddynamic_reconfigure::DDString:

[legend]

Public Member Functions
	DDString (const string &name, unsigned int level, const string &description, const string &def)

int	getLevel () const
	fetches the level of the parameter More...

string	getName () const
	gets the name of the parameter, that is, the ID used in the program when requesting it. More...

Value	getValue () const
	gets the value of this parameter. More...

void	prepConfig (Config &conf)
	updates a config message according to this param's info. More...

void	prepConfigDescription (ConfigDescription &conf_desc)
	updates a config description message according to this param's info. More...

void	prepGroup (Group &group)
	updates a group message according to this param's info. More...

bool	sameType (Value val)
	checks whether or not the raw value stored in the value is compatible with the given parameter. Compatible is a very broad word in this scenario. It means that the value can be placed in the parameter regardless of other limitations. More...

bool	sameValue (Value val)
	checks whether or not the value stored in the value object, when converted to the type of the internal value, are equal. This acts regardless of type. More...

void	setValue (Value val)
	sets the value of this parameter as this one. More...

Protected Attributes
string	def_
	the default value (def_), and the current value (val_) More...

string	desc_

unsigned int	level_
	the level of the parameter: the degree in which things need to be shut down if this param changes More...

string	name_
	the name of the parameter (name_), and its description (desc_) More...

string	val_

Detailed Description

a string implementation of the parameter. This is used to handle strings of characters of variable length. Like string, each param value can hold up to 2^32-1 characters.

Definition at line 16 of file dd_string_param.h.

Constructor & Destructor Documentation

ddynamic_reconfigure::DDString::DDString	(	const string &	name,
		unsigned int	level,
		const string &	description,
		const string &	def
	)

inline

creates a new string param

Parameters

name	the name of the parameter
level	the change level
description	details about the parameter
def	the default value

Definition at line 43 of file dd_string_param.h.

Member Function Documentation

int ddynamic_reconfigure::DDString::getLevel ( ) const

virtual

fetches the level of the parameter

Returns: the level of the param.

Implements ddynamic_reconfigure::DDParam.

Definition at line 39 of file dd_string_param.cpp.

string ddynamic_reconfigure::DDString::getName ( ) const

virtual

gets the name of the parameter, that is, the ID used in the program when requesting it.

Returns: the unique string name of the parameter.

Implements ddynamic_reconfigure::DDParam.

Definition at line 8 of file dd_string_param.cpp.

Value ddynamic_reconfigure::DDString::getValue ( ) const

virtual

gets the value of this parameter.

Returns: the value stored in this param.

Implements ddynamic_reconfigure::DDParam.

Definition at line 55 of file dd_string_param.cpp.

void ddynamic_reconfigure::DDString::prepConfig ( Config & conf )

virtual

updates a config message according to this param's info.

Parameters

conf	the group to update.

Note: this is an internal method. It is recommended not to use it.

Implements ddynamic_reconfigure::DDParam.

Definition at line 21 of file dd_string_param.cpp.

void ddynamic_reconfigure::DDString::prepConfigDescription ( ConfigDescription & conf_desc )

virtual

updates a config description message according to this param's info.

Parameters

conf_desc the config description to update.

Note: this is an internal method. It is recommended not to use it.

Implements ddynamic_reconfigure::DDParam.

Definition at line 28 of file dd_string_param.cpp.

void ddynamic_reconfigure::DDString::prepGroup ( Group & group )

virtual

updates a group message according to this param's info.

Parameters

group the group to update.

Note: this is an internal method. It is recommended not to use it.

Implements ddynamic_reconfigure::DDParam.

Definition at line 12 of file dd_string_param.cpp.

bool ddynamic_reconfigure::DDString::sameType ( Value val )

virtual

checks whether or not the raw value stored in the value is compatible with the given parameter. Compatible is a very broad word in this scenario. It means that the value can be placed in the parameter regardless of other limitations.

Parameters

val	the value to test

Returns: true is this parameter can handle the original value, false otherwise.

Implements ddynamic_reconfigure::DDParam.

Definition at line 43 of file dd_string_param.cpp.

bool ddynamic_reconfigure::DDString::sameValue ( Value val )

virtual

checks whether or not the value stored in the value object, when converted to the type of the internal value, are equal. This acts regardless of type.

Parameters

val	the value to test

Returns: true is this parameter can is the same as the original value, false otherwise.

Implements ddynamic_reconfigure::DDParam.

Definition at line 47 of file dd_string_param.cpp.

void ddynamic_reconfigure::DDString::setValue ( Value val )

virtual

sets the value of this parameter as this one.

Parameters

val	the value to use

Implements ddynamic_reconfigure::DDParam.

Definition at line 51 of file dd_string_param.cpp.

Member Data Documentation

string ddynamic_reconfigure::DDString::def_

protected

the default value (def_), and the current value (val_)

Definition at line 60 of file dd_string_param.h.

string ddynamic_reconfigure::DDString::desc_

protected

Definition at line 65 of file dd_string_param.h.

unsigned int ddynamic_reconfigure::DDString::level_

protected

the level of the parameter: the degree in which things need to be shut down if this param changes

Definition at line 55 of file dd_string_param.h.

string ddynamic_reconfigure::DDString::name_

protected

the name of the parameter (name_), and its description (desc_)

Definition at line 65 of file dd_string_param.h.

string ddynamic_reconfigure::DDString::val_

protected

Definition at line 60 of file dd_string_param.h.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation