qSlicerAbstractModuleFactoryManager Class Reference

#include <Base/QTCore/qSlicerAbstractModuleFactoryManager.h>

Inheritance diagram for qSlicerAbstractModuleFactoryManager:

Collaboration diagram for qSlicerAbstractModuleFactoryManager:

Public Types
typedef ctkAbstractFileBasedFactory< qSlicerAbstractCoreModule >	qSlicerFileBasedModuleFactory
typedef ctkAbstractFactory< qSlicerAbstractCoreModule >	qSlicerModuleFactory
typedef QObject	Superclass

Properties
QStringList	modulesToIgnore
QStringList	searchPaths

Public Slots
bool	isVerbose () const
void	setIsVerbose (bool flag)

Signals
void	explicitModulesChanged (const QStringList &moduleNames)
void	moduleAboutToBeInstantiated (const QString &moduleName)
void	moduleAboutToBeUninstantiated (const QString &moduleName)
void	moduleIgnored (const QString &moduleName)
void	moduleInstantiated (const QString &moduleName)
void	moduleRegistered (const QString &moduleName)
void	modulesAboutToBeUninstantiated (const QStringList &moduleNames)
void	modulesInstantiated (const QStringList &moduleNames)
void	modulesRegistered (const QStringList &moduleNames)
	This signal is emitted when all the modules associated with the registered factories have been loaded.
void	modulesToIgnoreChanged (const QStringList &moduleNames)
void	modulesUninstantiated (const QStringList &moduleNames)
void	moduleUninstantiated (const QString &moduleName)

Public Member Functions
void	addModuleToIgnore (const QString &moduleName)
void	addSearchPath (const QString &path)
	Utility function that adds a path to the current searchPaths list.
void	addSearchPaths (const QStringList &paths)
QStringList	dependentModules (const QString &module) const
QStringList	explicitModules () const
QStringList	ignoredModuleNames () const
Q_INVOKABLE QStringList	instantiatedModuleNames () const
	List of registered and instantiated modules.
virtual void	instantiateModules ()
	Instantiate all previously registered modules.
Q_INVOKABLE bool	isInstantiated (const QString &name) const
	Return true if a module has been instantiated, false otherwise.
Q_INVOKABLE bool	isRegistered (const QString &name) const
	Return true if a module has been registered, false otherwise.
QStringList	moduleDependees (const QString &module) const
Q_INVOKABLE qSlicerAbstractCoreModule *	moduleInstance (const QString &moduleName) const
	Return the instance of a module if already instantiated, 0 otherwise.
QStringList	modulesToIgnore () const
virtual void	printAdditionalInfo ()
	Print internal state using qDebug()
	qSlicerAbstractModuleFactoryManager (QObject *newParent=nullptr)
Q_INVOKABLE QStringList	registeredModuleNames () const
	Convenient method returning the list of all registered module names.
void	registerFactory (qSlicerModuleFactory *factory, int priority=0)
	Register a factory The factory will be deleted when unregistered (e.g. in ~qSlicerAbstractModuleFactoryManager())
Q_INVOKABLE void	registerModule (const QFileInfo &file)
void	registerModules ()
void	removeModuleToIgnore (const QString &moduleName)
void	removeSearchPath (const QString &path)
	Utility function that removes a path from the current searchPaths list.
void	removeSearchPaths (const QStringList &paths)
QStringList	searchPaths () const
void	setExplicitModules (const QStringList &moduleNames)
void	setModulesToIgnore (const QStringList &modulesNames)
void	setSearchPaths (const QStringList &searchPaths)
void	setVerboseModuleDiscovery (bool value)
	Enable/Disable verbose output during module discovery process.
void	uninstantiateModules ()
	Uninstantiate all instantiated modules.
void	unregisterFactories ()
void	unregisterFactory (qSlicerModuleFactory *factory)
	~qSlicerAbstractModuleFactoryManager () override

Protected Member Functions
qSlicerAbstractCoreModule *	instantiateModule (const QString &name)
	Instantiate a module given its name.
void	registerModules (const QString &directoryPath)
virtual void	uninstantiateModule (const QString &moduleName)
	Uninstantiate a module given its moduleName.

Protected Attributes
QScopedPointer< qSlicerAbstractModuleFactoryManagerPrivate >	d_ptr

Detailed Description

