TELEKYB_NAMESPACE::Option< _T > Class Template Reference

#include <Option.hpp>

Inheritance diagram for TELEKYB_NAMESPACE::Option< _T >:

List of all members.

Public Member Functions
virtual void	get (YAML::Node &node)
std::set< OptionListener< _T > * > &	getListenerSet ()
_T	getValue () const
virtual bool	hasBounds () const
virtual bool	isWithinBounds (const _T &value_) const
virtual void	print () const
void	registerOptionListener (OptionListener< _T > *optionListener)
virtual bool	set (const YAML::Node &node)
void	setValue (const _T &value_)
virtual bool	setValueCheck (const _T &value_)
void	unRegisterOptionListener (OptionListener< _T > *optionListener)
bool	updateFromRawOptions (bool onlyUpdateIntial)
virtual	~Option ()
Protected Member Functions
void	notifyDidChange () const
void	notifyShouldDelete () const
	Option (OptionContainer *parent_, const std::string name_, const std::string description_, const _T &defaultValue_, bool mandatory_=false, bool readOnly_=false)
Protected Attributes
std::set< OptionListener< _T > * >	listenerSet
ROSOption< _T > *	rosOption
_T	value
boost::mutex	valueMutex
Friends
class	OptionContainer

---

Detailed Description

template<class _T>
class TELEKYB_NAMESPACE::Option< _T >

Definition at line 41 of file Option.hpp.

---

Constructor & Destructor Documentation

template<class _T>

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

Definition at line 66 of file Option.hpp.

template<class _T>

virtual TELEKYB_NAMESPACE::Option< _T >::~Option

(

)

[inline, virtual]

Definition at line 93 of file Option.hpp.

---

Member Function Documentation

template<class _T>

virtual void TELEKYB_NAMESPACE::Option< _T >::get

(

YAML::Node &

node

)

[inline, virtual]

Implements TELEKYB_NAMESPACE::BaseOption.

Definition at line 142 of file Option.hpp.

template<class _T>

std::set<OptionListener<_T>*>& TELEKYB_NAMESPACE::Option< _T >::getListenerSet

(

)

[inline]

Definition at line 183 of file Option.hpp.

template<class _T>

_T TELEKYB_NAMESPACE::Option< _T >::getValue

(

)

const [inline]

Definition at line 126 of file Option.hpp.

template<class _T>

virtual bool TELEKYB_NAMESPACE::Option< _T >::hasBounds

(

)

const [inline, virtual]

Implements TELEKYB_NAMESPACE::BaseOption.

Reimplemented in TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

Definition at line 165 of file Option.hpp.

template<class _T>

virtual bool TELEKYB_NAMESPACE::Option< _T >::isWithinBounds

(

const _T &

value_

)

const [inline, virtual]

Reimplemented in TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

Definition at line 169 of file Option.hpp.

template<class _T>

void TELEKYB_NAMESPACE::Option< _T >::notifyDidChange

(

)

const [inline, protected]

Definition at line 53 of file Option.hpp.

template<class _T>

void TELEKYB_NAMESPACE::Option< _T >::notifyShouldDelete

(

)

const [inline, protected]

Definition at line 59 of file Option.hpp.

template<class _T>

virtual void TELEKYB_NAMESPACE::Option< _T >::print

(

)

const [inline, virtual]

Implements TELEKYB_NAMESPACE::BaseOption.

Reimplemented in TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

Definition at line 157 of file Option.hpp.

template<class _T>

void TELEKYB_NAMESPACE::Option< _T >::registerOptionListener

(

OptionListener< _T > *

optionListener

)

[inline]

Definition at line 174 of file Option.hpp.

template<class _T>

virtual bool TELEKYB_NAMESPACE::Option< _T >::set

(

const YAML::Node &

node

)

[inline, virtual]

Implements TELEKYB_NAMESPACE::BaseOption.

Definition at line 146 of file Option.hpp.

template<class _T>

void TELEKYB_NAMESPACE::Option< _T >::setValue

(

const _T &

value_

)

[inline]

Definition at line 113 of file Option.hpp.

template<class _T>

virtual bool TELEKYB_NAMESPACE::Option< _T >::setValueCheck

(

const _T &

value_

)

[inline, virtual]

Reimplemented in TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

Definition at line 104 of file Option.hpp.

template<class _T>

void TELEKYB_NAMESPACE::Option< _T >::unRegisterOptionListener

(

OptionListener< _T > *

optionListener

)

[inline]

Definition at line 178 of file Option.hpp.

template<class _T>

bool TELEKYB_NAMESPACE::Option< _T >::updateFromRawOptions

(

bool

onlyUpdateIntial

)

[inline, virtual]

Implements TELEKYB_NAMESPACE::BaseOption.

Definition at line 131 of file Option.hpp.

---

Friends And Related Function Documentation

template<class _T>

friend class OptionContainer [friend]

Reimplemented in TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

Definition at line 90 of file Option.hpp.

---

Member Data Documentation

template<class _T>

std::set<OptionListener<_T>*> TELEKYB_NAMESPACE::Option< _T >::listenerSet [protected]

Definition at line 50 of file Option.hpp.

template<class _T>

ROSOption<_T>* TELEKYB_NAMESPACE::Option< _T >::rosOption [protected]

Definition at line 47 of file Option.hpp.

template<class _T>

_T TELEKYB_NAMESPACE::Option< _T >::value [protected]

Definition at line 44 of file Option.hpp.

template<class _T>

boost::mutex TELEKYB_NAMESPACE::Option< _T >::valueMutex [mutable, protected]

Definition at line 45 of file Option.hpp.

---

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

• Option.hpp