 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/IO/DefaultIoAlgorithmFactory.h>
Factory for built-in IO algorithms. More...
Factory for built-in IO algorithms.
Additional Inherited Members | |
| Public Member Functions inherited from ImFusion::AlgorithmFactory | |
| AlgorithmFactory (const std::string &module) | |
| Create algorithm factory for the given module. | |
| AlgorithmFactory (const std::string &module, bool checkLicense) | |
| std::string | moduleName () const |
| Returns the module name of the factory. | |
| template<typename T> | |
| void | registerAlgorithm (std::string id, std::string guiName, Flags< Descriptor::AlgorithmAttributes > flags={}, std::optional< Properties > configurationOverride=std::nullopt) |
| Register algorithm type T with the given id and GUI name. | |
| void | registerDeprecatedAlgorithmId (std::string deprecatedId, std::string canonicalId) |
| Register a legacy algorithm ID that redirects to a current one, emitting a deprecation warning on use. | |
| template<typename T> | |
| std::unique_ptr< T > | instantiateAlgorithm (const DataList &data) const |
| Create an instance of the algorithm with the type T. | |
| virtual std::unique_ptr< Algorithm > | instantiateAlgorithm (const std::string &id, const DataList &data) const |
| Create an instance of the algorithm with the given id. | |
| virtual std::unique_ptr< IoAlgorithm > | instantiateIoAlgorithm (const std::string &id, const DataList &data) const |
| Convenience function to create an instance of an IO algorithm with the given id. | |
| virtual std::vector< Descriptor > | compatibleDescriptors (const DataList &data) const |
| Returns the descriptors of non-I/O algorithms registered with this factory which are compatible with data. | |
| virtual std::vector< Descriptor > | compatibleIoDescriptors (const DataList &data) const |
| Returns the descriptors of I/O algorithms registered with this factory which are compatible with data. | |
| virtual std::vector< Descriptor > | compatibleIoDescriptors (const Filesystem::Path &path) const |
| Returns the descriptors of algorithms registered with this factory which can load the given file path. | |
| virtual Descriptor | algorithmDescriptor (const std::string &id, bool matchGuiName=false) const |
| Returns the descriptors of the algorithm with the given id. | |
| virtual std::vector< Descriptor > | algorithmDescriptors () const |
| Returns all algorithm descriptors registered with this factory. | |
| virtual std::vector< Descriptor > | ioAlgorithmDescriptors () const |
| Returns all I/O algorithm descriptors registered with this factory. | |
| template<typename T> | |
| Descriptor | algorithmDescriptor () const |
| Returns the descriptors of the algorithm type T. | |
| template<typename T> | |
| std::string | algorithmId () const |
| Returns the id of the algorithm type T. | |
| virtual bool | addAlgorithmFactoryToFront () const |
| Returns whether to add this AlgorithmFactory to the front of the list during registration. | |
| AlgorithmFactory () | |
| Static Protected Member Functions inherited from ImFusion::AlgorithmFactory | |
| static std::string | nameFromId (const std::string &name) |
| Create a GUI name from the algorithm id. | |
| static std::string | idFromName (const std::string &name) |
| Create a standard algorithm id from the GUI name. | |
| Protected Attributes inherited from ImFusion::AlgorithmFactory | |
| std::string | m_moduleName |
| std::vector< Descriptor > | m_algorithmDescriptors |
| std::unordered_map< std::type_index, std::string > | m_algorithmIds |
| std::unordered_map< std::string, std::string > | m_deprecatedAlgorithmIds |
| Maps deprecated fully-qualified IDs to their canonical replacements. | |