qSlicerSceneBundleReader Class Reference

#include <Base/QTCore/qSlicerSceneBundleReader.h>

Inheritance diagram for qSlicerSceneBundleReader:

Collaboration diagram for qSlicerSceneBundleReader:

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

Public Member Functions
QString	description () const override
	Unique name of the reader/writer.
QStringList	extensions () const override
	Support only .mrb files.
qSlicerIO::IOFileType	fileType () const override
	Support QString("SceneFile")
bool	load (const qSlicerIO::IOProperties &properties) override
	qSlicerSceneBundleReader (QObject *_parent=nullptr)
Public Member Functions inherited from qSlicerFileReader
virtual Q_INVOKABLE bool	canLoadFile (const QString &file) const
virtual Q_INVOKABLE double	canLoadFileConfidence (const QString &file) const
virtual Q_INVOKABLE bool	examineFileInfoList (QFileInfoList &fileInfoList, QFileInfo &archetypeFileInfo, qSlicerIO::IOProperties &ioProperties) const
virtual Q_INVOKABLE QStringList	loadedNodes () const
	qSlicerFileReader (QObject *parent=nullptr)
Q_INVOKABLE QStringList	supportedNameFilters (const QString &fileName, int *longestExtensionMatchPtr=nullptr) const
	~qSlicerFileReader () override
Public Member Functions inherited from qSlicerIO
virtual Q_INVOKABLE qSlicerIOOptions *	options () const
	qSlicerIO (QObject *parent=nullptr)
Q_INVOKABLE vtkMRMLMessageCollection *	userMessages () const
	Additional warning or error messages occurred during IO operation.
	~qSlicerIO () override
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.
	qSlicerObject ()
virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget.
virtual	~qSlicerObject ()

Additional Inherited Members
Protected Member Functions inherited from qSlicerFileReader
virtual void	setLoadedNodes (const QStringList &nodes)
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

Detailed Description

qSlicerSceneBundleReader is the IO class that handle MRML scene embedded in a zip file (called a Slicer Data Bundle). The extension is mrb (for Medical Reality Bundle) It internally calls vtkMRMLScene::Connect() or vtkMRMLScene::Import() depending on the clear flag.

Definition at line 33 of file qSlicerSceneBundleReader.h.

Member Typedef Documentation

Superclass

typedef qSlicerFileReader qSlicerSceneBundleReader::Superclass

Definition at line 37 of file qSlicerSceneBundleReader.h.

Constructor & Destructor Documentation

qSlicerSceneBundleReader()

qSlicerSceneBundleReader::qSlicerSceneBundleReader

(

QObject *

_parent = nullptr

)

Member Function Documentation

description()

QString qSlicerSceneBundleReader::description ( ) const

overridevirtual

Unique name of the reader/writer.

Implements qSlicerIO.

extensions()

QStringList qSlicerSceneBundleReader::extensions ( ) const

overridevirtual

Support only .mrb files.

Reimplemented from qSlicerFileReader.

fileType()

qSlicerIO::IOFileType qSlicerSceneBundleReader::fileType ( ) const

overridevirtual

Support QString("SceneFile")

Implements qSlicerIO.

load()

bool qSlicerSceneBundleReader::load ( const qSlicerIO::IOProperties & properties )

overridevirtual

the supported properties are: QString fileName: the path of the mrml scene to load bool clear: whether the current should be cleared or not

Reimplemented from qSlicerFileReader.

---

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

• Base/QTCore/qSlicerSceneBundleReader.h