Classes | Typedefs | Functions
ddynamic_reconfigure Namespace Reference

Classes

class  DDBool
 a boolean implementation of the parameter. These are used to handle true/false values, or bit quantities if needed. In ROS, booleans are handled as u-bytes (u-int8), so be careful with these! More...
class  DDDouble
 a double implementation of the parameter. This is used to handle double-precision floating point numbers, though it can handle single precision as well. More...
class  DDEnum
 an integer enum implementation of the parameter. This is an extension to the int parameter, which allows creating string aliases for certain (if not all) numbers available. More...
class  DDInt
 an integer implementation of the parameter. This is used to 32 bit signed integral numbers. This can also handle shorts, bytes, and other integrals provided they are not too big (by then looping will occur) More...
class  DDParam
 The DDParam class is the abstraction of all parameter types, and is the template for creating them. At this point, not much is known about the parameter, but the following: More...
class  DDString
 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...
class  DDynamicReconfigure
 The DDynamicReconfigure class is the main class responsible for keeping track of parameters basic properties, values, descriptions, etc. More...
class  InternalClass
class  Value
 The Value class is used to wrap all basic data-types (bool,int,double,string) in something generic. The value object always stores an explicit basic data-type. This has three main uses: More...

Typedefs

typedef numeric_limits< double > d_limit
typedef boost::function< void(const
DDMap &, int)> 
DDFunc
typedef map< string, DDPtrDDMap
typedef boost::shared_ptr
< DDParam
DDPtr
typedef map< string, pair< int,
string > > 
EnumMap

Functions

DDPtr at (const DDMap &map, const char *name)
 a tool people who use this API can use to find the param given within the param map.
void badCallback (const DDMap &, int)
void basicCallback (const DDMap &map, int, bool *flag)
void boolCallback (const DDMap &map, int, bool *flag)
void complexCallback (const DDMap &map, int level)
void defaultCallback (const DDMap &, int)
void doubleCallback (const DDMap &map, int, double *flag)
void enumCallback (const DDMap &map, int, int *flag)
Value get (const DDMap &map, const char *name)
 a tool people who use this API can use to find the value given within the param map.
void intCallback (const DDMap &map, int, int *flag)
void levelCallback (const DDMap &, int level, int *flag)
void missingCallback (const DDMap &map, int)
ostream & operator<< (ostream &os, const DDParam &param)
ostream & operator<< (ostream &os, const DDynamicReconfigure &dd)
void strCallback (const DDMap &map, int, string *flag)
 TEST (DDIntTest, constructorTest)
 preliminary test which makes sure we can use the object.
 TEST (DDStringTest, constructorTest)
 preliminary test which makes sure we can use the object.
 TEST (DDDoubleTest, constructorTest)
 preliminary test which makes sure we can use the object.
 TEST (DDValueTest, intTest)
 a test making sure integer interpretations of value work all around.
 TEST (DDEnumTest, constructorTest)
 preliminary test which makes sure we can use the object.
 TEST (DDBoolTest, constructorTest)
 preliminary test which makes sure we can use the object.
 TEST (DDynamicReconfigureTest, mapTest)
 TEST (DDFullScaleTest, doTest)
 A ROS client making sure the server sends the new information.
 TEST (DDBoolTest, valueTest)
 a test making sure we can handle all API for handling the values of the param
 TEST (DDDoubleTest, valueTest)
 a test making sure we can handle all API for handling the values of the param
 TEST (DDIntTest, valueTest)
 a test making sure we can handle all API for handling the values of the param
 TEST (DDStringTest, valueTest)
 a test making sure we can handle all API for handling the values of the param
 TEST (DDEnumTest, valueTest)
 a test making sure we can handle all API for handling the values of the param
 TEST (DDynamicReconfigureTest, basicCallbackTest)
 preliminary test which makes sure we can use callbacks
 TEST (DDValueTest, doubleTest)
 a test making sure double interpretations of value work all around.
 TEST (DDStringTest, streamTest)
 TEST (DDIntTest, streamTest)
 TEST (DDBoolTest, streamTest)
 TEST (DDDoubleTest, streamTest)
 TEST (DDynamicReconfigureTest, intTest)
 tests that int parameters are registered properly
 TEST (DDEnumTest, streamTest)
 TEST (DDValueTest, boolTest)
 a test making sure boolean interpretations of value work all around.
 TEST (DDynamicReconfigureTest, doubleTest)
 tests that double parameters are registered properly
 TEST (DDValueTest, stringTest)
 a test making sure string interpretations of value work all around.
 TEST (DDynamicReconfigureTest, boolTest)
 tests that boolean parameters are registered properly
 TEST (DDynamicReconfigureTest, stringTest)
 tests that string parameters are registered properly
 TEST (DDynamicReconfigureTest, enumTest)
 tests that int-enum parameters are registered properly
 TEST (DDynamicReconfigureTest, callbackTest)
 tests that ddynamic can handle complex callbacks and param lists.
 TEST (DDynamicReconfigureTest, memberCallbackTest)
 tests that ddynamic can take member methods as callbacks
 TEST (DDynamicReconfigureTest, levelTest)
 tests that ddynamic properly handles param change levels
 TEST (DDynamicReconfigureTest, badCallbackTest)
 tests that ddynamic can properly handle exceptions
 TEST (DDynamicReconfigureTest, unknownParamTest)
 tests that ddynamic can properly handle missing/unregistered parameters
 TEST (DDynamicReconfigureTest, streamTest)
 tests that ddynamic's stream operator properly works

