qSlicerNodeWriter Class Reference

Utility class that is ready to use for most of the nodes. More...

#include <Base/QTGUI/qSlicerNodeWriter.h>

Inheritance diagram for qSlicerNodeWriter:

Collaboration diagram for qSlicerNodeWriter:

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

Properties
bool	supportUseCompression
	Some storage nodes don't support the compression option. More...

Public Member Functions
bool	canWriteObject (vtkObject *object) const override
	Return true if the object is handled by the writer. More...
QString	description () const override
	Unique name of the reader/writer. More...
QStringList	extensions (vtkObject *object) const override
IOFileType	fileType () const override
	Multiple readers can share the same file type. More...
virtual vtkMRMLNode *	getNodeByID (const char *id) const
qSlicerIOOptions *	options () const override
	Return a qSlicerNodeWriterOptionsWidget. More...
	qSlicerNodeWriter (const QString &description, const qSlicerIO::IOFileType &fileType, const QStringList &nodeTags, bool useCompression, QObject *parent)
void	setSupportUseCompression (bool useCompression)
bool	supportUseCompression () const
bool	write (const qSlicerIO::IOProperties &properties) override
	~qSlicerNodeWriter () override
Public Member Functions inherited from qSlicerFileWriter
	qSlicerFileWriter (QObject *parent=nullptr)
virtual QStringList	writtenNodes () const
	~qSlicerFileWriter () override
Public Member Functions inherited from qSlicerIO
	qSlicerIO (QObject *parent=nullptr)
Q_INVOKABLE vtkMRMLMessageCollection *	userMessages () const
	Additional warning or error messages occurred during IO operation. More...
	~qSlicerIO () override
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () 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
QStringList	nodeClassNames () const
void	setNodeClassNames (const QStringList &nodeClassNames)
Protected Member Functions inherited from qSlicerFileWriter
virtual void	setWrittenNodes (const QStringList &nodes)

Protected Attributes
QScopedPointer< qSlicerNodeWriterPrivate >	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

Detailed Description

Utility class that is ready to use for most of the nodes.

Definition at line 31 of file qSlicerNodeWriter.h.

Member Typedef Documentation

Superclass

typedef qSlicerFileWriter qSlicerNodeWriter::Superclass

Definition at line 36 of file qSlicerNodeWriter.h.

Property Documentation

supportUseCompression

bool qSlicerNodeWriter::supportUseCompression

readwrite

Some storage nodes don't support the compression option.

Definition at line 36 of file qSlicerNodeWriter.h.

Constructor & Destructor Documentation

qSlicerNodeWriter()

qSlicerNodeWriter::qSlicerNodeWriter	(	const QString &	description,
		const qSlicerIO::IOFileType &	fileType,
		const QStringList &	nodeTags,
		bool	useCompression,
		QObject *	parent
	)

~qSlicerNodeWriter()

qSlicerNodeWriter::~qSlicerNodeWriter ( )

override

Member Function Documentation

canWriteObject()

bool qSlicerNodeWriter::canWriteObject ( vtkObject *  object ) const

overridevirtual

Return true if the object is handled by the writer.

Reimplemented from qSlicerFileWriter.

description()

QString qSlicerNodeWriter::description ( ) const

overridevirtual

Unique name of the reader/writer.

Implements qSlicerIO.

extensions()

QStringList qSlicerNodeWriter::extensions ( vtkObject *  object ) const

overridevirtual

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)"

Implements qSlicerFileWriter.

Reimplemented in qSlicerMarkupsWriter.

fileType()

IOFileType qSlicerNodeWriter::fileType ( ) const

overridevirtual

Multiple readers can share the same file type.

Implements qSlicerIO.

getNodeByID()

virtual vtkMRMLNode* qSlicerNodeWriter::getNodeByID ( const char *  id ) const

virtual

nodeClassNames()

QStringList qSlicerNodeWriter::nodeClassNames ( ) const

protected

options()

qSlicerIOOptions* qSlicerNodeWriter::options ( ) const

overridevirtual

Return a qSlicerNodeWriterOptionsWidget.

Reimplemented from qSlicerIO.

Reimplemented in qSlicerSegmentationsNodeWriter.

setNodeClassNames()

void qSlicerNodeWriter::setNodeClassNames ( const QStringList &  nodeClassNames )

protected

setSupportUseCompression()

void qSlicerNodeWriter::setSupportUseCompression

(

bool

useCompression

)

supportUseCompression()

bool qSlicerNodeWriter::supportUseCompression

(

)

const

write()

bool qSlicerNodeWriter::write ( const qSlicerIO::IOProperties &  properties )

overridevirtual

Write the node referenced by "nodeID" into the "fileName" file. Optionally, "useCompression" can be specified. Return true on success, false otherwise. Create a storage node if the storable node doesn't have any.

Reimplemented from qSlicerFileWriter.

Reimplemented in qSlicerSegmentationsNodeWriter, and qSlicerMarkupsWriter.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerNodeWriterPrivate> qSlicerNodeWriter::d_ptr

protected

Definition at line 77 of file qSlicerNodeWriter.h.

---

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

• Base/QTGUI/qSlicerNodeWriter.h