OptionT< TYPE > Class Template Reference

#include <OptionT.hpp>

Inherits Option.

Public Types
typedef TYPE	value_type
Public Types inherited from Option
typedef boost::function< void() >	TriggerT
	Typedef for trigger functions. More...
typedef Uint	TriggerID
	ID for triggers. More...
typedef std::map< TriggerID, TriggerT >	TriggerStorageT
	Typedef for trigger functions storage. More...

Public Member Functions
	OptionT (const std::string &name, value_type def)
VIRTUAL FUNCTIONS
virtual std::string	value_str () const
virtual std::string	restricted_list_str () const
	Return the restricted list as string. More...
virtual void	set_restricted_list_str (const std::vector< std::string > &list)
	Set the restricted list using a vector of strings. More...
Public Member Functions inherited from Option
	Option (const std::string &name, boost::any def)
virtual	~Option ()
	Desctructor. More...
template<typename TYPE >
TYPE	value () const
	Casts the value to the provided TYPE. More...
template<typename OPTION_TYPE >
OPTION_TYPE &	cast_to ()
template<typename OPTION_TYPE >
const OPTION_TYPE &	cast_to () const
Option &	pretty_name (const std::string &pretty_name)
	Sets the option pretty name. More...
Option &	description (const std::string &description)
	Sets the option description. More...
Option &	separator (const std::string &separator)
	Sets the option operator. The separator is used in some convertions to string to separate items, i.e. the restricted list of values or the option value if it is an array. More...
void	set (XML::XmlNode &node)
	configure this option using the passed xml node More...
Option &	attach_trigger (TriggerT trigger)
TriggerID	attach_trigger_tracked (TriggerT trigger)
	Attach a trigger, returning an ID that can be used to detach again. More...
void	detach_trigger (const TriggerID trigger_id)
	Detach the given trigger. More...
std::string	name () const
std::string	pretty_name () const
std::string	description () const
std::string	separator () const
Option &	operator= (const boost::any &new_value)
template<typename TYPE >
Option &	link_to (TYPE *par)
Option &	link_option (const boost::shared_ptr< common::Option > &linked)
	Link another option to this option. More...
Option &	mark_basic ()
virtual void	change_value (const boost::any &value)
	change the value of this option More...
std::vector< boost::any > &	restricted_list ()
	Gives a reference to the restricted list. More...
const std::vector< boost::any > &	restricted_list () const
	Gives a const reference to the restricted list. More...
virtual bool	has_restricted_list () const
	Checks whether the option has a list of restricted values. More...
void	trigger () const
	Calls the triggers connected to this option. More...
void	restore_default ()
	restore the default value of the option More...
virtual boost::any	value () const
virtual std::string	type () const
virtual std::string	element_type () const
Public Member Functions inherited from TaggedObject
	TaggedObject ()
	Constructor. More...
bool	has_tag (const std::string &tag) const
void	add_tag (const std::string &tag)
std::vector< std::string >	get_tags () const
void	remove_tag (const std::string &tag)

Private Member Functions
virtual void	copy_to_linked_params (std::vector< boost::any > &linked_params)
	copy the configured update value to all linked parameters More...
virtual boost::any	extract_configured_value (XML::XmlNode &node)
virtual void	change_value_impl (const boost::any &value)
	Concrete implementation of the value changing. More...

Additional Inherited Members
Protected Attributes inherited from Option
boost::any	m_value
	storage of the value of the option More...
std::vector< boost::any >	m_linked_params
	parameters that also get updated when option is changed More...
std::vector< Handle< Option > >	m_linked_opts
	options that also get updated when option is changed More...

Detailed Description

template<typename TYPE>
class cf3::common::OptionT< TYPE >

Class defines one option to be used by the ConfigObject class This class supports the following types:

• bool
• int
• std::string
• boost::filesystem::path
• cf3::Uint
• cf3::Real
• cf3::common::URI

  Author

  Tiago Quintino

Definition at line 30 of file OptionT.hpp.

Member Typedef Documentation

typedef TYPE value_type

Definition at line 34 of file OptionT.hpp.

Constructor & Destructor Documentation

OptionT	(	const std::string &	name,
		value_type	def
	)

Definition at line 175 of file OptionT.cpp.

Member Function Documentation

void change_value_impl ( const boost::any &  value )

privatevirtual

Concrete implementation of the value changing.

Implements Option.

Reimplemented in OptionURI.

Definition at line 204 of file OptionT.cpp.

void copy_to_linked_params ( std::vector< boost::any > &  linked_params )

privatevirtual

copy the configured update value to all linked parameters

Implements Option.

Definition at line 181 of file OptionT.cpp.

boost::any extract_configured_value ( XML::XmlNode &  node )

privatevirtual

Get the value to use from XML

Parameters

node	XML node with data for this option

Implements Option.

Definition at line 192 of file OptionT.cpp.

std::string restricted_list_str ( ) const

virtual

Return the restricted list as string.

Implements Option.

Reimplemented in OptionURI.

Definition at line 210 of file OptionT.cpp.

void set_restricted_list_str ( const std::vector< std::string > &  list )

virtual

Set the restricted list using a vector of strings.

Implements Option.

Definition at line 221 of file OptionT.cpp.

std::string value_str ( ) const

virtual

Returns

the value as a std::string

Implements Option.

Definition at line 198 of file OptionT.cpp.

---

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

• cf3/common/OptionT.hpp
• cf3/common/OptionT.cpp