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 | Properties | Public Member Functions | Protected Attributes
qSlicerScriptedFileReader Class Reference

#include <Base/QTCore/qSlicerScriptedFileReader.h>

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

Public Types

typedef qSlicerFileReader Superclass
 
- Public Types inherited from qSlicerFileReader
typedef qSlicerIO Superclass
 
- Public Types inherited from qSlicerIO
typedef QString IOFileType
 
typedef QVariantMap IOProperties
 
typedef QObject Superclass
 

Properties

QStringList loadedNodes
 This property allows the reader to report back what nodes it was able to load. More...
 

Public Member Functions

bool canLoadFile (const QString &file) const override
 
QString description () const override
 
QStringList extensions () const override
 
IOFileType fileType () const override
 
bool load (const qSlicerIO::IOProperties &properties) override
 
QStringList loadedNodes () const override
 
QString pythonSource () const
 
 qSlicerScriptedFileReader (QObject *parent=nullptr)
 
Q_INVOKABLE PyObjectself () const
 Convenience method allowing to retrieve the associated scripted instance. More...
 
void setLoadedNodes (const QStringList &nodes) override
 
bool setPythonSource (const QString &newPythonSource, const QString &className=QLatin1String(""), bool missingClassIsExpected=true)
 
 ~qSlicerScriptedFileReader () override
 
- Public Member Functions inherited from qSlicerFileReader
virtual bool examineFileInfoList (QFileInfoList &fileInfoList, QFileInfo &archetypeFileInfo, qSlicerIO::IOProperties &ioProperties) const
 
 qSlicerFileReader (QObject *parent=nullptr)
 
QStringList supportedNameFilters (const QString &fileName, int *longestExtensionMatchPtr=nullptr) const
 
 ~qSlicerFileReader () override
 
- Public Member Functions inherited from qSlicerIO
virtual qSlicerIOOptionsoptions () const
 
 qSlicerIO (QObject *parent=nullptr)
 
vtkMRMLMessageCollectionuserMessages () const
 Additional warning or error messages occurred during IO operation. More...
 
 ~qSlicerIO () override
 
- Public Member Functions inherited from qSlicerObject
vtkMRMLScenemrmlScene () const
 Return a pointer on the MRML scene. More...
 
 qSlicerObject ()
 
virtual void setMRMLScene (vtkMRMLScene *)
 Set the current MRML scene to the widget. More...
 
virtual ~qSlicerObject ()
 

Protected Attributes

QScopedPointer< qSlicerScriptedFileReaderPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerFileReader
QScopedPointer< qSlicerFileReaderPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerIO
QScopedPointer< qSlicerIOPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate > d_ptr
 

Additional Inherited Members

Detailed Description

Definition at line 36 of file qSlicerScriptedFileReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file qSlicerScriptedFileReader.h.

Property Documentation

◆ loadedNodes

QStringList qSlicerScriptedFileReader::loadedNodes
readwrite

This property allows the reader to report back what nodes it was able to load.

Definition at line 42 of file qSlicerScriptedFileReader.h.

Constructor & Destructor Documentation

◆ qSlicerScriptedFileReader()

qSlicerScriptedFileReader::qSlicerScriptedFileReader ( QObject *  parent = nullptr)

◆ ~qSlicerScriptedFileReader()

qSlicerScriptedFileReader::~qSlicerScriptedFileReader ( )
override

Member Function Documentation

◆ canLoadFile()

bool qSlicerScriptedFileReader::canLoadFile ( const QString &  file) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileReader::canLoadFile()

Reimplemented from qSlicerFileReader.

◆ description()

QString qSlicerScriptedFileReader::description ( ) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerIO::description()

Implements qSlicerIO.

◆ extensions()

QStringList qSlicerScriptedFileReader::extensions ( ) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileReader::extensions()

Reimplemented from qSlicerFileReader.

◆ fileType()

IOFileType qSlicerScriptedFileReader::fileType ( ) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerIO::fileType()

Implements qSlicerIO.

◆ load()

bool qSlicerScriptedFileReader::load ( const qSlicerIO::IOProperties properties)
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileReader::write()

Reimplemented from qSlicerFileReader.

◆ loadedNodes()

QStringList qSlicerScriptedFileReader::loadedNodes ( ) const
inlineoverridevirtual

Reimplemented to support python methods and q_property Exposes setLoadedNodes, which is protected in superclass

See also
qSlicerFileReader::loadedNodes()
qSlicerFileWriter::writtenNodes()

Reimplemented from qSlicerFileReader.

Definition at line 82 of file qSlicerScriptedFileReader.h.

◆ pythonSource()

QString qSlicerScriptedFileReader::pythonSource ( ) const

◆ self()

Q_INVOKABLE PyObject* qSlicerScriptedFileReader::self ( ) const

Convenience method allowing to retrieve the associated scripted instance.

◆ setLoadedNodes()

void qSlicerScriptedFileReader::setLoadedNodes ( const QStringList &  nodes)
inlineoverridevirtual

Must be called in load() on success with the list of nodes added into the scene.

Reimplemented from qSlicerFileReader.

Definition at line 85 of file qSlicerScriptedFileReader.h.

◆ setPythonSource()

bool qSlicerScriptedFileReader::setPythonSource ( const QString &  newPythonSource,
const QString &  className = QLatin1String(""),
bool  missingClassIsExpected = true 
)
Warning
Setting the source is a no-op. See detailed comment in the source code. If missingClassIsExpected is true (default) then missing class is expected and not treated as an error.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerScriptedFileReaderPrivate> qSlicerScriptedFileReader::d_ptr
protected

Definition at line 87 of file qSlicerScriptedFileReader.h.


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