Typedef Documentation

typedef numeric_limits<double> ddynamic_reconfigure::d_limit

Definition at line 12 of file dd_double_param.h.

typedef boost::function<void(const DDMap&,int)> ddynamic_reconfigure::DDFunc

Definition at line 27 of file ddynamic_reconfigure.h.

typedef map<string,DDPtr> ddynamic_reconfigure::DDMap

Definition at line 25 of file ddynamic_reconfigure.h.

typedef boost::shared_ptr<DDParam> ddynamic_reconfigure::DDPtr

Definition at line 17 of file dd_param.h.

typedef map<string,pair<int,string> > ddynamic_reconfigure::EnumMap

Definition at line 12 of file dd_enum_param.h.


Function Documentation

DDPtr ddynamic_reconfigure::at ( const DDMap &  map,
const char *  name 
)

a tool people who use this API can use to find the param given within the param map.

Parameters:
namethe string to look for
mapthe map to search
Returns:
the param with the given name if it exists, nullptr otherwise

Definition at line 202 of file ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::badCallback ( const DDMap &  ,
int   
)

Definition at line 428 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::basicCallback ( const DDMap &  map,
int  ,
bool *  flag 
)

Definition at line 29 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::boolCallback ( const DDMap &  map,
int  ,
bool *  flag 
)

Definition at line 143 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::complexCallback ( const DDMap &  map,
int  level 
)

Definition at line 285 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::defaultCallback ( const DDMap &  ,
int   
)

Definition at line 106 of file ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::doubleCallback ( const DDMap &  map,
int  ,
double *  flag 
)

Definition at line 93 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::enumCallback ( const DDMap &  map,
int  ,
int *  flag 
)

Definition at line 220 of file test_ddynamic_reconfigure.cpp.

Value ddynamic_reconfigure::get ( const DDMap &  map,
const char *  name 
)

a tool people who use this API can use to find the value given within the param map.

Parameters:
namethe string to look for
mapthe map to search
Returns:
the value of param with the given name if it exists, a string value containing "\000" otherwise

Definition at line 209 of file ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::intCallback ( const DDMap &  map,
int  ,
int *  flag 
)

Definition at line 53 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::levelCallback ( const DDMap &  ,
int  level,
int *  flag 
)

Definition at line 379 of file test_ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::missingCallback ( const DDMap &  map,
int   
)

Definition at line 450 of file test_ddynamic_reconfigure.cpp.

ostream& ddynamic_reconfigure::operator<< ( ostream &  os,
const DDParam &  param 
)
Parameters:
osthe stream to place the param into
paramthe param you want to place into the stream
Returns:
os, but with param added.

Definition at line 8 of file dd_param.cpp.

ostream& ddynamic_reconfigure::operator<< ( ostream &  os,
const DDynamicReconfigure &  dd 
)
Parameters:
osthe stream to place the param into
ddthe dd-reconfigure you want to place into the stream
Returns:
os, but with dd-reconfigure added.

Definition at line 193 of file ddynamic_reconfigure.cpp.

void ddynamic_reconfigure::strCallback ( const DDMap &  map,
int  ,
string *  flag 
)

Definition at line 180 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDIntTest  ,
constructorTest   
)

preliminary test which makes sure we can use the object.

Definition at line 10 of file test_dd_int.cpp.

ddynamic_reconfigure::TEST ( DDStringTest  ,
constructorTest   
)

preliminary test which makes sure we can use the object.

