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...
#include <dd_enum_param.h>
Public Member Functions | |
DDEnum (const string &name, unsigned int level, const string &description, int def, const map< string, int > &dictionary) | |
creates a new int-enum param | |
DDEnum (const string &name, unsigned int level, const string &description, const string &def, const map< string, int > &dictionary) | |
creates a new int-enum param | |
DDEnum (const string &name, unsigned int level, const string &description, int def, const pair< map< string, pair< int, string > >, string > &dictionary) | |
creates a new int-enum param | |
DDEnum (const string &name, unsigned int level, const string &description, const string &def, const pair< map< string, pair< int, string > >, string > &dictionary) | |
creates a new int-enum param | |
void | prepGroup (Group &group) |
updates a group message according to this param's info. | |
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. | |
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. | |
void | setValue (Value val) |
sets the value of this parameter as this one. | |
Protected Attributes | |
const EnumMap | dict_ |
A dictionary from the string aliases to their integer counterparts. This method of storage allows integers to have multiple aliases. | |
string | enum_description_ |
this holds the physical enum's description. why is this here? because 1D-reconfigure. | |
Private Member Functions | |
int | lookup (Value val) |
string | makeConst (string name, int value, string desc) |
string | makeEditMethod () |
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.
Definition at line 19 of file dd_enum_param.h.
ddynamic_reconfigure::DDEnum::DDEnum | ( | const string & | name, |
unsigned int | level, | ||
const string & | description, | ||
int | def, | ||
const map< string, int > & | dictionary | ||
) |
creates a new int-enum param
name | the name of the parameter |
level | the change level |
def | the default value in integer form |
description | details about the parameter |
dictionary | the alias dictionary this enum will use. |
Definition at line 64 of file dd_enum_param.cpp.
ddynamic_reconfigure::DDEnum::DDEnum | ( | const string & | name, |
unsigned int | level, | ||
const string & | description, | ||
const string & | def, | ||
const map< string, int > & | dictionary | ||
) |
creates a new int-enum param
name | the name of the parameter |
level | the change level |
def | an alias of the default value |
description | details about the parameter |
dictionary | the alias dictionary this enum will use. |
Definition at line 76 of file dd_enum_param.cpp.
ddynamic_reconfigure::DDEnum::DDEnum | ( | const string & | name, |
unsigned int | level, | ||
const string & | description, | ||
int | def, | ||
const pair< map< string, pair< int, string > >, string > & | dictionary | ||
) |
creates a new int-enum param
name | the name of the parameter |
level | the change level |
def | the default value in integer form |
description | details about the parameter |
dictionary | the alias dictionary this enum will use. |
Definition at line 88 of file dd_enum_param.cpp.
ddynamic_reconfigure::DDEnum::DDEnum | ( | const string & | name, |
unsigned int | level, | ||
const string & | description, | ||
const string & | def, | ||
const pair< map< string, pair< int, string > >, string > & | dictionary | ||
) |
creates a new int-enum param
name | the name of the parameter |
level | the change level |
def | an alias of the default value |
description | details about the parameter |
dictionary | the alias dictionary this enum will use. |
Definition at line 101 of file dd_enum_param.cpp.
int ddynamic_reconfigure::DDEnum::lookup | ( | Value | val | ) | [private] |
converts the value given to an integer according to the embedded dictionary.
val | the value to look up within the dictionary |
Definition at line 56 of file dd_enum_param.cpp.
string ddynamic_reconfigure::DDEnum::makeConst | ( | string | name, |
int | value, | ||
string | desc | ||
) | [private] |
generates a 'const' sting for prepGroup().
name | the name of the constant |
value | the value of the constant |
desc | the description given to the constant. |
Definition at line 133 of file dd_enum_param.cpp.
string ddynamic_reconfigure::DDEnum::makeEditMethod | ( | ) | [private] |
generates the 'edit_method' sting for prepGroup().
Definition at line 114 of file dd_enum_param.cpp.
void ddynamic_reconfigure::DDEnum::prepGroup | ( | Group & | group | ) | [virtual] |
updates a group message according to this param's info.
group | the group to update. |
Reimplemented from ddynamic_reconfigure::DDInt.
Definition at line 26 of file dd_enum_param.cpp.
bool ddynamic_reconfigure::DDEnum::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.
val | the value to test |
Reimplemented from ddynamic_reconfigure::DDInt.
Definition at line 36 of file dd_enum_param.cpp.
bool ddynamic_reconfigure::DDEnum::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.
val | the value to test |
Reimplemented from ddynamic_reconfigure::DDInt.
Definition at line 40 of file dd_enum_param.cpp.
void ddynamic_reconfigure::DDEnum::setValue | ( | Value | val | ) | [virtual] |
sets the value of this parameter as this one.
val | the value to use |
Reimplemented from ddynamic_reconfigure::DDInt.
Definition at line 48 of file dd_enum_param.cpp.
const EnumMap ddynamic_reconfigure::DDEnum::dict_ [protected] |
A dictionary from the string aliases to their integer counterparts. This method of storage allows integers to have multiple aliases.
Definition at line 92 of file dd_enum_param.h.
string ddynamic_reconfigure::DDEnum::enum_description_ [protected] |
this holds the physical enum's description. why is this here? because 1D-reconfigure.
Definition at line 96 of file dd_enum_param.h.