Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
qSlicerFileWriter Class Referenceabstract

#include <Base/QTCore/qSlicerFileWriter.h>

Inheritance diagram for qSlicerFileWriter:
Collaboration diagram for qSlicerFileWriter:

Public Member Functions

virtual bool canWriteObject (vtkObject *object) const
 
virtual double canWriteObjectConfidence (vtkObject *object) const
 
virtual QStringList extensions (vtkObject *object) const =0
 
 qSlicerFileWriter (QObject *parent=nullptr)
 
virtual bool write (const qSlicerIO::IOProperties &properties)
 
virtual QStringList writtenNodes () const
 
 ~qSlicerFileWriter () override
 
- Public Member Functions inherited from qSlicerIO
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 qSlicerIOOptionsoptions () const
 
 qSlicerIO (QObject *parent=nullptr)
 
Q_INVOKABLE vtkMRMLMessageCollectionuserMessages () const
 Additional warning or error messages occurred during IO operation.
 
 ~qSlicerIO () override
 
- Public Member Functions inherited from qSlicerObject
vtkMRMLScenemrmlScene () const
 Return a pointer on the MRML scene.
 
 qSlicerObject ()
 
virtual void setMRMLScene (vtkMRMLScene *)
 Set the current MRML scene to the widget.
 
virtual ~qSlicerObject ()
 

Protected Member Functions

virtual void setWrittenNodes (const QStringList &nodes)
 

Protected Attributes

QScopedPointer< qSlicerFileWriterPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerIO
QScopedPointer< qSlicerIOPrivate > 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. This method is kept for backward compatibility, writers should override canWriteObjectConfidence method instead of this method to indicate if they can write the object.

Reimplemented in qSlicerNodeWriter, qSlicerSceneWriter, and qSlicerScriptedFileWriter.

◆ canWriteObjectConfidence()

virtual double qSlicerFileWriter::canWriteObjectConfidence ( vtkObject * object) const
virtual

Returns a positive number (>0) if the writer can write the object to file. The higher the returned value is the more confident the writer it is the most suitable class to write the object. By default, the method calls canWriteObject and if it returns true then it returns confidence value of 0.5.

Reimplemented in qSlicerScriptedFileWriter.

◆ extensions()

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

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

Implemented in qSlicerMarkupsWriter, qSlicerNodeWriter, qSlicerSceneWriter, and qSlicerScriptedFileWriter.

◆ setWrittenNodes()

virtual void qSlicerFileWriter::setWrittenNodes ( const QStringList & nodes)
protectedvirtual

Reimplemented in qSlicerScriptedFileWriter.

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

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

Reimplemented in qSlicerMarkupsWriter, qSlicerNodeWriter, qSlicerSceneWriter, qSlicerScriptedFileWriter, and qSlicerSegmentationsNodeWriter.

◆ writtenNodes()

virtual QStringList qSlicerFileWriter::writtenNodes ( ) const
virtual

Return the list of saved nodes from writing the file(s) in write(). Empty list if write() failed

See also
setWrittenNodes(), write()

Reimplemented in qSlicerScriptedFileWriter.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerFileWriterPrivate> qSlicerFileWriter::d_ptr
protected

Definition at line 75 of file qSlicerFileWriter.h.


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