qSlicerIO Class Reference

Base class for qSlicerFileReader and qSlicerFileWriter. More...

#include <Base/QTCore/qSlicerIO.h>

Inheritance diagram for qSlicerIO:

Collaboration diagram for qSlicerIO:

Public Types
typedef QString	IOFileType
typedef QVariantMap	IOProperties
typedef QObject	Superclass

Public Member Functions
virtual Q_INVOKABLE QString	description () const =0
	Unique name of the reader/writer.
virtual Q_INVOKABLE qSlicerIO::IOFileType	fileType () const =0
	Multiple readers can share the same file type.
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 ()

Protected Attributes
QScopedPointer< qSlicerIOPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Detailed Description

Base class for qSlicerFileReader and qSlicerFileWriter.

Definition at line 41 of file qSlicerIO.h.

Member Typedef Documentation

IOFileType

typedef QString qSlicerIO::IOFileType

Definition at line 52 of file qSlicerIO.h.

IOProperties

typedef QVariantMap qSlicerIO::IOProperties

Definition at line 53 of file qSlicerIO.h.

Superclass

typedef QObject qSlicerIO::Superclass

Definition at line 48 of file qSlicerIO.h.

Constructor & Destructor Documentation

qSlicerIO()

qSlicerIO::qSlicerIO ( QObject * parent = nullptr )

explicit

~qSlicerIO()

qSlicerIO::~qSlicerIO ( )

override

Member Function Documentation

description()

virtual Q_INVOKABLE QString qSlicerIO::description ( ) const

pure virtual

Unique name of the reader/writer.

Implemented in qSlicerAnnotationsReader, qSlicerColorsReader, qSlicerMarkupsReader, qSlicerModelsReader, qSlicerNodeWriter, qSlicerSceneBundleReader, qSlicerSceneReader, qSlicerSceneWriter, qSlicerScriptedFileReader, qSlicerScriptedFileWriter, qSlicerSegmentationsReader, qSlicerSequencesReader, qSlicerShaderPropertyReader, qSlicerTablesReader, qSlicerTerminologiesReader, qSlicerTextsReader, qSlicerTransformsReader, qSlicerVolumeRenderingReader, and qSlicerVolumesReader.

fileType()

virtual Q_INVOKABLE qSlicerIO::IOFileType qSlicerIO::fileType ( ) const

pure virtual

Multiple readers can share the same file type.

Implemented in qSlicerAnnotationsReader, qSlicerColorsReader, qSlicerMarkupsReader, qSlicerModelsReader, qSlicerNodeWriter, qSlicerSceneBundleReader, qSlicerSceneReader, qSlicerSceneWriter, qSlicerScriptedFileReader, qSlicerScriptedFileWriter, qSlicerSegmentationsReader, qSlicerSequencesReader, qSlicerShaderPropertyReader, qSlicerTablesReader, qSlicerTerminologiesReader, qSlicerTextsReader, qSlicerTransformsReader, qSlicerVolumeRenderingReader, and qSlicerVolumesReader.

options()

virtual Q_INVOKABLE qSlicerIOOptions * qSlicerIO::options ( ) const

virtual

Returns a list of options for the reader. qSlicerIOOptions can be derived and have a UI associated to it (i.e. qSlicerIOOptionsWidget). Warning: you are responsible for freeing the memory of the returned options

Reimplemented in qSlicerAnnotationsReader, qSlicerModelsReader, qSlicerNodeWriter, qSlicerSceneReader, qSlicerSegmentationsNodeWriter, qSlicerSegmentationsReader, and qSlicerVolumesReader.

userMessages()

Q_INVOKABLE vtkMRMLMessageCollection * qSlicerIO::userMessages

(

)

const

Additional warning or error messages occurred during IO operation.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerIOPrivate> qSlicerIO::d_ptr

protected

Definition at line 71 of file qSlicerIO.h.

---

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

• Base/QTCore/qSlicerIO.h