 |
COOLFluiD
Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
|
|
COOLFluiD
Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
|
#include <Libraries.hpp>
Inherits Component.
Public Member Functions | |
| Libraries (const std::string &name) | |
| virtual | ~Libraries () |
| Virtual destructor. More... | |
| template<typename LIB > | |
| Handle< LIB > | library () |
| void | initiate_all_libraries () |
| calls all the initiate hooks on all the libraries that have not been initiated yet More... | |
| void | terminate_all_libraries () |
| calls all the terminate hooks on all the libraries that have not been terminated yet More... | |
| bool | is_loaded (const std::string &name) |
| void | load_library (const URI &file) |
| Handle< Library > | autoload_library_with_builder (const std::string &builder_name) |
| Handle< Library > | autoload_library_with_namespace (const std::string &libnamespace) |
SIGNALS | |
| void | signal_load_libraries (SignalArgs &args) |
| Signal to load a list of libraries. More... | |
| void | signature_load_libraries (SignalArgs &args) |
| Signature of the signal to load a list of libraries. More... | |
| void | signal_load (SignalArgs &args) |
| Signal to autoload a list of libraries by namespace names. More... | |
| void | signature_load (SignalArgs &args) |
| Signature of the signal to autoload a list of libraries by namespace names. More... | |
 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 () |
| Get the class name. More... | |
| static std::string | namespace_to_libname (const std::string &libnamespace) |
| 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... | |
Component that defines global environment
Definition at line 24 of file Libraries.hpp.
| Libraries | ( | const std::string & | name | ) |
|
virtual |
Virtual destructor.
Definition at line 63 of file Libraries.cpp.
Attempts to load a CF3 plugin library from the builders name
| [in] | name | of the shared library to be loaded |
| ValueNotFound | in case of library not able to be loaded |
Definition at line 129 of file Libraries.cpp.
Attempts to load a CF3 plugin library from its namespace
| [in] | namespace | of the shared library to be loaded (e.g. cf3Common) |
| ValueNotFound | in case of library not able to be loaded |
Definition at line 105 of file Libraries.cpp.
| void initiate_all_libraries | ( | ) |
calls all the initiate hooks on all the libraries that have not been initiated yet
Definition at line 136 of file Libraries.cpp.
| bool is_loaded | ( | const std::string & | name | ) |
Checks if a CF3 plugin library is already loaded
| [in] | file | URI to the shared library to be loaded |
Definition at line 86 of file Libraries.cpp.
|
inline |
gives access to the factory of supplied type, insuring that in case it does not exist it gets built.
Definition at line 46 of file Libraries.hpp.
| void load_library | ( | const URI & | file | ) |
Attempts to load a CF3 plugin library
| [in] | file | URI to the shared library to be loaded |
Definition at line 93 of file Libraries.cpp.
|
static |
Converts a CF3 library namespace to the library name. For example: cf3Common to coolfluid_common
Definition at line 69 of file Libraries.cpp.
| void signal_load | ( | SignalArgs & | args | ) |
Signal to autoload a list of libraries by namespace names.
Definition at line 193 of file Libraries.cpp.
| void signal_load_libraries | ( | SignalArgs & | args | ) |
Signal to load a list of libraries.
Definition at line 156 of file Libraries.cpp.
| void signature_load | ( | SignalArgs & | args | ) |
Signature of the signal to autoload a list of libraries by namespace names.
Definition at line 213 of file Libraries.cpp.
| void signature_load_libraries | ( | SignalArgs & | args | ) |
Signature of the signal to load a list of libraries.
Definition at line 176 of file Libraries.cpp.
| void terminate_all_libraries | ( | ) |
calls all the terminate hooks on all the libraries that have not been terminated yet
Definition at line 146 of file Libraries.cpp.
|
inlinestatic |
Get the class name.
Definition at line 37 of file Libraries.hpp.
1.8.9.1
|
Send comments to: COOLFluiD Web Admin |
