qSlicerModuleFactoryManager.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qSlicerModuleFactoryManager_h
#define __qSlicerModuleFactoryManager_h

// Qt includes
#include <QStringList>

// Slicer includes
#include "qSlicerAbstractModuleFactoryManager.h"
class qSlicerModuleFactoryManagerPrivate;

// Slicer logics includes
class vtkSlicerApplicationLogic;

// MRML includes
class vtkMRMLScene;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerModuleFactoryManager
  : public qSlicerAbstractModuleFactoryManager
{
  Q_OBJECT
public:
  typedef qSlicerAbstractModuleFactoryManager Superclass;
  qSlicerModuleFactoryManager(QObject* newParent = nullptr);

  ~qSlicerModuleFactoryManager() override;

  void printAdditionalInfo() override;

  Q_INVOKABLE int loadModules();

  Q_INVOKABLE QStringList loadedModuleNames()const;

  Q_INVOKABLE void unloadModules();

  Q_INVOKABLE bool isLoaded(const QString& name)const;

  Q_INVOKABLE qSlicerAbstractCoreModule* loadedModule(const QString& name)const;

  void setAppLogic(vtkSlicerApplicationLogic* applicationLogic);
  vtkSlicerApplicationLogic* appLogic()const;

  vtkMRMLScene* mrmlScene()const;

  Q_INVOKABLE bool loadModules(const QStringList& modules);

  bool loadModule(const QString& name);

  QStringList modulePaths(const QString& basePath);

public slots:
  void setMRMLScene(vtkMRMLScene* mrmlScene);

signals:

  void modulesLoaded(const QStringList& modulesNames);
  void moduleLoaded(const QString& moduleName);

  void modulesAboutToBeUnloaded(const QStringList& modulesNames);
  void moduleAboutToBeUnloaded(const QString& moduleName);

  void modulesUnloaded(const QStringList& modulesNames);
  void moduleUnloaded(const QString& moduleName);

  void mrmlSceneChanged(vtkMRMLScene* newScene);
protected:
  QScopedPointer<qSlicerModuleFactoryManagerPrivate> d_ptr;

  bool loadModule(const QString& name, const QString& dependee);

  void unloadModule(const QString& name);

  void uninstantiateModule(const QString& moduleName) override;

  virtual void uninstantiateModules();
private:
  Q_DECLARE_PRIVATE(qSlicerModuleFactoryManager);
  Q_DISABLE_COPY(qSlicerModuleFactoryManager);
};

#endif