TELEKYB_NAMESPACE::OptionContainer Class Reference

#include <OptionContainer.hpp>

Inheritance diagram for TELEKYB_NAMESPACE::OptionContainer:

List of all members.

Public Member Functions
template<class _T , class Compare_ >
BoundsOption< _T, Compare_ > *	addBoundsOption (const std::string name_, const std::string description_, const _T &defaultValue_, const _T &lowerBound_, const _T &upperBound_, bool mandatory_=false, bool readOnly_=false)
template<class _T >
BoundsOption< _T > *	addBoundsOption (const std::string name_, const std::string description_, const _T &defaultValue_, const _T &lowerBound_, const _T &upperBound_, bool mandatory_=false, bool readOnly_=false)
template<class _T >
Option< _T > *	addOption (const std::string name_, const std::string description_, const _T &defaultValue_, bool mandatory_=false, bool readOnly_=false)
void	get (YAML::Node &node)
std::string	getNSPrefixedName (const std::string &name_) const
template<class _T >
Option< _T > *	getOptionByName (const std::string &optionName)
std::string	getOptionContainerNamespace () const
	OptionContainer (const std::string &optionContainerNamespace_)
bool	set (const YAML::Node &node)
void	updateFromRawOptions (bool onlyUpdateIntial=false)
Static Public Member Functions
template<class _T >
static Option< _T > *	getGlobalOptionByName (const std::string &containerName, const std::string &optionName)
Protected Member Functions
virtual	~OptionContainer ()
Protected Attributes
std::string	optionContainerNamespace
OptionsMap	optionsMap
ROSOptionContainer *	rosOptionContainer
Static Protected Attributes
static std::map< std::string, OptionContainer * >	globalContainerMap
Static Private Member Functions
static std::string	getNextOptionContainerNamespace (const std::string &basename)

---

Detailed Description

Definition at line 38 of file OptionContainer.hpp.

---

Constructor & Destructor Documentation

TELEKYB_NAMESPACE::OptionContainer::~OptionContainer

(

)

[protected, virtual]

Definition at line 40 of file OptionContainer.cpp.

TELEKYB_NAMESPACE::OptionContainer::OptionContainer

(

const std::string &

optionContainerNamespace_

)

Definition at line 16 of file OptionContainer.cpp.

---

Member Function Documentation

template<class _T , class Compare_ >

BoundsOption<_T, Compare_>* TELEKYB_NAMESPACE::OptionContainer::addBoundsOption	(	const std::string	name_,
		const std::string	description_,
		const _T &	defaultValue_,
		const _T &	lowerBound_,
		const _T &	upperBound_,
		bool	mandatory_ = false,
		bool	readOnly_ = false
	)		[inline]

Definition at line 104 of file OptionContainer.hpp.

template<class _T >

BoundsOption<_T>* TELEKYB_NAMESPACE::OptionContainer::addBoundsOption	(	const std::string	name_,
		const std::string	description_,
		const _T &	defaultValue_,
		const _T &	lowerBound_,
		const _T &	upperBound_,
		bool	mandatory_ = false,
		bool	readOnly_ = false
	)		[inline]

Definition at line 132 of file OptionContainer.hpp.

template<class _T >

Option<_T>* TELEKYB_NAMESPACE::OptionContainer::addOption	(	const std::string	name_,
		const std::string	description_,
		const _T &	defaultValue_,
		bool	mandatory_ = false,
		bool	readOnly_ = false
	)		[inline]

Definition at line 78 of file OptionContainer.hpp.

void TELEKYB_NAMESPACE::OptionContainer::get

(

YAML::Node &

node

)

Definition at line 100 of file OptionContainer.cpp.

template<class _T >

static Option<_T>* TELEKYB_NAMESPACE::OptionContainer::getGlobalOptionByName	(	const std::string &	containerName,
		const std::string &	optionName
	)		[inline, static]

Definition at line 156 of file OptionContainer.hpp.

std::string TELEKYB_NAMESPACE::OptionContainer::getNextOptionContainerNamespace

(

const std::string &

basename

)

[static, private]

Definition at line 67 of file OptionContainer.cpp.

std::string TELEKYB_NAMESPACE::OptionContainer::getNSPrefixedName

(

const std::string &

name_

)

const

Definition at line 62 of file OptionContainer.cpp.

template<class _T >

Option<_T>* TELEKYB_NAMESPACE::OptionContainer::getOptionByName

(

const std::string &

optionName

)

[inline]

Definition at line 141 of file OptionContainer.hpp.

std::string TELEKYB_NAMESPACE::OptionContainer::getOptionContainerNamespace

(

)

const

Definition at line 57 of file OptionContainer.cpp.

bool TELEKYB_NAMESPACE::OptionContainer::set

(

const YAML::Node &

node

)

Definition at line 111 of file OptionContainer.cpp.

void TELEKYB_NAMESPACE::OptionContainer::updateFromRawOptions

(

bool

onlyUpdateIntial = false

)

Definition at line 91 of file OptionContainer.cpp.

---

Member Data Documentation

std::map< std::string, OptionContainer * > TELEKYB_NAMESPACE::OptionContainer::globalContainerMap [static, protected]

Definition at line 45 of file OptionContainer.hpp.

std::string TELEKYB_NAMESPACE::OptionContainer::optionContainerNamespace [protected]

Definition at line 52 of file OptionContainer.hpp.

OptionsMap TELEKYB_NAMESPACE::OptionContainer::optionsMap [protected]

Definition at line 50 of file OptionContainer.hpp.

ROSOptionContainer* TELEKYB_NAMESPACE::OptionContainer::rosOptionContainer [protected]

Definition at line 55 of file OptionContainer.hpp.

---

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

• OptionContainer.hpp
• OptionContainer.cpp