Functions
rosparam_shortcuts Namespace Reference

Functions

bool convertDoublesToEigen (const std::string &parent_name, std::vector< double > values, Eigen::Affine3d &transform)
 Convert from 6 doubles of [x,y,z] [r,p,y] to a transform.
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, bool &value)
 Get a paremeter from the ROS param server. Note that does not provide for default values.
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &params_name, std::map< std::string, bool > &parameters)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, double &value)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::vector< double > &values)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, int &value)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::size_t &value)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::string &value)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::vector< std::string > &values)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, ros::Duration &value)
bool get (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, Eigen::Affine3d &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getAffine3dParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, Eigen::Affine3d &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getBoolMap (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &params_name, std::map< std::string, bool > &parameters)
ROSPARAM_SHORTCUTS_DEPRECATED bool getBoolParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, bool &value)
std::string getDebugArrayString (std::vector< double > values)
 Output a string of values from an array for debugging.
std::string getDebugArrayString (std::vector< std::string > values)
ROSPARAM_SHORTCUTS_DEPRECATED bool getDoubleParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, double &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getDoubleParams (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::vector< double > &values)
ROSPARAM_SHORTCUTS_DEPRECATED bool getDurationParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, ros::Duration &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getIntParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, int &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getSizeTParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::size_t &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getStringParam (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::string &value)
ROSPARAM_SHORTCUTS_DEPRECATED bool getStringParams (const std::string &parent_name, const ros::NodeHandle &nh, const std::string &param_name, std::vector< std::string > &values)
void shutdownIfError (const std::string &parent_name, std::size_t error_count)
 Check that there were no errors, and if there were, shutdown.
ROSPARAM_SHORTCUTS_DEPRECATED void shutdownIfParamErrors (const std::string &parent_name, std::size_t error_count)

Function Documentation

bool rosparam_shortcuts::convertDoublesToEigen ( const std::string &  parent_name,
std::vector< double >  values,
Eigen::Affine3d &  transform 
)

Convert from 6 doubles of [x,y,z] [r,p,y] to a transform.

Returns:
true on success

Definition at line 256 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
bool &  value 
)

Get a paremeter from the ROS param server. Note that does not provide for default values.

Parameters:
parent_name- the name of the class that is calling this function, used for filtering out logging output by namespacing it
nh- a ROS node handle
param_name- name of parameter to get
value- resulting loaded values, or no change if error (function returns false)
Returns:
true on success

Definition at line 49 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  params_name,
std::map< std::string, bool > &  parameters 
)

Definition at line 64 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
double &  value 
)

Definition at line 87 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::vector< double > &  values 
)

Definition at line 102 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
int &  value 
)

Definition at line 123 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::size_t &  value 
)

Definition at line 138 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::string &  value 
)

Definition at line 155 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::vector< std::string > &  values 
)

Definition at line 170 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
ros::Duration &  value 
)

Definition at line 191 of file rosparam_shortcuts.cpp.

bool rosparam_shortcuts::get ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
Eigen::Affine3d &  value 
)

Definition at line 210 of file rosparam_shortcuts.cpp.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getAffine3dParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
Eigen::Affine3d &  value 
)

Definition at line 162 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getBoolMap ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  params_name,
std::map< std::string, bool > &  parameters 
)

Definition at line 107 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getBoolParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
bool &  value 
)

Definition at line 101 of file rosparam_shortcuts.h.

std::string rosparam_shortcuts::getDebugArrayString ( std::vector< double >  values)

Output a string of values from an array for debugging.

Parameters:
arrayof values
Returns:
string of numbers separated by commas

Definition at line 236 of file rosparam_shortcuts.cpp.

std::string rosparam_shortcuts::getDebugArrayString ( std::vector< std::string >  values)

Definition at line 246 of file rosparam_shortcuts.cpp.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getDoubleParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
double &  value 
)

Definition at line 114 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getDoubleParams ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::vector< double > &  values 
)

Definition at line 121 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getDurationParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
ros::Duration &  value 
)

Definition at line 155 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getIntParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
int &  value 
)

Definition at line 128 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getSizeTParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::size_t &  value 
)

Definition at line 134 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getStringParam ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::string &  value 
)

Definition at line 141 of file rosparam_shortcuts.h.

ROSPARAM_SHORTCUTS_DEPRECATED bool rosparam_shortcuts::getStringParams ( const std::string &  parent_name,
const ros::NodeHandle &  nh,
const std::string &  param_name,
std::vector< std::string > &  values 
)

Definition at line 148 of file rosparam_shortcuts.h.

void rosparam_shortcuts::shutdownIfError ( const std::string &  parent_name,
std::size_t  error_count 
)

Check that there were no errors, and if there were, shutdown.

Parameters:
error- total number of errors found

Definition at line 275 of file rosparam_shortcuts.cpp.

ROSPARAM_SHORTCUTS_DEPRECATED void rosparam_shortcuts::shutdownIfParamErrors ( const std::string &  parent_name,
std::size_t  error_count 
)

Definition at line 190 of file rosparam_shortcuts.h.


rosparam_shortcuts
Author(s): Dave Coleman
autogenerated on Sat Jun 8 2019 19:52:43