#include <OptionComponent.hpp>

Inherits Option.

Classes
struct	ValueExtractor
	MPL functor to extract a value from an any. More...

Public Types
typedef Handle< T >	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
	OptionComponent (const std::string &name, const Handle< T > linked_component)

virtual	~OptionComponent ()

virtual std::string	value_str () const

virtual boost::any	value () const
	The returned value contains a Component handle, useful for dynamic use in i.e. Python. More...

template<typename OutputT >
OutputT	value () const
	Redirect form the base class due to conflict with the non-template. More...

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...

virtual std::string	type () const

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 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	change_value_impl (const boost::any &value)
	Concrete implementation of the value changing. More...

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

virtual void	copy_to_linked_params (std::vector< boost::any > &linked_params)
	copy the configured update value to all linked parameters 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 T = Component>
class cf3::common::OptionComponent< T >

Definition at line 39 of file OptionComponent.hpp.

Member Typedef Documentation

typedef Handle<T> value_type

Definition at line 43 of file OptionComponent.hpp.

Constructor & Destructor Documentation

OptionComponent	(	const std::string &	name,
		const Handle< T >	linked_component
	)

inline

Definition at line 45 of file OptionComponent.hpp.

virtual ~OptionComponent ( )

inlinevirtual

Definition at line 50 of file OptionComponent.hpp.

Member Function Documentation

virtual void change_value_impl ( const boost::any & value )

inlineprivatevirtual

Concrete implementation of the value changing.

Implements Option.

Definition at line 110 of file OptionComponent.hpp.

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

inlineprivatevirtual

copy the configured update value to all linked parameters

Implements Option.

Definition at line 154 of file OptionComponent.hpp.

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

inlineprivatevirtual

updates the option value using the xml configuration

Parameters

node	XML node with data for this option

Implements Option.

Definition at line 133 of file OptionComponent.hpp.

virtual std::string restricted_list_str ( ) const

inlinevirtual

Return the restricted list as string.

Implements Option.

Definition at line 78 of file OptionComponent.hpp.

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

inlinevirtual

Set the restricted list using a vector of strings.

Implements Option.

Definition at line 92 of file OptionComponent.hpp.

virtual std::string type ( ) const

inlinevirtual

Returns: the type of the option as a string

Reimplemented from Option.

Definition at line 103 of file OptionComponent.hpp.

virtual boost::any value ( ) const

inlinevirtual

The returned value contains a Component handle, useful for dynamic use in i.e. Python.

Reimplemented from Option.

Definition at line 63 of file OptionComponent.hpp.

OutputT value ( ) const

inlinevirtual

Redirect form the base class due to conflict with the non-template.

Reimplemented from Option.

Definition at line 73 of file OptionComponent.hpp.

virtual std::string value_str ( ) const

inlinevirtual

Returns: the value as a std::string

Implements Option.

Definition at line 53 of file OptionComponent.hpp.

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

cf3/common/OptionComponent.hpp

Classes

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<typename T = Component> class cf3::common::OptionComponent< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename T = Component>
class cf3::common::OptionComponent< T >