XBot::ConfigOptions Class Reference

#include <ConfigOptions.h>

Collaboration diagram for XBot::ConfigOptions:

Public Member Functions
const std::string &	get_urdf () const
const std::string &	get_srdf () const
const std::string &	get_joint_id_map () const
bool	get_urdf_path (std::string &urdf_path)
	get_urdf_path retrieve the path to the urdf passed More...
bool	get_srdf_path (std::string &srdf_path)
	get_srdf_path retrieve the path to the srdf passed More...
bool	has_config () const
const YAML::Node &	get_config () const
std::string	get_path_to_config () const
template<typename ParameterType >
bool	get_parameter (std::string key, ParameterType &value) const
template<typename ParameterType >
bool	set_parameter (std::string key, const ParameterType &value)
bool	is_same_robot (const ConfigOptions &other) const
bool	set_urdf_path (std::string path_to_urdf)
bool	set_srdf_path (std::string path_to_srdf)
bool	set_jidmap_path (std::string path_to_jidmap)
bool	set_urdf (std::string urdf)
bool	set_srdf (std::string srdf)
bool	set_jidmap (std::string jidmap)
void	make_floating_base (bool fb)
bool	is_floating_base ()
bool	generate_jidmap ()

Static Public Member Functions
static ConfigOptions	FromConfigFile (std::string path_to_config_file)

Protected Attributes
std::string	_urdf
std::string	_srdf
std::string	_jidmap
std::string	_urdf_path
std::string	_srdf_path
YAML::Node	_config
std::string	_path_to_cfg

Member Function Documentation

FromConfigFile()

XBot::ConfigOptions XBot::ConfigOptions::FromConfigFile ( std::string  path_to_config_file )

static

generate_jidmap()

bool XBot::ConfigOptions::generate_jidmap

(

)

get_config()

const YAML::Node & XBot::ConfigOptions::get_config

(

)

const

get_joint_id_map()

const std::string & XBot::ConfigOptions::get_joint_id_map

(

)

const

get_parameter()

template<typename ParameterType >

bool XBot::ConfigOptions::get_parameter ( std::string  key, ParameterType &  value  ) const

inline

get_path_to_config()

std::string XBot::ConfigOptions::get_path_to_config

(

)

const

get_srdf()

const std::string & XBot::ConfigOptions::get_srdf

(

)

const

get_srdf_path()

bool XBot::ConfigOptions::get_srdf_path

(

std::string &

srdf_path

)

get_srdf_path retrieve the path to the srdf passed

Parameters

srdf_path

path to the srdf

Returns

false if the class was initialized using a srdf instead

get_urdf()

const std::string & XBot::ConfigOptions::get_urdf

(

)

const

get_urdf_path()

bool XBot::ConfigOptions::get_urdf_path

(

std::string &

urdf_path

)

get_urdf_path retrieve the path to the urdf passed

Parameters

urdf_path

path to the urdf

Returns

false if the class was initialized using a urdf instead

has_config()

bool XBot::ConfigOptions::has_config

(

)

const

is_floating_base()

bool XBot::ConfigOptions::is_floating_base

(

)

is_same_robot()

bool XBot::ConfigOptions::is_same_robot

(

const ConfigOptions &

other

)

const

make_floating_base()

void XBot::ConfigOptions::make_floating_base

(

bool

fb

)

set_jidmap()

bool XBot::ConfigOptions::set_jidmap

(

std::string

jidmap

)

set_jidmap_path()

bool XBot::ConfigOptions::set_jidmap_path

(

std::string

path_to_jidmap

)

set_parameter()

template<typename ParameterType >

bool XBot::ConfigOptions::set_parameter ( std::string  key, const ParameterType &  value  )

inline

set_srdf()

bool XBot::ConfigOptions::set_srdf

(

std::string

srdf

)

set_srdf_path()

bool XBot::ConfigOptions::set_srdf_path

(

std::string

path_to_srdf

)

set_urdf()

bool XBot::ConfigOptions::set_urdf

(

std::string

urdf

)

set_urdf_path()

bool XBot::ConfigOptions::set_urdf_path

(

std::string

path_to_urdf

)

Member Data Documentation

_config

YAML::Node XBot::ConfigOptions::_config

protected

_jidmap

std::string XBot::ConfigOptions::_jidmap

protected

_path_to_cfg

std::string XBot::ConfigOptions::_path_to_cfg

protected

_srdf

std::string XBot::ConfigOptions::_srdf

protected

_srdf_path

std::string XBot::ConfigOptions::_srdf_path

protected

_urdf

std::string XBot::ConfigOptions::_urdf

protected

_urdf_path

std::string XBot::ConfigOptions::_urdf_path

protected

---

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

• /home/travis/build/ADVRHumanoids/forest_ws/src/XBotInterface/include/XBotInterface/ConfigOptions.h
• /home/travis/build/ADVRHumanoids/forest_ws/src/XBotInterface/src/ConfigOptions.cpp