ImFusion SDK 4.3
DicomAlgorithmFactory Class Reference
+ Inheritance diagram for DicomAlgorithmFactory:

Public Member Functions

bool addAlgorithmFactoryToFront () const override
 Returns whether to add this AlgorithmFactory to the front of the list during registration.
 
- Public Member Functions inherited from AlgorithmFactory
 AlgorithmFactory (const std::string &module, bool checkLicense=true)
 Create algorithm factory for the given module.
 
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.
 
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< AlgorithminstantiateAlgorithm (const std::string &id, const DataList &data) const
 Create an instance of the algorithm with the given id.
 
virtual std::unique_ptr< IoAlgorithminstantiateIoAlgorithm (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< DescriptorcompatibleDescriptors (const DataList &data) const
 Returns the descriptors of non-I/O algorithms registered with this factory which are compatible with data.
 
virtual std::vector< DescriptorcompatibleIoDescriptors (const DataList &data) const
 Returns the descriptors of I/O algorithms registered with this factory which are compatible with data.
 
virtual std::vector< DescriptorcompatibleIoDescriptors (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< DescriptoralgorithmDescriptors () const
 Returns all algorithm descriptors registered with this factory.
 
virtual std::vector< DescriptorioAlgorithmDescriptors () 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.
 
 AlgorithmFactory ()
 
- Public Member Functions inherited from FactoryBase
 FactoryBase ()
 No license check is performed for the module instantiated with this constructor.
 
 FactoryBase (std::string module, bool checkLicense=true)
 
std::string moduleName () const
 Returns the module name of the factory.
 

Additional Inherited Members

- Protected Member Functions inherited from AlgorithmFactory
bool registerAlgorithmIfLicensed (const Descriptor &descriptor)
 Register algorithm with descriptor if license allows it.
 
- Protected Member Functions inherited from FactoryBase
virtual ~FactoryBase ()
 Virtual destructor.
 
std::string getComponentPath (const std::string &componentName) const
 Returns the path to the component referred to by name.
 
bool isLicensed (const std::string &name)
 Return true if the license allows the use of the component referred to by name.
 
- Static Protected Member Functions inherited from 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.
 
- Static Protected Member Functions inherited from FactoryBase
static std::string getComponentPath (const std::string &moduleName, const std::string &componentName)
 Returns the path to the component referred to by name.
 
static bool isLicensed (const std::string &moduleName, const std::string &name)
 Return true if the license allows the use of the component referred to by name.
 
- Protected Attributes inherited from AlgorithmFactory
std::vector< Descriptorm_algorithmDescriptors
 
std::unordered_map< std::type_index, std::stringm_algorithmIds
 
- Protected Attributes inherited from FactoryBase
std::string m_factoryModule
 
bool m_checkLicense
 

Member Function Documentation

◆ addAlgorithmFactoryToFront()

bool addAlgorithmFactoryToFront ( ) const
overridevirtual

Returns whether to add this AlgorithmFactory to the front of the list during registration.

Per default return false. You may override this method to change the behavior.

Reimplemented from AlgorithmFactory.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close