Public Member Functions | Private Member Functions | Private Attributes | List of all members
swri::DynamicParameters Class Reference

#include <dynamic_parameters.h>

Public Member Functions

void addEnums (const std::string &param, const std::vector< std::pair< std::string, int > > &enums)
 
 DynamicParameters ()
 
void finalize (bool alphabetical_order=true)
 
void get (const std::string &name, bool &variable, const bool default_value, const std::string description="None.")
 
void get (const std::string &name, BoolParam &variable, const bool default_value, const std::string description="None.")
 
void get (const std::string &name, double &variable, const double default_value, const std::string description="None.", const double min=-100, const double max=100)
 
void get (const std::string &name, DoubleParam &variable, const double default_value, const std::string description="None.", const double min=-100, const double max=100)
 
void get (const std::string &name, float &variable, const float default_value, const std::string description="None.", const float min=-100, const float max=100)
 
void get (const std::string &name, FloatParam &variable, const float default_value, const std::string description="None.", const float min=-100, const float max=100)
 
void get (const std::string &name, int &variable, const int default_value, const std::string description="None.", const int min=-100, const int max=100)
 
void get (const std::string &name, IntParam &variable, const int default_value, const std::string description="None.", const int min=-100, const int max=100)
 
void get (const std::string &name, std::string &variable, const std::string default_value, const std::string description="None.")
 
void get (const std::string &name, StringParam &variable, const std::string default_value, const std::string description="None.")
 
bool getBool (const std::string &name)
 
double getDouble (const std::string &name)
 
float getFloat (const std::string &name)
 
int getInt (const std::string &name)
 
std::string getString (const std::string &name)
 
void initialize (ros::NodeHandle &pnh)
 
void initialize (swri::NodeHandle &pnh)
 
boost::mutex::scoped_lock lock_guard ()
 
boost::mutex & mutex ()
 
void setCallback (boost::function< void(DynamicParameters &)> fun)
 
void update ()
 

Private Member Functions

bool setConfigCallback (dynamic_reconfigure::Reconfigure::Request &req, dynamic_reconfigure::Reconfigure::Response &rsp)
 
void updateCurrent (dynamic_reconfigure::Config &config)
 

Private Attributes

ros::Publisher descr_pub_
 
boost::shared_ptr< boost::mutex > mutex_
 
boost::shared_ptr< ros::NodeHandlenh_
 
boost::function< void(DynamicParameters &)> on_change_
 
std::vector< std::string > ordered_params_
 
ros::ServiceServer set_service_
 
swri::NodeHandle snh_
 
ros::Publisher update_pub_
 
std::map< std::string, DynamicValuevalues_
 

Detailed Description

Definition at line 125 of file dynamic_parameters.h.

Constructor & Destructor Documentation

◆ DynamicParameters()

swri::DynamicParameters::DynamicParameters ( )
inline

Definition at line 298 of file dynamic_parameters.h.

Member Function Documentation

◆ addEnums()

void swri::DynamicParameters::addEnums ( const std::string &  param,
const std::vector< std::pair< std::string, int > > &  enums 
)
inline

Definition at line 474 of file dynamic_parameters.h.

◆ finalize()

void swri::DynamicParameters::finalize ( bool  alphabetical_order = true)
inline

Definition at line 323 of file dynamic_parameters.h.

◆ get() [1/10]

void swri::DynamicParameters::get ( const std::string &  name,
bool &  variable,
const bool  default_value,
const std::string  description = "None." 
)
inline

Definition at line 789 of file dynamic_parameters.h.

◆ get() [2/10]

void swri::DynamicParameters::get ( const std::string &  name,
BoolParam variable,
const bool  default_value,
const std::string  description = "None." 
)
inline

Definition at line 815 of file dynamic_parameters.h.

◆ get() [3/10]

void swri::DynamicParameters::get ( const std::string &  name,
double &  variable,
const double  default_value,
const std::string  description = "None.",
const double  min = -100,
const double  max = 100 
)
inline

Definition at line 664 of file dynamic_parameters.h.

◆ get() [4/10]

void swri::DynamicParameters::get ( const std::string &  name,
DoubleParam variable,
const double  default_value,
const std::string  description = "None.",
const double  min = -100,
const double  max = 100 
)
inline

Definition at line 694 of file dynamic_parameters.h.

◆ get() [5/10]

void swri::DynamicParameters::get ( const std::string &  name,
float &  variable,
const float  default_value,
const std::string  description = "None.",
const float  min = -100,
const float  max = 100 
)
inline

Definition at line 601 of file dynamic_parameters.h.

◆ get() [6/10]

void swri::DynamicParameters::get ( const std::string &  name,
FloatParam variable,
const float  default_value,
const std::string  description = "None.",
const float  min = -100,
const float  max = 100 
)
inline