Loading modules into slicer happens in multiple steps: 1) module factories must be registered into the factory manager: qSlicerModuleFactoryManager* factoryManager = app->moduleManager()->factoryManager(); factoryManager->registerFactory(new qSlicerLoadableModuleFactory); ... 2) directories where the modules to load are located must be passed to the factory manager factoryManager->addSearchPath(app->slicerHome() + "/" + Slicer_QTSCRIPTEDMODULES_LIB_DIR + "/" ); factoryManager->addSearchPath(app->slicerHome() + "/" + Slicer_CLIMODULES_LIB_DIR + "/" ); ... 3) Optionally:

• specify module names to ignore: For startup speed-up and memory consummation, it can be useful to not load some modules: factoryManager->setModulesToIgnore(QStringList(QLatin1String("Data")));
• specify an explicit list of modules to register/instantiate/load. All other discovered modules won't be loaded. 4) scan the directories and test which file is a module and register it (not instantiated yet) For each file in the search paths, the factory manager asks each registered factory if they can load the file. If there is a factory that supports the file, the manager associates the factory to the file path, otherwise the file is discarded. factoryManager->registerModules(); 5) Instantiate all the registered modules factoryManager->instantiateModules(); 6) Connect each module with the scene and the application The application logic and the scene are passed to each module. The order of initialization is defined with the dependencies of the modules. If module B depends of module A, it is assured that module B is initialized/setup after A. factoryManager->loadModules();

Definition at line 65 of file qSlicerAbstractModuleFactoryManager.h.

Member Typedef Documentation

qSlicerFileBasedModuleFactory

typedef ctkAbstractFileBasedFactory<qSlicerAbstractCoreModule> qSlicerAbstractModuleFactoryManager::qSlicerFileBasedModuleFactory

Definition at line 86 of file qSlicerAbstractModuleFactoryManager.h.

qSlicerModuleFactory

typedef ctkAbstractFactory<qSlicerAbstractCoreModule> qSlicerAbstractModuleFactoryManager::qSlicerModuleFactory

Definition at line 87 of file qSlicerAbstractModuleFactoryManager.h.

Superclass

typedef QObject qSlicerAbstractModuleFactoryManager::Superclass

Definition at line 89 of file qSlicerAbstractModuleFactoryManager.h.

Property Documentation

modulesToIgnore

QStringList qSlicerAbstractModuleFactoryManager::modulesToIgnore

readwrite

This property holds the names of the modules to ignore at registration time.

Due to the large amount of modules to load, it can be faster (and less overwhelming) to load only a subset of the modules.

Definition at line 84 of file qSlicerAbstractModuleFactoryManager.h.

searchPaths

QStringList qSlicerAbstractModuleFactoryManager::searchPaths

readwrite

This property holds the paths where the modules are located. At registration time (registerModules), the paths are scanned and module discovered. A module can be a library (dll, so), an executable (exe), a python file (py) or any other file type supported by the registered factories. The search is not recursive, you need to provide each subdirectory manually.

Todo

In qSlicerAbstractModuleFactoryManager, should the module search recursively descend searchPaths

Definition at line 78 of file qSlicerAbstractModuleFactoryManager.h.

Constructor & Destructor Documentation

qSlicerAbstractModuleFactoryManager()

qSlicerAbstractModuleFactoryManager::qSlicerAbstractModuleFactoryManager

(

QObject *

newParent = nullptr

)

~qSlicerAbstractModuleFactoryManager()

qSlicerAbstractModuleFactoryManager::~qSlicerAbstractModuleFactoryManager ( )

override

Destructor, Deallocates resources Unregister (and delete) all registered factories.

Member Function Documentation

addModuleToIgnore()

void qSlicerAbstractModuleFactoryManager::addModuleToIgnore ( const QString & moduleName )

inline

Utility function that adds a module to the modulesToIgnore list.

See also

removeModuleToIgnore(const QString& moduleName)

Definition at line 272 of file qSlicerAbstractModuleFactoryManager.h.

addSearchPath()

void qSlicerAbstractModuleFactoryManager::addSearchPath ( const QString & path )

inline

Utility function that adds a path to the current searchPaths list.

Definition at line 249 of file qSlicerAbstractModuleFactoryManager.h.

addSearchPaths()

void qSlicerAbstractModuleFactoryManager::addSearchPaths ( const QStringList & paths )

inline

