.. index:: pair: class; FunctionalNodeFactoryManager
.. _doxid-class_functional_node_factory_manager:

class FunctionalNodeFactoryManager
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Singleton class which loads Functional Node factory plugins and instantiates Functional Nodes using the former. :ref:`More...<details-class_functional_node_factory_manager>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <functional_node_factory_manager.h>
	
	class FunctionalNodeFactoryManager: public :ref:`PluginManager<doxid-class_plugin_manager>` {
	public:
		// construction
	
		:target:`FunctionalNodeFactoryManager<doxid-class_functional_node_factory_manager_1a52005788f551395e3c6ca3c79971aa7a>`(const FunctionalNodeFactoryManager&);
		:target:`FunctionalNodeFactoryManager<doxid-class_functional_node_factory_manager_1a65164bf0c0d45d3232235c02d8e2b308>`(FunctionalNodeFactoryManager&&);

		// methods
	
		FunctionalNodeFactoryManager& :target:`operator =<doxid-class_functional_node_factory_manager_1af529dbbe442ec889771f5da863c023e7>` (const FunctionalNodeFactoryManager&);
		FunctionalNodeFactoryManager& :target:`operator =<doxid-class_functional_node_factory_manager_1a5cdd4eabe87450f2c33a0f7e7e4f5584>` (FunctionalNodeFactoryManager&&);
		void :ref:`loadFNFactoryPlugin<doxid-class_functional_node_factory_manager_1ae15536c3ae42f052712dc87a4121f208>`(const std::string& pluginLibFile);
	
		:ref:`FunctionalNodeBase<doxid-class_functional_node_base>`* :ref:`createFunctionalNode<doxid-class_functional_node_factory_manager_1a18780d5bd90813cf60e9b0fe00378f02>`(
			const std::string& functionName,
			const std::string& nodeName,
			:ref:`FunctionalNodePolicies::ExecutionPolicy<doxid-namespace_functional_node_policies_1a3f872dbefb885b0dca2745e76e002b87>` policy = FunctionalNodePolicies::ExecutionPolicy::ON_NEW_INPUT
		);
	
		static FunctionalNodeFactoryManager& :ref:`getInstance<doxid-class_functional_node_factory_manager_1aa030f2236c0d4ac91778259246cbfff4>`();
		static void :ref:`resetInstance<doxid-class_functional_node_factory_manager_1a60bbe0068acdb4c1aa3bdfd8ee53cccc>`();
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		bool :ref:`loadPlugin<doxid-class_plugin_manager_1a650fbdd7970345d453674aec46db080e>`(const std::string& pluginLibFile);
		void :ref:`addPluginPath<doxid-class_plugin_manager_1aae4c9a8c7f8c1f74fac06307b88acf22>`(const std::string& pluginPath);

.. _details-class_functional_node_factory_manager:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Singleton class which loads Functional Node factory plugins and instantiates Functional Nodes using the former.

Functional Node factory plugins are generated using the skeleton "fn_factory_module.cpp.template"

Methods
-------

.. index:: pair: function; loadFNFactoryPlugin
.. _doxid-class_functional_node_factory_manager_1ae15536c3ae42f052712dc87a4121f208:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void loadFNFactoryPlugin(const std::string& pluginLibFile)

Load a Functional Node factory plugin.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- pluginLibFile

		- Plugin library file (.so)

.. index:: pair: function; createFunctionalNode
.. _doxid-class_functional_node_factory_manager_1a18780d5bd90813cf60e9b0fe00378f02:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`FunctionalNodeBase<doxid-class_functional_node_base>`* createFunctionalNode(
		const std::string& functionName,
		const std::string& nodeName,
		:ref:`FunctionalNodePolicies::ExecutionPolicy<doxid-namespace_functional_node_policies_1a3f872dbefb885b0dca2745e76e002b87>` policy = FunctionalNodePolicies::ExecutionPolicy::ON_NEW_INPUT
	)

Attempts to instantiate a Functional Node from the requested functionName using all loaded plugins.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- functionName

		- Name of the function to instantiate the FN from

	*
		- nodeName

		- Name of the FN

	*
		- policy

		- Execution policy of the FN



.. rubric:: Returns:

Returns a :ref:`FunctionalNodeBase <doxid-class_functional_node_base>` pointer

.. index:: pair: function; getInstance
.. _doxid-class_functional_node_factory_manager_1aa030f2236c0d4ac91778259246cbfff4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static FunctionalNodeFactoryManager& getInstance()

Get singleton instance of :ref:`FunctionalNodeFactoryManager <doxid-class_functional_node_factory_manager>`.

.. index:: pair: function; resetInstance
.. _doxid-class_functional_node_factory_manager_1a60bbe0068acdb4c1aa3bdfd8ee53cccc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static void resetInstance()

Reset singleton instance.