Definition at line 10 of file test_dd_string.cpp.

ddynamic_reconfigure::TEST ( DDDoubleTest  ,
constructorTest   
)

preliminary test which makes sure we can use the object.

Definition at line 10 of file test_dd_double.cpp.

ddynamic_reconfigure::TEST ( DDValueTest  ,
intTest   
)

a test making sure integer interpretations of value work all around.

Definition at line 10 of file test_dd_value.cpp.

ddynamic_reconfigure::TEST ( DDEnumTest  ,
constructorTest   
)

preliminary test which makes sure we can use the object.

Definition at line 10 of file test_dd_enum.cpp.

ddynamic_reconfigure::TEST ( DDBoolTest  ,
constructorTest   
)

preliminary test which makes sure we can use the object.

Definition at line 10 of file test_dd_bool.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
mapTest   
)

Definition at line 12 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDFullScaleTest  ,
doTest   
)

A ROS client making sure the server sends the new information.

Definition at line 16 of file dd_client.cpp.

ddynamic_reconfigure::TEST ( DDBoolTest  ,
valueTest   
)

a test making sure we can handle all API for handling the values of the param

Definition at line 19 of file test_dd_bool.cpp.

ddynamic_reconfigure::TEST ( DDDoubleTest  ,
valueTest   
)

a test making sure we can handle all API for handling the values of the param

Definition at line 19 of file test_dd_double.cpp.

ddynamic_reconfigure::TEST ( DDIntTest  ,
valueTest   
)

a test making sure we can handle all API for handling the values of the param

Definition at line 19 of file test_dd_int.cpp.

ddynamic_reconfigure::TEST ( DDStringTest  ,
valueTest   
)

a test making sure we can handle all API for handling the values of the param

Definition at line 19 of file test_dd_string.cpp.

ddynamic_reconfigure::TEST ( DDEnumTest  ,
valueTest   
)

a test making sure we can handle all API for handling the values of the param

Definition at line 23 of file test_dd_enum.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
basicCallbackTest   
)

preliminary test which makes sure we can use callbacks

Definition at line 36 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDValueTest  ,
doubleTest   
)

a test making sure double interpretations of value work all around.

Definition at line 41 of file test_dd_value.cpp.

ddynamic_reconfigure::TEST ( DDStringTest  ,
streamTest   
)

Definition at line 46 of file test_dd_string.cpp.

ddynamic_reconfigure::TEST ( DDIntTest  ,
streamTest   
)

Definition at line 46 of file test_dd_int.cpp.

ddynamic_reconfigure::TEST ( DDBoolTest  ,
streamTest   
)

Definition at line 46 of file test_dd_bool.cpp.

ddynamic_reconfigure::TEST ( DDDoubleTest  ,
streamTest   
)

Definition at line 46 of file test_dd_double.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
intTest   
)

tests that int parameters are registered properly

Definition at line 61 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDEnumTest  ,
streamTest   
)

Definition at line 87 of file test_dd_enum.cpp.

ddynamic_reconfigure::TEST ( DDValueTest  ,
boolTest   
)

a test making sure boolean interpretations of value work all around.

Definition at line 88 of file test_dd_value.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
doubleTest   
)

tests that double parameters are registered properly

Definition at line 101 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDValueTest  ,
stringTest   
)

a test making sure string interpretations of value work all around.

Definition at line 138 of file test_dd_value.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
boolTest   
)

tests that boolean parameters are registered properly

Definition at line 151 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
stringTest   
)

tests that string parameters are registered properly

Definition at line 188 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
enumTest   
)

tests that int-enum parameters are registered properly

Definition at line 228 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
callbackTest   
)

tests that ddynamic can handle complex callbacks and param lists.

Definition at line 297 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
memberCallbackTest   
)

tests that ddynamic can take member methods as callbacks

Definition at line 365 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
levelTest   
)

tests that ddynamic properly handles param change levels

Definition at line 386 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
badCallbackTest   
)

tests that ddynamic can properly handle exceptions

Definition at line 436 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
unknownParamTest   
)

tests that ddynamic can properly handle missing/unregistered parameters

Definition at line 461 of file test_ddynamic_reconfigure.cpp.

ddynamic_reconfigure::TEST ( DDynamicReconfigureTest  ,
streamTest   
)

tests that ddynamic's stream operator properly works

Definition at line 502 of file test_ddynamic_reconfigure.cpp.



ddynamic_reconfigure
Author(s): Noam Dori
autogenerated on Wed May 15 2019 04:39:27