BuilderT< BASE, CONCRETE > Class Template Reference

Component that builds other components of a given abstract type This is the actual builder for one concrete type. More...

#include <Builder.hpp>

Inherits Builder.

Public Member Functions
	BuilderT (const std::string &name)
	Contructor. More...
virtual	~BuilderT ()
	Virtual destructor. More...
boost::shared_ptr< BASE >	create_component_typed (const std::string &name) const
	builds the component cast to the correct base More...
virtual std::string	builder_abstract_type_name () const
virtual std::string	builder_concrete_type_name () const
virtual boost::shared_ptr< Component >	build (const std::string &name) const
Public Member Functions inherited from Builder
	Builder (const std::string &name)
	Contructor. More...
virtual	~Builder ()
	Virtual destructor. More...
void	signal_create_component (SignalArgs &args)
	creates a component from this component More...
void	signature_signal_create_component (SignalArgs &args)
Public Member Functions inherited from Component
	Component (const std::string &name)
virtual	~Component ()
	Virtual destructor. More...
const std::string &	name () const
	Access the name of the component. More...
void	rename (const std::string &name)
	Rename the component. More...
URI	uri () const
	Construct the full path. More...
void	complete_path (URI &path) const
Handle< Component >	access_component (const URI &path) const
Handle< Component >	access_component_checked (const URI &path)
Handle< Component const >	access_component_checked (const URI &path) const
Handle< Component >	handle ()
	Get a handle to the component. More...
Handle< Component const >	handle () const
template<typename ComponentT >
Handle< ComponentT >	handle ()
template<typename ComponentT >
Handle< ComponentT const >	handle () const
Handle< Component >	parent () const
Handle< Component const >	root () const
Handle< Component >	root ()
Handle< Component >	get_child (const std::string &name)
Handle< Component const >	get_child (const std::string &name) const
Handle< Component >	get_child_checked (const std::string &name)
Handle< Component const >	get_child_checked (const std::string &name) const
Handle< Component >	create_component (const std::string &name, const std::string &builder)
	Build a (sub)component of this component using the extended type_name of the component. More...
template<typename T >
Handle< T >	create_component (const std::string &name)
	Create a (sub)component of this component automatically cast to the specified type. More...
template<typename T >
Handle< T >	create_static_component (const std::string &name)
	Create a static "always there" subcomponent. More...
Component &	add_component (const boost::shared_ptr< Component > &subcomp)
	Add the passed component as a subcomponent. More...
void	add_link (Component &linked_component)
boost::shared_ptr< Component >	remove_component (const std::string &name)
	Remove a (sub)component of this component. More...
boost::shared_ptr< Component >	remove_component (Component &subcomp)
	Remove a (sub)component of this component. More...
void	clear ()
	Remove all sub-components of this component, except for the static ones. More...
void	move_to (Component &to_parent)
std::string	tree (bool basic_mode=false, Uint depth=0, Uint recursion_level=0) const
std::string	info (const std::string &what=std::string("cospt")) const
size_t	count_children () const
virtual std::string	derived_type_name () const =0
PropertyList &	properties ()
const PropertyList &	properties () const
OptionList &	options ()
const OptionList &	options () const
void	reset_options ()
	Reset all options to their default value. More...
void	configure_option_recursively (const std::string &optname, const boost::any &val)
Component &	mark_basic ()
	marks this component as basic. More...
template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT > > &vec, const bool recurse)
template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT const > > &vec, const bool recurse) const
template<>
void	put_components (std::vector< boost::shared_ptr< Component > > &vec, const bool recurse)
template<>
void	put_components (std::vector< boost::shared_ptr< Component const > > &vec, const bool recurse) const
Component::iterator	begin ()
	The begin iterator for a range containing Components. More...
Component::iterator	end ()
	The end iterator for a range containing Components. More...
Component::const_iterator	begin () const
	The begin iterator for a range containing Components (const version) More...
Component::const_iterator	end () const
	The end iterator for a range containing Components (const version) More...
Component::iterator	recursive_begin ()
	The begin iterator for a recursive range containing Components. More...
Component::iterator	recursive_end ()
	The end iterator for a recursive range containing Components. More...
Component::const_iterator	recursive_begin () const
	The begin iterator for a recursive range containing Components (const version) More...
Component::const_iterator	recursive_end () const
	The end iterator for a recursive range containing Components (const version) More...
template<typename T >
Handle< T >	create_component (const std::string &name, const std::string &builder)
	Create a component using the reduced builder name. More...
void	signal_configure (SignalArgs &args)
	configures all the options on this class More...
void	signal_create_component (SignalArgs &args)
	creates a component from this component More...
void	signal_delete_component (SignalArgs &args)
	delete this component More...
void	signal_move_component (SignalArgs &args)
	moves a component from this component to another More...
void	signal_list_tree (SignalArgs &args) const
	lists the sub components and puts them on the xml_tree More...
void	signal_list_tree_recursive (SignalArgs &args) const
	prints tree recursively More...
void	signal_list_properties (SignalArgs &args) const
	lists the properties of this component More...
