Slicer  4.13
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 | Protected Attributes
qSlicerIO Class Referenceabstract

Base class for qSlicerFileReader and qSlicerFileWriter. More...

#include <Base/QTCore/qSlicerIO.h>

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

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. More...
 
virtual Q_INVOKABLE IOFileType fileType () const =0
 Multiple readers can share the same file type. More...
 
virtual Q_INVOKABLE qSlicerIOOptionsoptions () const
 
 qSlicerIO (QObject *parent=nullptr)
 
Q_INVOKABLE 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< 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

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

◆ fileType()

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

◆ 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 qSlicerNodeWriter, qSlicerSceneReader, qSlicerAnnotationsReader, qSlicerModelsReader, qSlicerSegmentationsReader, qSlicerVolumesReader, and qSlicerSegmentationsNodeWriter.

◆ 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: