TELEKYB_NAMESPACE::BaseOption Class Reference

#include <BaseOption.hpp>

Inheritance diagram for TELEKYB_NAMESPACE::BaseOption:

List of all members.

Public Member Functions
virtual void	get (YAML::Node &node)=0
std::string	getDescription () const
std::string	getName () const
std::string	getNamespace () const
std::string	getNSName () const
OptionContainer *	getParent () const
virtual bool	hasBounds () const =0
bool	isMandatory () const
bool	isOnInitialValue () const
bool	isReadOnly () const
virtual void	print () const =0
virtual bool	set (const YAML::Node &node)=0
virtual bool	updateFromRawOptions (bool onlyUpdateIntial)=0
virtual	~BaseOption ()
Static Public Attributes
static bool	printOptions = false
Protected Member Functions
	BaseOption (OptionContainer *parent_, const std::string name_, const std::string description_, bool mandatory_, bool readOnly_)
Protected Attributes
std::string	description
bool	initialValue
bool	mandatory
std::string	name
OptionContainer *	parent
bool	readOnly

---

Detailed Description

Definition at line 30 of file BaseOption.hpp.

---

Constructor & Destructor Documentation

TELEKYB_NAMESPACE::BaseOption::BaseOption	(	OptionContainer *	parent_,
		const std::string	name_,
		const std::string	description_,
		bool	mandatory_,
		bool	readOnly_
	)		[protected]

Definition at line 17 of file BaseOption.cpp.

TELEKYB_NAMESPACE::BaseOption::~BaseOption

(

)

[virtual]

Definition at line 28 of file BaseOption.cpp.

---

Member Function Documentation

virtual void TELEKYB_NAMESPACE::BaseOption::get

(

YAML::Node &

node

)

[pure virtual]

Implemented in TELEKYB_NAMESPACE::Option< _T >, TELEKYB_NAMESPACE::Option< double >, TELEKYB_NAMESPACE::Option< std::string >, TELEKYB_NAMESPACE::Option< int >, and TELEKYB_NAMESPACE::Option< bool >.

std::string TELEKYB_NAMESPACE::BaseOption::getDescription

(

)

const

Definition at line 36 of file BaseOption.cpp.

std::string TELEKYB_NAMESPACE::BaseOption::getName

(

)

const

Definition at line 33 of file BaseOption.cpp.

std::string TELEKYB_NAMESPACE::BaseOption::getNamespace

(

)

const

Definition at line 39 of file BaseOption.cpp.

std::string TELEKYB_NAMESPACE::BaseOption::getNSName

(

)

const

Definition at line 42 of file BaseOption.cpp.

OptionContainer * TELEKYB_NAMESPACE::BaseOption::getParent

(

)

const

Definition at line 46 of file BaseOption.cpp.

virtual bool TELEKYB_NAMESPACE::BaseOption::hasBounds

(

)

const [pure virtual]

Implemented in TELEKYB_NAMESPACE::Option< _T >, TELEKYB_NAMESPACE::Option< double >, TELEKYB_NAMESPACE::Option< std::string >, TELEKYB_NAMESPACE::Option< int >, TELEKYB_NAMESPACE::Option< bool >, TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

bool TELEKYB_NAMESPACE::BaseOption::isMandatory

(

)

const

Definition at line 50 of file BaseOption.cpp.

bool TELEKYB_NAMESPACE::BaseOption::isOnInitialValue

(

)

const

Definition at line 56 of file BaseOption.cpp.

bool TELEKYB_NAMESPACE::BaseOption::isReadOnly

(

)

const

Definition at line 53 of file BaseOption.cpp.

virtual void TELEKYB_NAMESPACE::BaseOption::print

(

)

const [pure virtual]

Implemented in TELEKYB_NAMESPACE::Option< _T >, TELEKYB_NAMESPACE::Option< double >, TELEKYB_NAMESPACE::Option< std::string >, TELEKYB_NAMESPACE::Option< int >, TELEKYB_NAMESPACE::Option< bool >, TELEKYB_NAMESPACE::BoundsOption< _T, _Compare >, and TELEKYB_NAMESPACE::BoundsOption< int >.

virtual bool TELEKYB_NAMESPACE::BaseOption::set

(

const YAML::Node &

node

)

[pure virtual]

Implemented in TELEKYB_NAMESPACE::Option< _T >, TELEKYB_NAMESPACE::Option< double >, TELEKYB_NAMESPACE::Option< std::string >, TELEKYB_NAMESPACE::Option< int >, and TELEKYB_NAMESPACE::Option< bool >.

virtual bool TELEKYB_NAMESPACE::BaseOption::updateFromRawOptions

(

bool

onlyUpdateIntial

)

[pure virtual]

Implemented in TELEKYB_NAMESPACE::Option< _T >, TELEKYB_NAMESPACE::Option< double >, TELEKYB_NAMESPACE::Option< std::string >, TELEKYB_NAMESPACE::Option< int >, and TELEKYB_NAMESPACE::Option< bool >.

---

Member Data Documentation

std::string TELEKYB_NAMESPACE::BaseOption::description [protected]

Definition at line 38 of file BaseOption.hpp.

bool TELEKYB_NAMESPACE::BaseOption::initialValue [protected]

Definition at line 44 of file BaseOption.hpp.

bool TELEKYB_NAMESPACE::BaseOption::mandatory [protected]

Definition at line 40 of file BaseOption.hpp.

std::string TELEKYB_NAMESPACE::BaseOption::name [protected]

Definition at line 37 of file BaseOption.hpp.

OptionContainer* TELEKYB_NAMESPACE::BaseOption::parent [protected]

Definition at line 34 of file BaseOption.hpp.

bool TELEKYB_NAMESPACE::BaseOption::printOptions = false [static]

Definition at line 57 of file BaseOption.hpp.

bool TELEKYB_NAMESPACE::BaseOption::readOnly [protected]

Definition at line 41 of file BaseOption.hpp.

---

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

• BaseOption.hpp
• BaseOption.cpp