void	signal_list_options (SignalArgs &args) const
	lists the properties of this component More...
void	signal_list_options_recursive (SignalArgs &args) const
	prints all options recursive More...
void	signal_list_signals (SignalArgs &args) const
	lists the signals of this component More...
void	signal_list_signals_recursive (SignalArgs &args) const
	prints all signals recursive More...
void	signal_print_info (SignalArgs &args) const
	gets info on this component More...
void	signal_print_tree (SignalArgs &args) const
	signal to print the tree More...
void	signature_print_tree (SignalArgs &args) const
	signature to signal_print_tree More...
void	signal_rename_component (SignalArgs &args)
	renames this component More...
void	signal_save_tree (SignalArgs &args)
	dumps the tree to a file More...
void	signal_list_content (SignalArgs &args)
	gives information about this component such as options, signals, ... More...
void	signal_signature (SignalArgs &args)
	Gives a signal signature, if any. More...
void	signature_create_component (SignalArgs &args)
void	signature_rename_component (SignalArgs &args)
void	signature_move_component (SignalArgs &args)
void	signal_store_timings (SignalArgs &args)
	Signal to store the timings (if enabled) into properties, i.e. for readout from python or the GUI. More...
void	signal_clear (SignalArgs &args)
	Signal to remove all sub-components. More...
void	signal_reset_options (SignalArgs &args)
	Signal to set all options to their default value. More...
void	signal_add_tag (SignalArgs &args)
	Signal to add a tag. More...
void	signature_add_tag (SignalArgs &args)
Public Member Functions inherited from SignalHandler
	~SignalHandler ()
const storage_t &	signal_list () const
SignalPtr	signal (const SignalID &sname)
SignalCPtr	signal (const SignalID &sname) const
SignalRet	call_signal (const SignalID &sname, SignalArgs &sinput)
	Calls the signal by providing its name and input. More...
SignalRet	call_signal (const SignalID &sname, std::vector< std::string > &sinput)
	Calls the signal by providing its name and input. More...
bool	signal_exists (const SignalID &sname) const
	Checks if a signal exists or not. More...
Signal &	regist_signal (const SignalID &sname)
	Regist signal. More...
void	unregist_signal (const SignalID &sname)
	Unregist signal. More...
Public Member Functions inherited from ConnectionManager
	~ConnectionManager ()
	destructor closes all connections More...
Connection *	connection (const std::string &name)
Connection *	manage_connection (const std::string &name)
	manages a connection (creates if necessary) More...
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)

Static Public Member Functions
static std::string	type_name ()
Static Public Member Functions inherited from Builder
static std::string	type_name ()
static std::string	extract_reduced_name (const std::string &builder_name)
static std::string	extract_namespace (const std::string &builder_name)
static std::string	extract_library_name (const std::string &builder_name)
	Extract the library name from the given builder name. More...
Static Public Member Functions inherited from Component
static std::string	type_name ()
	Get the class name. More...

Additional Inherited Members
Public Types inherited from Component
typedef ComponentIterator< Component >	iterator
	type of the iterator to Component More...
typedef ComponentIterator< Component const >	const_iterator
	type of the iterator to constant Component More...
Public Types inherited from SignalHandler
typedef std::vector< SignalPtr >	storage_t
	storage type for signals More...
Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...
Protected Member Functions inherited from Component
Component &	add_static_component (const boost::shared_ptr< Component > &subcomp)
	Add a static (sub)component of this component. More...
void	raise_tree_updated_event ()
	raise event that the path has changed More...

Detailed Description

template<typename BASE, typename CONCRETE>
class cf3::common::BuilderT< BASE, CONCRETE >

Component that builds other components of a given abstract type This is the actual builder for one concrete type.

Author

Tiago Quintino

Definition at line 121 of file Builder.hpp.

Constructor & Destructor Documentation

BuilderT ( const std::string &  name )

inline

Contructor.

Parameters

name	of component

Definition at line 127 of file Builder.hpp.

virtual ~BuilderT ( )

inlinevirtual

Virtual destructor.

Definition at line 143 of file Builder.hpp.

Member Function Documentation

virtual boost::shared_ptr<Component> build ( const std::string &  name ) const

inlinevirtual

Returns

the created component, which is of the passed type

Implements Builder.

Definition at line 162 of file Builder.hpp.

virtual std::string builder_abstract_type_name ( ) const

inlinevirtual

Returns the name of the type of what abstract type it builds. Should match the name of the Factory holding the builder.

Returns

name of type

Implements Builder.

Definition at line 157 of file Builder.hpp.

virtual std::string builder_concrete_type_name ( ) const

inlinevirtual

Returns

the name of the type of this factory

Implements Builder.

Definition at line 160 of file Builder.hpp.

boost::shared_ptr<BASE> create_component_typed ( const std::string &  name ) const

inline

builds the component cast to the correct base

Definition at line 149 of file Builder.hpp.

static std::string type_name ( )

inlinestatic

Returns

the class name

Definition at line 146 of file Builder.hpp.

---

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

• cf3/common/Builder.hpp