Definition at line 631 of file dynamic_parameters.h.

◆ get() [7/10]

void swri::DynamicParameters::get ( const std::string &  name,
int &  variable,
const int  default_value,
const std::string  description = "None.",
const int  min = -100,
const int  max = 100 
)
inline

Definition at line 726 of file dynamic_parameters.h.

◆ get() [8/10]

void swri::DynamicParameters::get ( const std::string &  name,
IntParam variable,
const int  default_value,
const std::string  description = "None.",
const int  min = -100,
const int  max = 100 
)
inline

Definition at line 756 of file dynamic_parameters.h.

◆ get() [9/10]

void swri::DynamicParameters::get ( const std::string &  name,
std::string &  variable,
const std::string  default_value,
const std::string  description = "None." 
)
inline

Definition at line 844 of file dynamic_parameters.h.

◆ get() [10/10]

void swri::DynamicParameters::get ( const std::string &  name,
StringParam variable,
const std::string  default_value,
const std::string  description = "None." 
)
inline

Definition at line 870 of file dynamic_parameters.h.

◆ getBool()

bool swri::DynamicParameters::getBool ( const std::string &  name)
inline

Definition at line 551 of file dynamic_parameters.h.

◆ getDouble()

double swri::DynamicParameters::getDouble ( const std::string &  name)
inline

Definition at line 498 of file dynamic_parameters.h.

◆ getFloat()

float swri::DynamicParameters::getFloat ( const std::string &  name)
inline

Definition at line 516 of file dynamic_parameters.h.

◆ getInt()

int swri::DynamicParameters::getInt ( const std::string &  name)
inline

Definition at line 533 of file dynamic_parameters.h.

◆ getString()

std::string swri::DynamicParameters::getString ( const std::string &  name)
inline

Definition at line 569 of file dynamic_parameters.h.

◆ initialize() [1/2]

void swri::DynamicParameters::initialize ( ros::NodeHandle pnh)
inline

Definition at line 304 of file dynamic_parameters.h.

◆ initialize() [2/2]

void swri::DynamicParameters::initialize ( swri::NodeHandle pnh)
inline

Definition at line 313 of file dynamic_parameters.h.

◆ lock_guard()

boost::mutex::scoped_lock swri::DynamicParameters::lock_guard ( )
inline

Definition at line 594 of file dynamic_parameters.h.

◆ mutex()

boost::mutex& swri::DynamicParameters::mutex ( )
inline

Definition at line 588 of file dynamic_parameters.h.

◆ setCallback()

void swri::DynamicParameters::setCallback ( boost::function< void(DynamicParameters &)>  fun)
inline

Definition at line 486 of file dynamic_parameters.h.

◆ setConfigCallback()

bool swri::DynamicParameters::setConfigCallback ( dynamic_reconfigure::Reconfigure::Request &  req,
dynamic_reconfigure::Reconfigure::Response &  rsp 
)
inlineprivate

Definition at line 143 of file dynamic_parameters.h.

◆ update()

void swri::DynamicParameters::update ( )
inline

Definition at line 491 of file dynamic_parameters.h.

◆ updateCurrent()

void swri::DynamicParameters::updateCurrent ( dynamic_reconfigure::Config &  config)
inlineprivate

Definition at line 246 of file dynamic_parameters.h.

Member Data Documentation

◆ descr_pub_

ros::Publisher swri::DynamicParameters::descr_pub_
private

Definition at line 127 of file dynamic_parameters.h.

◆ mutex_

boost::shared_ptr<boost::mutex> swri::DynamicParameters::mutex_
private

Definition at line 141 of file dynamic_parameters.h.

◆ nh_

boost::shared_ptr<ros::NodeHandle> swri::DynamicParameters::nh_
private

Definition at line 130 of file dynamic_parameters.h.

◆ on_change_

boost::function<void(DynamicParameters&)> swri::DynamicParameters::on_change_
private

Definition at line 138 of file dynamic_parameters.h.

◆ ordered_params_

std::vector<std::string> swri::DynamicParameters::ordered_params_
private

Definition at line 136 of file dynamic_parameters.h.

◆ set_service_

ros::ServiceServer swri::DynamicParameters::set_service_
private

Definition at line 129 of file dynamic_parameters.h.

◆ snh_

swri::NodeHandle swri::DynamicParameters::snh_
private

Definition at line 131 of file dynamic_parameters.h.

◆ update_pub_

ros::Publisher swri::DynamicParameters::update_pub_
private

Definition at line 128 of file dynamic_parameters.h.

◆ values_

std::map<std::string, DynamicValue> swri::DynamicParameters::values_
private

Definition at line 133 of file dynamic_parameters.h.


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


swri_roscpp
Author(s): P. J. Reed
autogenerated on Fri Aug 2 2024 08:39:15