Public Member Functions | Public Attributes | List of all members
ddynamic_reconfigure::RegisteredParam< T > Class Template Referenceabstract

#include <registered_param.h>

Inheritance diagram for ddynamic_reconfigure::RegisteredParam< T >:
Inheritance graph
[legend]

Public Member Functions

virtual T getCurrentValue () const =0
 
std::string getEditMethod () const
 
virtual dynamic_reconfigure::ParamDescription getParamDescription () const
 
std::string getTypeName () const
 
std::string getValueString (T value) const
 
std::string makeConst (const std::string &name, T value, const std::string &desc) const
 
 RegisteredParam (const std::string &name, const std::string &description, T min_value, T max_value, std::map< std::string, T > enum_dictionary={}, const std::string &enum_description="", const std::string &group="")
 
virtual void updateValue (T new_value)=0
 
virtual ~RegisteredParam ()
 

Public Attributes

const std::string description_
 
const std::string enum_description_
 
const std::map< std::string, T > enum_dictionary_
 
const std::string group_
 
const T max_value_
 
const T min_value_
 
const std::string name_
 

Detailed Description

template<typename T>
class ddynamic_reconfigure::RegisteredParam< T >

Definition at line 42 of file registered_param.h.

Constructor & Destructor Documentation

◆ RegisteredParam()

template<typename T >
ddynamic_reconfigure::RegisteredParam< T >::RegisteredParam ( const std::string &  name,
const std::string &  description,
min_value,
max_value,
std::map< std::string, T >  enum_dictionary = {},
const std::string &  enum_description = "",
const std::string &  group = "" 
)
inline

Definition at line 45 of file registered_param.h.

◆ ~RegisteredParam()

template<typename T >
virtual ddynamic_reconfigure::RegisteredParam< T >::~RegisteredParam ( )
inlinevirtual

Definition at line 58 of file registered_param.h.

Member Function Documentation

◆ getCurrentValue()

template<typename T >
virtual T ddynamic_reconfigure::RegisteredParam< T >::getCurrentValue ( ) const
pure virtual

◆ getEditMethod()

template<typename T >
std::string ddynamic_reconfigure::RegisteredParam< T >::getEditMethod ( ) const
inline

Definition at line 112 of file registered_param.h.

◆ getParamDescription()

template<typename T >
virtual dynamic_reconfigure::ParamDescription ddynamic_reconfigure::RegisteredParam< T >::getParamDescription ( ) const
inlinevirtual

Definition at line 98 of file registered_param.h.

◆ getTypeName()

template<typename T >
std::string ddynamic_reconfigure::RegisteredParam< T >::getTypeName ( ) const
inline

Definition at line 65 of file registered_param.h.

◆ getValueString()

template<typename T >
std::string ddynamic_reconfigure::RegisteredParam< T >::getValueString ( value) const
inline

Definition at line 86 of file registered_param.h.

◆ makeConst()

template<typename T >
std::string ddynamic_reconfigure::RegisteredParam< T >::makeConst ( const std::string &  name,
value,
const std::string &  desc 
) const
inline

Definition at line 134 of file registered_param.h.

◆ updateValue()

template<typename T >
virtual void ddynamic_reconfigure::RegisteredParam< T >::updateValue ( new_value)
pure virtual

Member Data Documentation

◆ description_

template<typename T >
const std::string ddynamic_reconfigure::RegisteredParam< T >::description_

Definition at line 155 of file registered_param.h.

◆ enum_description_

template<typename T >
const std::string ddynamic_reconfigure::RegisteredParam< T >::enum_description_

Definition at line 159 of file registered_param.h.

◆ enum_dictionary_

template<typename T >
const std::map<std::string, T> ddynamic_reconfigure::RegisteredParam< T >::enum_dictionary_

Definition at line 158 of file registered_param.h.

◆ group_

template<typename T >
const std::string ddynamic_reconfigure::RegisteredParam< T >::group_

Definition at line 160 of file registered_param.h.

◆ max_value_

template<typename T >
const T ddynamic_reconfigure::RegisteredParam< T >::max_value_

Definition at line 157 of file registered_param.h.

◆ min_value_

template<typename T >
const T ddynamic_reconfigure::RegisteredParam< T >::min_value_

Definition at line 156 of file registered_param.h.

◆ name_

template<typename T >
const std::string ddynamic_reconfigure::RegisteredParam< T >::name_

Definition at line 154 of file registered_param.h.


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


ddynamic_reconfigure
Author(s): Hilario Tome
autogenerated on Wed Mar 2 2022 00:09:57