Utility function that adds a list of path to the current searchPaths list.

Definition at line 243 of file qSlicerAbstractModuleFactoryManager.h.

dependentModules()

QStringList qSlicerAbstractModuleFactoryManager::dependentModules

(

const QString &

module

)

const

Return the list of modules that have module as a dependency. Note that the list can contain unloaded modules.

See also

qSlicerAbstractCoreModule::dependencies(), moduleDependees()

explicitModules()

QStringList qSlicerAbstractModuleFactoryManager::explicitModules

(

)

const

explicitModulesChanged

void qSlicerAbstractModuleFactoryManager::explicitModulesChanged ( const QStringList & moduleNames )

signal

ignoredModuleNames()

QStringList qSlicerAbstractModuleFactoryManager::ignoredModuleNames

(

)

const

After the modules are registered, ignoredModules contains the list of all the modules that were ignored.

instantiatedModuleNames()

Q_INVOKABLE QStringList qSlicerAbstractModuleFactoryManager::instantiatedModuleNames

(

)

const

List of registered and instantiated modules.

instantiateModule()

qSlicerAbstractCoreModule * qSlicerAbstractModuleFactoryManager::instantiateModule ( const QString & name )

protected

Instantiate a module given its name.

instantiateModules()

virtual void qSlicerAbstractModuleFactoryManager::instantiateModules ( )

virtual

Instantiate all previously registered modules.

isInstantiated()

Q_INVOKABLE bool qSlicerAbstractModuleFactoryManager::isInstantiated

(

const QString &

name

)

const

Return true if a module has been instantiated, false otherwise.

isRegistered()

Q_INVOKABLE bool qSlicerAbstractModuleFactoryManager::isRegistered

(

const QString &

name

)

const

Return true if a module has been registered, false otherwise.

isVerbose

bool qSlicerAbstractModuleFactoryManager::isVerbose ( ) const

slot

moduleAboutToBeInstantiated

void qSlicerAbstractModuleFactoryManager::moduleAboutToBeInstantiated ( const QString & moduleName )

signal

moduleAboutToBeUninstantiated

void qSlicerAbstractModuleFactoryManager::moduleAboutToBeUninstantiated ( const QString & moduleName )

signal

moduleDependees()

QStringList qSlicerAbstractModuleFactoryManager::moduleDependees

(

const QString &

module

)

const

Return the list of modules that depend on module. Note that the list can contain unloaded modules.

See also

dependentModules(), qSlicerAbstractCoreModule::dependencies()

moduleIgnored

void qSlicerAbstractModuleFactoryManager::moduleIgnored ( const QString & moduleName )

signal

moduleInstance()

Q_INVOKABLE qSlicerAbstractCoreModule * qSlicerAbstractModuleFactoryManager::moduleInstance

(

const QString &

moduleName

)

const

Return the instance of a module if already instantiated, 0 otherwise.

moduleInstantiated

void qSlicerAbstractModuleFactoryManager::moduleInstantiated ( const QString & moduleName )

signal

moduleRegistered

void qSlicerAbstractModuleFactoryManager::moduleRegistered ( const QString & moduleName )

signal

modulesAboutToBeUninstantiated

void qSlicerAbstractModuleFactoryManager::modulesAboutToBeUninstantiated ( const QStringList & moduleNames )

signal

modulesInstantiated

void qSlicerAbstractModuleFactoryManager::modulesInstantiated ( const QStringList & moduleNames )

signal

modulesRegistered

void qSlicerAbstractModuleFactoryManager::modulesRegistered ( const QStringList & moduleNames )

signal

This signal is emitted when all the modules associated with the registered factories have been loaded.

modulesToIgnore()

QStringList qSlicerAbstractModuleFactoryManager::modulesToIgnore

(

)

const

modulesToIgnoreChanged

void qSlicerAbstractModuleFactoryManager::modulesToIgnoreChanged ( const QStringList & moduleNames )

signal

modulesUninstantiated

void qSlicerAbstractModuleFactoryManager::modulesUninstantiated ( const QStringList & moduleNames )

signal

moduleUninstantiated

void qSlicerAbstractModuleFactoryManager::moduleUninstantiated ( const QString & moduleName )

signal

printAdditionalInfo()

virtual void qSlicerAbstractModuleFactoryManager::printAdditionalInfo ( )

virtual

Print internal state using qDebug()

