\(\renewcommand\AA{\unicode{x212B}}\)

AlgorithmFactoryImpl

This is a Python binding to the C++ class Mantid::API::AlgorithmFactoryImpl.

class mantid.api.AlgorithmFactoryImpl

static Instance() → AlgorithmFactoryImpl :

Returns a reference to the AlgorithmFactory singleton

disableNotifications((AlgorithmFactoryImpl)arg1) → None

enableNotifications((AlgorithmFactoryImpl)arg1) → None

exists((AlgorithmFactoryImpl)arg1, (str)name[, (int)version=-1]) → bool :

Returns true if the given algorithm exists with an option to specify the version

getCategoriesandState((AlgorithmFactoryImpl)arg1) → dict :

Return the categories of the algorithms. This includes those within the Factory itself and any cleanly constructed algorithms stored here

getDescriptors((AlgorithmFactoryImpl)self[, (bool)include_hidden=False[, (bool)include_alias=False]]) → list :

Return a list of descriptors of registered algorithms. Each descriptor is a list: [name, version, category, alias].

getRegisteredAlgorithms((AlgorithmFactoryImpl)self, (bool)include_hidden) → dict :

Returns a Python dictionary of currently registered algorithms

highestVersion((AlgorithmFactoryImpl)self, (str)algorithm_name) → int :

Returns the highest version of the named algorithm. Throws ValueError if no algorithm can be found

subscribe((AlgorithmFactoryImpl)self, (object)object) → None :

Register a Python class derived from PythonAlgorithm into the factory

unsubscribe((AlgorithmFactoryImpl)self, (str)name, (int)version) → None :

Returns the highest version of the named algorithm. Throws ValueError if no algorithm can be found