Slicer  5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Properties | Public Member Functions | Protected Attributes
qSlicerScriptedFileWriter Class Reference

#include <Base/QTCore/qSlicerScriptedFileWriter.h>

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

Public Types

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

Properties

QStringList writtenNodes
 This property allows the writer to report back what nodes it was able to write. More...
 

Public Member Functions

void addWrittenNode (const QString &writtenNode)
 
bool canWriteObject (vtkObject *object) const override
 
QString description () const override
 
QStringList extensions (vtkObject *object) const override
 
IOFileType fileType () const override
 
QString pythonSource () const
 
 qSlicerScriptedFileWriter (QObject *parent=nullptr)
 
Q_INVOKABLE PyObjectself () const
 Convenience method allowing to retrieve the associated scripted instance. More...
 
bool setPythonSource (const QString &newPythonSource, const QString &className=QLatin1String(""), bool missingClassIsExpected=true)
 
void setWrittenNodes (const QStringList &nodes) override
 
bool write (const qSlicerIO::IOProperties &properties) override
 
QStringList writtenNodes () const override
 
 ~qSlicerScriptedFileWriter () override
 
- Public Member Functions inherited from qSlicerFileWriter
 qSlicerFileWriter (QObject *parent=nullptr)
 
 ~qSlicerFileWriter () override
 
- Public Member Functions inherited from qSlicerIO
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< qSlicerScriptedFileWriterPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerFileWriter
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

Detailed Description

Definition at line 35 of file qSlicerScriptedFileWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file qSlicerScriptedFileWriter.h.

Property Documentation

◆ writtenNodes

QStringList qSlicerScriptedFileWriter::writtenNodes
readwrite

This property allows the writer to report back what nodes it was able to write.

Definition at line 41 of file qSlicerScriptedFileWriter.h.

Constructor & Destructor Documentation

◆ qSlicerScriptedFileWriter()

qSlicerScriptedFileWriter::qSlicerScriptedFileWriter ( QObject *  parent = nullptr)

◆ ~qSlicerScriptedFileWriter()

qSlicerScriptedFileWriter::~qSlicerScriptedFileWriter ( )
override

Member Function Documentation

◆ addWrittenNode()

void qSlicerScriptedFileWriter::addWrittenNode ( const QString &  writtenNode)

Added so node writers can report back written nodes

See also
qSlicerFileWriter::writtenNodex()

◆ canWriteObject()

bool qSlicerScriptedFileWriter::canWriteObject ( vtkObject *  object) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileWriter::canWriteObject()

Reimplemented from qSlicerFileWriter.

◆ description()

QString qSlicerScriptedFileWriter::description ( ) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerIO::description()

Implements qSlicerIO.

◆ extensions()

QStringList qSlicerScriptedFileWriter::extensions ( vtkObject *  object) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileWriter::extensions()

Implements qSlicerFileWriter.

◆ fileType()

IOFileType qSlicerScriptedFileWriter::fileType ( ) const
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerIO::fileType()

Implements qSlicerIO.

◆ pythonSource()

QString qSlicerScriptedFileWriter::pythonSource ( ) const

◆ self()

Q_INVOKABLE PyObject* qSlicerScriptedFileWriter::self ( ) const

Convenience method allowing to retrieve the associated scripted instance.

◆ setPythonSource()

bool qSlicerScriptedFileWriter::setPythonSource ( const QString &  newPythonSource,
const QString &  className = QLatin1String(""),
bool  missingClassIsExpected = true 
)
Warning
Setting the source is a no-op. See detailed comment in the source code. If missingClassIsExpected is true (default) then missing class is expected and not treated as an error.

◆ setWrittenNodes()

void qSlicerScriptedFileWriter::setWrittenNodes ( const QStringList &  nodes)
inlineoverridevirtual

Reimplemented from qSlicerFileWriter.

Definition at line 88 of file qSlicerScriptedFileWriter.h.

◆ write()

bool qSlicerScriptedFileWriter::write ( const qSlicerIO::IOProperties properties)
overridevirtual

Reimplemented to propagate to python methods

See also
qSlicerFileWriter::write()

Reimplemented from qSlicerFileWriter.

◆ writtenNodes()

QStringList qSlicerScriptedFileWriter::writtenNodes ( ) const
inlineoverridevirtual

Reimplemented to support python methods and q_property Exposes setWrittenNodes, which is protected in superclass

See also
qSlicerFileWriter::writtenNodes()
qSlicerFileReader::loadedNodes()

Reimplemented from qSlicerFileWriter.

Definition at line 85 of file qSlicerScriptedFileWriter.h.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerScriptedFileWriterPrivate> qSlicerScriptedFileWriter::d_ptr
protected

Definition at line 90 of file qSlicerScriptedFileWriter.h.


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