ImFusion::AlgorithmControllerFactory Class Reference

#include <ImFusion/Base/AlgorithmControllerFactory.h>

Interface for algorithm controller factories. More...

Inheritance diagram for ImFusion::AlgorithmControllerFactory:

Detailed Description

Interface for algorithm controller factories.

Examples

StreamAlgorithmFactory.cpp.

Public Member Functions
	AlgorithmControllerFactory ()
	AlgorithmControllerFactory (std::string module)
	AlgorithmControllerFactory (std::string module, bool checkLicense)
std::string	moduleName () const
	Returns the module name of the factory.
virtual AlgorithmController *	create (Algorithm *a) const =0
	Create controller for a given algorithm instance if possible.
DataController *	createDataController (const std::string &id, const DataList &data) const
	Create data controller.
virtual std::vector< std::string >	compatibleDataControllers (const DataList &data) const
	Return list of data controllers compatible with input data. The list contains the data controller id.
std::vector< std::string >	dataControllerNames () const
	Return all registered algorithm names.
template<class T>
void	registerDataController (const std::string &name)
	Register data controller. Categories are specified by separating them from the name with ; as separator (e.g. Filters;Gaussian).
void	unregisterAllDataControllers ()
	Unregister all data controller of this factory.

Protected Types
typedef std::function< std::string(const DataList &data, const std::string &id, DataController **a)>	createCompatibleFunc

Protected Attributes
std::string	m_moduleName
std::vector< createCompatibleFunc >	m_dataControllers
std::unordered_map< std::type_index, std::string >	m_dataControllerNames

Constructor & Destructor Documentation

AlgorithmControllerFactory() [1/2]

ImFusion::AlgorithmControllerFactory::AlgorithmControllerFactory

(

)

Deprecated

"Use controller factory with a module name."

AlgorithmControllerFactory() [2/2]

ImFusion::AlgorithmControllerFactory::AlgorithmControllerFactory ( std::string module, bool checkLicense )

explicit

Deprecated

The checkLicense parameter is no longer used.

Deprecated

"checkLicense parameter is deprecated and ignored. Use single-parameter constructor."

Member Function Documentation

create()

virtual AlgorithmController * ImFusion::AlgorithmControllerFactory::create ( Algorithm * a ) const

pure virtual

Create controller for a given algorithm instance if possible.

Implemented in ImFusion::AnatomyPlugin::AnatomyControllerFactory, ImFusion::BaseAlgorithmControllerFactory, ImFusion::CranialPluginControllerFactory, ImFusion::DefaultIoAlgorithmControllerFactory, ImFusion::DicomAlgorithmControllerFactory, ImFusion::GlAlgorithmControllerFactory, ImFusion::GraphPluginControllerFactory, ImFusion::NavigationAlgorithmControllerFactory, ImFusion::Robotics::RoboticsAlgorithmControllerFactory, ImFusion::SpineControllerFactory, ImFusion::StreamAlgorithmControllerFactory, ImFusion::US::LiveUSAlgorithmControllerFactory, and ImFusion::US::USAlgorithmControllerFactory.

createDataController()

DataController * ImFusion::AlgorithmControllerFactory::createDataController	(	const std::string &	id,
		const DataList &	data ) const

Create data controller.

Parameters

id	algorithm identifier
data	input data

Returns

pointer to generated algorithm if successful, zero otherwise

---

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

• ImFusion/Base/AlgorithmControllerFactory.h