qSlicerFileReader Class Reference

#include <Base/QTCore/qSlicerFileReader.h>

Inheritance diagram for qSlicerFileReader:

Collaboration diagram for qSlicerFileReader:

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

Public Member Functions
bool	canLoadFile (const QString &file) const
virtual QStringList	extensions () const
virtual bool	load (const IOProperties &properties)
	Properties availables : fileMode, multipleFiles, fileType. More...
QStringList	loadedNodes () const
	qSlicerFileReader (QObject *parent=0)
QStringList	supportedNameFilters (const QString &fileName, int *longestExtensionMatchPtr=NULL) const
virtual	~qSlicerFileReader ()
Public Member Functions inherited from qSlicerIO
virtual QString	description () const =0
	Unique name of the reader/writer. More...
virtual IOFileType	fileType () const =0
	Multiple readers can share the same file type. More...
virtual qSlicerIOOptions *	options () const
	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
void	setLoadedNodes (const QStringList &nodes)

Protected Attributes
QScopedPointer< qSlicerFileReaderPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Detailed Description

Definition at line 31 of file qSlicerFileReader.h.

Member Typedef Documentation

Superclass

typedef qSlicerIO qSlicerFileReader::Superclass

Definition at line 36 of file qSlicerFileReader.h.

Constructor & Destructor Documentation

qSlicerFileReader()

qSlicerFileReader::qSlicerFileReader ( QObject *  parent = 0 )

explicit

~qSlicerFileReader()

virtual qSlicerFileReader::~qSlicerFileReader ( )

virtual

Member Function Documentation

canLoadFile()

bool qSlicerFileReader::canLoadFile

(

const QString &

file

)

const

Based on the file extensions, returns true if the file can be read, false otherwise. This function is relatively fast as it doesn't try to access the file.

extensions()

virtual QStringList qSlicerFileReader::extensions ( ) const

virtual

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

Reimplemented in qSlicerSceneReader, qSlicerTablesReader, qSlicerVolumeRenderingReader, qSlicerXcedeCatalogReader, qSlicerSlicer2SceneReader, qSlicerAnnotationsReader, qSlicerFiducialsReader, qSlicerDoubleArraysReader, qSlicerModelsReader, qSlicerSegmentationsReader, qSlicerTerminologiesReader, qSlicerSceneBundleReader, qSlicerColorsReader, qSlicerScalarOverlayReader, qSlicerTransformsReader, qSlicerVolumesReader, and qSlicerMarkupsReader.

load()

virtual bool qSlicerFileReader::load ( const IOProperties &  properties )

virtual

Properties availables : fileMode, multipleFiles, fileType.

Reimplemented in qSlicerSceneReader, qSlicerTablesReader, qSlicerSceneBundleReader, qSlicerVolumeRenderingReader, qSlicerXcedeCatalogReader, qSlicerAnnotationsReader, qSlicerSegmentationsReader, qSlicerSlicer2SceneReader, qSlicerFiducialsReader, qSlicerDoubleArraysReader, qSlicerModelsReader, qSlicerScalarOverlayReader, qSlicerTerminologiesReader, qSlicerVolumesReader, qSlicerColorsReader, qSlicerTransformsReader, and qSlicerMarkupsReader.

loadedNodes()

QStringList qSlicerFileReader::loadedNodes

(

)

const

Return the list of generated nodes from loading the file(s) in load(). Empty list of load() failed

See also

setLoadedNodes(), load()

setLoadedNodes()

void qSlicerFileReader::setLoadedNodes ( const QStringList &  nodes )

protected

Must be called in load() on success with the list of nodes added into the scene.

supportedNameFilters()

QStringList qSlicerFileReader::supportedNameFilters	(	const QString &	fileName,
		int *	longestExtensionMatchPtr = NULL
	)		const

Return the matching name filters -> if the fileName is "myimage.nrrd" and the supported extensions are "Volumes (*.mha *.nrrd *.raw)", "Images (*.png" *.jpg")", "DICOM (*)" then it returns "Volumes (*.mha *.nrrd *.raw), DICOM (*)"

Parameters

longestExtensionMatchPtr

If non-zero then the method returns the length of the longest matched extension length in this argument. It can be used to determine how specifically extension matched.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerFileReaderPrivate> qSlicerFileReader::d_ptr

protected

Definition at line 73 of file qSlicerFileReader.h.

---

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

• Base/QTCore/qSlicerFileReader.h