ParameterHandler
A library that handles parameters at runtime.
parameter_handler_std::ParameterHandlerStd Class Reference

#include <ParameterHandlerStd.hpp>

Inheritance diagram for parameter_handler_std::ParameterHandlerStd:
Inheritance graph

Public Types

typedef std::unordered_map< std::string, parameter_handler::ParameterInterfaceParameterList
 

Public Member Functions

 ParameterHandlerStd ()
 
virtual ~ParameterHandlerStd ()
 
virtual bool addParam (const std::string &name, parameter_handler::ParameterInterface &param, bool verbose=false)
 
virtual bool addParam (parameter_handler::ParameterInterface &param, bool verbose=false)
 
virtual bool getParam (const std::string &name, parameter_handler::ParameterInterface &param)
 
virtual void parameterChanged (const parameter_handler::ParameterInterface &param)
 Notify observer of a parameter change. More...
 
- Public Member Functions inherited from parameter_handler::ParameterHandlerBase
 ParameterHandlerBase ()
 
virtual ~ParameterHandlerBase ()
 
virtual bool cleanup ()
 
- Public Member Functions inherited from parameter_handler::ParameterObserverInterface
 ParameterObserverInterface ()=default
 Default Constructor. More...
 
virtual ~ParameterObserverInterface ()=default
 Default Destructor. More...
 

Protected Attributes

ParameterList params_
 
std::mutex mutexParams_
 

Member Typedef Documentation

Constructor & Destructor Documentation

parameter_handler_std::ParameterHandlerStd::ParameterHandlerStd ( )
virtual parameter_handler_std::ParameterHandlerStd::~ParameterHandlerStd ( )
virtual

Member Function Documentation

virtual bool parameter_handler_std::ParameterHandlerStd::addParam ( const std::string &  name,
parameter_handler::ParameterInterface param,
bool  verbose = false 
)
inlinevirtual
virtual bool parameter_handler_std::ParameterHandlerStd::addParam ( parameter_handler::ParameterInterface param,
bool  verbose = false 
)
inlinevirtual
virtual bool parameter_handler_std::ParameterHandlerStd::getParam ( const std::string &  name,
parameter_handler::ParameterInterface param 
)
inlinevirtual
virtual void parameter_handler_std::ParameterHandlerStd::parameterChanged ( const parameter_handler::ParameterInterface param)
inlinevirtual

Notify observer of a parameter change.

Parameters
paramParameter that changed

Reimplemented from parameter_handler::ParameterHandlerBase.

Reimplemented in parameter_handler_ros::ParameterHandlerRos.

Member Data Documentation

std::mutex parameter_handler_std::ParameterHandlerStd::mutexParams_
protected
ParameterList parameter_handler_std::ParameterHandlerStd::params_
protected

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