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
virtual bool	canWriteObject (vtkObject *object) const
	Return true if the object is handled by the writer. More...
virtual QString	description () const
	Unique name of the reader/writer. More...
virtual QStringList	extensions (vtkObject *object) const
virtual IOFileType	fileType () const
	Multiple readers can share the same file type. More...
virtual vtkMRMLNode *	getNodeByID (const char *id) const
virtual qSlicerIOOptions *	options () const
	Return a qSlicerIONodeWriterOptionsWidget. More...
	qSlicerNodeWriter (const QString &description, const qSlicerIO::IOFileType &fileType, const QStringList &nodeTags, bool useCompression, QObject *parent)
void	setSupportUseCompression (bool useCompression)
bool	supportUseCompression () const
virtual bool	write (const qSlicerIO::IOProperties &properties)
virtual	~qSlicerNodeWriter ()
Public Member Functions inherited from qSlicerFileWriter
	qSlicerFileWriter (QObject *parent=0)
QStringList	writtenNodes () const
virtual	~qSlicerFileWriter ()
Public Member Functions inherited from qSlicerIO
	qSlicerIO (QObject *parent=0)
virtual	~qSlicerIO ()
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
void	setWrittenNodes (const QStringList &nodes)

Protected Attributes
QScopedPointer< qSlicerNodeWriterPrivate >	d_ptr
Protected Attributes inherited from qSlicerFileWriter
QScopedPointer< qSlicerFileWriterPrivate >	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()

virtual qSlicerNodeWriter::~qSlicerNodeWriter ( )

virtual

Member Function Documentation

canWriteObject()

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

virtual

Return true if the object is handled by the writer.

Reimplemented from qSlicerFileWriter.

description()

virtual QString qSlicerNodeWriter::description ( ) const

virtual

Unique name of the reader/writer.

Implements qSlicerIO.

extensions()

virtual QStringList qSlicerNodeWriter::extensions ( vtkObject *  object ) const

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

Implements qSlicerFileWriter.

fileType()

virtual IOFileType qSlicerNodeWriter::fileType ( ) const

virtual

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

virtual qSlicerIOOptions* qSlicerNodeWriter::options ( ) const

virtual

Return a qSlicerIONodeWriterOptionsWidget.

Reimplemented from qSlicerIO.

setNodeClassNames()

void qSlicerNodeWriter::setNodeClassNames ( const QStringList &  nodeClassNames )

protected

setSupportUseCompression()

void qSlicerNodeWriter::setSupportUseCompression

(

bool

useCompression

)

supportUseCompression()

bool qSlicerNodeWriter::supportUseCompression

(

)

const

write()

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

virtual

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.

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