qSlicerMarkupsWriter Class Reference

Utility class that offers writing of markups in both json format, regardless of the current storage node. More...

#include <Modules/Loadable/Markups/qSlicerMarkupsWriter.h>

Inheritance diagram for qSlicerMarkupsWriter:

Collaboration diagram for qSlicerMarkupsWriter:

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

Public Member Functions
QStringList	extensions (vtkObject *object) const override
	qSlicerMarkupsWriter (QObject *parent)
void	setStorageNodeClass (vtkMRMLStorableNode *storableNode, const QString &storageNodeClassName)
bool	write (const qSlicerIO::IOProperties &properties) override
	~qSlicerMarkupsWriter () override
Public Member Functions inherited from qSlicerNodeWriter
bool	canWriteObject (vtkObject *object) const override
	Return true if this class can write the input object.
QString	description () const override
	Unique name of the reader/writer.
QStringList	extensions (vtkObject *object) const override
IOFileType	fileType () const override
	Multiple readers can share the same file type.
virtual vtkMRMLNode *	getNodeByID (const char *id) const
qSlicerIOOptions *	options () const override
	Return a qSlicerNodeWriterOptionsWidget.
	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
virtual double	canWriteObjectConfidence (vtkObject *object) const
	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.
	~qSlicerIO () override
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.
	qSlicerObject ()
virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget.
virtual	~qSlicerObject ()

Additional Inherited Members
Properties inherited from qSlicerNodeWriter
bool	supportUseCompression
	Some storage nodes don't support the compression option.
Protected Member Functions inherited from qSlicerNodeWriter
QStringList	nodeClassNames () const
void	setNodeClassNames (const QStringList &nodeClassNames)
Protected Member Functions inherited from qSlicerFileWriter
virtual void	setWrittenNodes (const QStringList &nodes)
Protected Attributes inherited from qSlicerNodeWriter
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 offers writing of markups in both json format, regardless of the current storage node.

Definition at line 32 of file qSlicerMarkupsWriter.h.

Member Typedef Documentation

Superclass

typedef qSlicerNodeWriter qSlicerMarkupsWriter::Superclass

Definition at line 36 of file qSlicerMarkupsWriter.h.

Constructor & Destructor Documentation

qSlicerMarkupsWriter()

qSlicerMarkupsWriter::qSlicerMarkupsWriter

(

QObject *

parent

)

~qSlicerMarkupsWriter()

qSlicerMarkupsWriter::~qSlicerMarkupsWriter ( )

override

Member Function Documentation

extensions()

QStringList qSlicerMarkupsWriter::extensions ( vtkObject * object ) const

overridevirtual

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

Implements qSlicerFileWriter.

setStorageNodeClass()

void qSlicerMarkupsWriter::setStorageNodeClass	(	vtkMRMLStorableNode *	storableNode,
		const QString &	storageNodeClassName )

write()

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

overridevirtual

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 from qSlicerFileWriter.

---

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

• Modules/Loadable/Markups/qSlicerMarkupsWriter.h