Reimplemented in qSlicerModuleFactoryManager.

registeredModuleNames()

Q_INVOKABLE QStringList qSlicerAbstractModuleFactoryManager::registeredModuleNames

(

)

const

Convenient method returning the list of all registered module names.

registerFactory()

void qSlicerAbstractModuleFactoryManager::registerFactory	(	qSlicerModuleFactory *	factory,
		int	priority = 0 )

Register a factory The factory will be deleted when unregistered (e.g. in ~qSlicerAbstractModuleFactoryManager())

Example:

qSlicerAbstractModuleFactoryManager factoryManager;
factoryManager.registerFactory(new qSlicerCoreModuleFactory);
factoryManager.registerFactory(new qSlicerLoadableModuleFactory);

The order in which factories are registered is important. When scanning directories, registered factories are browse and the first factory that can read a file is used. Priority is used when multiple factories can register the same module. The factory with the higher priority wins.

registerModule()

Q_INVOKABLE void qSlicerAbstractModuleFactoryManager::registerModule

(

const QFileInfo &

file

)

registerModules() [1/2]

void qSlicerAbstractModuleFactoryManager::registerModules

(

)

Scan the paths in searchPaths and for each file, attempt to register using one of the registered factories.

registerModules() [2/2]

void qSlicerAbstractModuleFactoryManager::registerModules ( const QString & directoryPath )

protected

removeModuleToIgnore()

void qSlicerAbstractModuleFactoryManager::removeModuleToIgnore ( const QString & moduleName )

inline

Utility function that removes a module to the modulesToIgnore list.

See also

addModuleToIgnore(const QString& moduleName)

Definition at line 284 of file qSlicerAbstractModuleFactoryManager.h.

removeSearchPath()

void qSlicerAbstractModuleFactoryManager::removeSearchPath ( const QString & path )

inline

Utility function that removes a path from the current searchPaths list.

Definition at line 264 of file qSlicerAbstractModuleFactoryManager.h.

removeSearchPaths()

void qSlicerAbstractModuleFactoryManager::removeSearchPaths ( const QStringList & paths )

inline

Utility function that removes a list of path to the current searchPaths list.

Definition at line 255 of file qSlicerAbstractModuleFactoryManager.h.

searchPaths()

QStringList qSlicerAbstractModuleFactoryManager::searchPaths

(

)

const

setExplicitModules()

void qSlicerAbstractModuleFactoryManager::setExplicitModules

(

const QStringList &

moduleNames

)

setIsVerbose

void qSlicerAbstractModuleFactoryManager::setIsVerbose ( bool flag )

slot

Enable/disable local verbose output during module discovery and uninstantiating, set by setVerboseModuleDiscovery()

See also

setVerboseModuleDiscovery()

setModulesToIgnore()

void qSlicerAbstractModuleFactoryManager::setModulesToIgnore

(

const QStringList &

modulesNames

)

Set or get the modulesToIgnore list.

If list is modified, the signal modulesToIgnoreChanged(const QStringLists&) is emitted.

setSearchPaths()

void qSlicerAbstractModuleFactoryManager::setSearchPaths

(

const QStringList &

searchPaths

)

setVerboseModuleDiscovery()

void qSlicerAbstractModuleFactoryManager::setVerboseModuleDiscovery

(

bool

value

)

Enable/Disable verbose output during module discovery process.

uninstantiateModule()

virtual void qSlicerAbstractModuleFactoryManager::uninstantiateModule ( const QString & moduleName )

protectedvirtual

Uninstantiate a module given its moduleName.

Reimplemented in qSlicerModuleFactoryManager.

uninstantiateModules()

void qSlicerAbstractModuleFactoryManager::uninstantiateModules

(

)

Uninstantiate all instantiated modules.

unregisterFactories()

void qSlicerAbstractModuleFactoryManager::unregisterFactories

(

)

unregisterFactory()

void qSlicerAbstractModuleFactoryManager::unregisterFactory

(

qSlicerModuleFactory *

factory

)

Member Data Documentation

d_ptr

QScopedPointer<qSlicerAbstractModuleFactoryManagerPrivate> qSlicerAbstractModuleFactoryManager::d_ptr

protected

Definition at line 227 of file qSlicerAbstractModuleFactoryManager.h.

---

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

• Base/QTCore/qSlicerAbstractModuleFactoryManager.h