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 Member Functions | Protected Member Functions | Protected Attributes
qSlicerFileWriter Class Referenceabstract

#include <Base/QTCore/qSlicerFileWriter.h>

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

Public Member Functions

virtual bool canWriteObject (vtkObject *object) const
 Return true if the object is handled by the writer. More...
 
virtual QStringList extensions (vtkObject *object) const =0
 
 qSlicerFileWriter (QObject *parent=nullptr)
 
virtual bool write (const qSlicerIO::IOProperties &properties)
 
QStringList writtenNodes () const
 
 ~qSlicerFileWriter () override
 
- Public Member Functions inherited from qSlicerIO
virtual QString description () const =0
 Unique name of the reader/writer. More...
 
virtual IOFileType fileType () const =0
 Multiple readers can share the same file type. More...
 
virtual qSlicerIOOptionsoptions () const
 
 qSlicerIO (QObject *parent=nullptr)
 
 ~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 Member Functions

void setWrittenNodes (const QStringList &nodes)
 

Protected Attributes

QScopedPointer< qSlicerFileWriterPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate > d_ptr
 

Additional Inherited Members

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

Detailed Description

Definition at line 30 of file qSlicerFileWriter.h.

Constructor & Destructor Documentation

◆ qSlicerFileWriter()

qSlicerFileWriter::qSlicerFileWriter ( QObject *  parent = nullptr)

◆ ~qSlicerFileWriter()

qSlicerFileWriter::~qSlicerFileWriter ( )
override

Member Function Documentation

◆ canWriteObject()

virtual bool qSlicerFileWriter::canWriteObject ( vtkObject *  object) const
virtual

Return true if the object is handled by the writer.

Reimplemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, and qSlicerSceneWriter.

◆ extensions()

virtual QStringList qSlicerFileWriter::extensions ( vtkObject *  object) const
pure virtual

Return a list of the supported extensions for a particuliar object. Please read QFileDialog::nameFilters for the allowed formats Example: "Image (*.jpg *.png *.tiff)", "Model (*.vtk)"

Implemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, and qSlicerSceneWriter.

◆ setWrittenNodes()

void qSlicerFileWriter::setWrittenNodes ( const QStringList &  nodes)
protected

◆ write()

virtual bool qSlicerFileWriter::write ( const qSlicerIO::IOProperties properties)
virtual

Write the node identified by nodeID into the fileName file. Returns true on success Properties availables:

  • QString nodeID
  • QString fileName
  • QString fileFormat
  • bool compressed ...

Reimplemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, qSlicerSceneWriter, and qSlicerSegmentationsNodeWriter.

◆ writtenNodes()

QStringList qSlicerFileWriter::writtenNodes ( ) const

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerFileWriterPrivate> qSlicerFileWriter::d_ptr
protected

Definition at line 62 of file qSlicerFileWriter.h.


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