Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerCLIModule Class Reference

#include <Base/QTCLI/qSlicerCLIModule.h>

Inheritance diagram for qSlicerCLIModule:
Inheritance graph
[legend]
Collaboration diagram for qSlicerCLIModule:
Collaboration graph
[legend]

Public Types

typedef qSlicerAbstractModule Superclass
 
- Public Types inherited from qSlicerAbstractModule
typedef qSlicerAbstractCoreModule Superclass
 
- Public Types inherited from qSlicerAbstractCoreModule
typedef QObject Superclass
 

Public Member Functions

QString acknowledgementText () const override
 
QStringList associatedNodeTypes () const override
 Specify editable node types. More...
 
QStringList categories () const override
 Extracted from the "category" field. More...
 
Q_INVOKABLE vtkSlicerCLIModuleLogiccliModuleLogic ()
 
QStringList contributors () const override
 Extracted from the "contributor" field. More...
 
QString entryPoint () const
 
QString helpText () const override
 
Return help/acknowledgement text More...
 
int index () const override
 Optionally set in the module XML description. More...
 
QImage logo () const override
 The logo of the module, the credits given by the grants or instution. More...
 
ModuleDescription & moduleDescription ()
 
QString moduleType () const
 
 qSlicerCLIModule (QWidget *parent=nullptr)
 
void setEntryPoint (const QString &entryPoint)
 
void setLogo (const ModuleLogo &logo)
 
void setModuleType (const QString &type)
 
void setTempDirectory (const QString &tempDirectory)
 Set temporary directory associated with the module. More...
 
void setXmlModuleDescription (const QString &xmlModuleDescription)
 
QString tempDirectory () const
 
QString title () const override
 
 ~qSlicerCLIModule () override
 
- Public Member Functions inherited from qSlicerAbstractModule
Q_INVOKABLE QAction * action ()
 
virtual QIcon icon () const
 
 qSlicerAbstractModule (QObject *parent=nullptr)
 
 ~qSlicerAbstractModule () override
 
- Public Member Functions inherited from qSlicerAbstractCoreModule
 qSlicerAbstractCoreModule (QObject *parent=nullptr)
 
 ~qSlicerAbstractCoreModule () override
 
virtual void printAdditionalInfo ()
 
QString slicerWikiUrl () const
 Convenient method to return slicer wiki URL. More...
 
void initialize (vtkSlicerApplicationLogic *appLogic)
 
bool initialized ()
 
virtual QString name () const
 
virtual void setName (const QString &name)
 
virtual bool isHidden () const
 
bool isWidgetRepresentationCreationEnabled () const
 
void setWidgetRepresentationCreationEnabled (bool value)
 
qSlicerAbstractModuleRepresentationwidgetRepresentation ()
 
qSlicerAbstractModuleRepresentationcreateNewWidgetRepresentation ()
 
void setAppLogic (vtkSlicerApplicationLogic *appLogic)
 
vtkSlicerApplicationLogicappLogic () const
 
Q_INVOKABLE vtkMRMLAbstractLogiclogic ()
 
Q_INVOKABLE vtkMRMLScenemrmlScene () const
 Return a pointer on the MRML scene. More...
 
virtual QStringList dependencies () const
 
QString path () const
 
void setPath (const QString &newPath)
 
bool isInstalled () const
 
void setInstalled (bool value)
 
bool isBuiltIn () const
 
void setBuiltIn (bool value)
 

Static Public Member Functions

static QImage moduleLogoToImage (const ModuleLogo &logo)
 

Protected Member Functions

vtkMRMLAbstractLogiccreateLogic () override
 
Create and return the logic associated to this module More...
 
qSlicerAbstractModuleRepresentationcreateWidgetRepresentation () override
 
Create and return the widget representation associated to this module More...
 
void setup () override
 All initialization code should be done in the setup. More...
 
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerCLIModulePrivate > d_ptr
 
- Protected Attributes inherited from qSlicerAbstractModule
QScopedPointer< qSlicerAbstractModulePrivate > d_ptr
 
- Protected Attributes inherited from qSlicerAbstractCoreModule
QScopedPointer< qSlicerAbstractCoreModulePrivate > d_ptr
 

Additional Inherited Members

- Properties inherited from qSlicerAbstractModule
QIcon icon
 
QImage logo
 
- Properties inherited from qSlicerAbstractCoreModule
QString name
 
QString title
 
QStringList categories
 
int index
 
bool hidden
 
bool widgetRepresentationCreationEnabled
 
QString helpText
 
QString acknowledgementText
 
QStringList contributors
 
QString slicerWikiUrl
 
QStringList dependencies
 
QString path
 
bool isInstalled
 
bool isBuiltIn
 
QStringList associatedNodeTypes
 
- Public Slots inherited from qSlicerAbstractCoreModule
virtual void setMRMLScene (vtkMRMLScene *)
 

Detailed Description

Definition at line 40 of file qSlicerCLIModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file qSlicerCLIModule.h.

Constructor & Destructor Documentation

◆ qSlicerCLIModule()

qSlicerCLIModule::qSlicerCLIModule ( QWidget *  parent = nullptr)

◆ ~qSlicerCLIModule()

qSlicerCLIModule::~qSlicerCLIModule ( )
override

Member Function Documentation

◆ acknowledgementText()

QString qSlicerCLIModule::acknowledgementText ( ) const
overridevirtual

Return acknowledgement text for the module Must be reimplemented in the derived classes

Reimplemented from qSlicerAbstractCoreModule.

◆ associatedNodeTypes()

QStringList qSlicerCLIModule::associatedNodeTypes ( ) const
overridevirtual

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ categories()

QStringList qSlicerCLIModule::categories ( ) const
overridevirtual

Extracted from the "category" field.

Reimplemented from qSlicerAbstractCoreModule.

◆ cliModuleLogic()

Q_INVOKABLE vtkSlicerCLIModuleLogic* qSlicerCLIModule::cliModuleLogic ( )

This method allows to get a pointer to the ModuleLogic. If no moduleLogic already exists, one will be created calling 'createLogic' method.

◆ contributors()

QStringList qSlicerCLIModule::contributors ( ) const
overridevirtual

Extracted from the "contributor" field.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerCLIModule::createLogic ( )
overrideprotectedvirtual


Create and return the logic associated to this module

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerCLIModule::createWidgetRepresentation ( )
overrideprotectedvirtual


Create and return the widget representation associated to this module

Implements qSlicerAbstractCoreModule.

◆ entryPoint()

QString qSlicerCLIModule::entryPoint ( ) const

◆ helpText()

QString qSlicerCLIModule::helpText ( ) const
overridevirtual


Return help/acknowledgement text

Reimplemented from qSlicerAbstractCoreModule.

◆ index()

int qSlicerCLIModule::index ( ) const
overridevirtual

Optionally set in the module XML description.

Reimplemented from qSlicerAbstractCoreModule.

◆ logo()

QImage qSlicerCLIModule::logo ( ) const
overridevirtual

The logo of the module, the credits given by the grants or instution.

Reimplemented from qSlicerAbstractModule.

◆ moduleDescription()

ModuleDescription& qSlicerCLIModule::moduleDescription ( )

Return the module description object used to store the module properties.

◆ moduleLogoToImage()

static QImage qSlicerCLIModule::moduleLogoToImage ( const ModuleLogo &  logo)
static

Convert a ModuleLogo into a QIcon

Todo:
: Find a better place for this util function

◆ moduleType()

QString qSlicerCLIModule::moduleType ( ) const

◆ setEntryPoint()

void qSlicerCLIModule::setEntryPoint ( const QString &  entryPoint)

Set module entry point. Typically "slicer:0x012345" for loadable CLI or "/home/user/work/Slicer-Superbuild/../mycliexec" for executable CLI

◆ setLogo()

void qSlicerCLIModule::setLogo ( const ModuleLogo &  logo)

◆ setModuleType()

void qSlicerCLIModule::setModuleType ( const QString &  type)

SharedObjectModule for loadable modules or CommandLineModule for executable modules.

◆ setTempDirectory()

void qSlicerCLIModule::setTempDirectory ( const QString &  tempDirectory)

Set temporary directory associated with the module.

◆ setup()

void qSlicerCLIModule::setup ( )
overrideprotectedvirtual

All initialization code should be done in the setup.

Implements qSlicerAbstractCoreModule.

◆ setXmlModuleDescription()

void qSlicerCLIModule::setXmlModuleDescription ( const QString &  xmlModuleDescription)

Assign the module XML description. Note: That will also trigger the parsing of the XML structure

◆ tempDirectory()

QString qSlicerCLIModule::tempDirectory ( ) const

◆ title()

QString qSlicerCLIModule::title ( ) const
overridevirtual

Title of the module, (displayed to the user) title() must be reimplemented in derived classes.

Implements qSlicerAbstractCoreModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerCLIModulePrivate> qSlicerCLIModule::d_ptr
protected

Definition at line 116 of file qSlicerCLIModule.h.


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