iARawFileIO Class Reference

#include <iARawFileIO.h>

Inheritance diagram for iARawFileIO:

Collaboration diagram for iARawFileIO:

Public Member Functions
	iARawFileIO ()
QStringList	extensions () const override
	The file extensions that this file IO should be used for.
std::shared_ptr< iADataSet >	loadData (QString const &fileName, QVariantMap const &paramValues, iAProgress const &progress) override
	I/O for specific file formats should override this to load data from the file with given name.
QString	name () const override
	The name of the file type that this IO supports.
void	saveData (QString const &fileName, std::shared_ptr< iADataSet > dataSet, QVariantMap const &paramValues, iAProgress const &progress) override
	I/O for specific file formats should override this to save data to the file with given name.
Public Member Functions inherited from iAFileIO
	iAFileIO (iADataSetTypes readTypes, iADataSetTypes writeTypes)
	create a file I/O for the given dataset type
virtual	~iAFileIO ()
	virtual destructor, to enable proper destruction in derived classes and to avoid warnings
bool	checkParams (QVariantMap &paramValues, Operation op, QString const &fileName)
	Check whether the given values contain all required parameters; set to default if not.
virtual QStringList	extensions () const =0
	The file extensions that this file IO should be used for.
QStringList	filterExtensions ()
	list of extensions as required by Qt's open/save file dialogs
QString	filterString ()
	a filter string for the type of files supported by the I/O class
virtual bool	isDataSetSupported (std::shared_ptr< iADataSet > dataSet, QString const &fileName) const
	Whether this IO can be used for storing the given data set.
std::shared_ptr< iADataSet >	load (QString const &fileName, QVariantMap const &paramValues, iAProgress const &progress=iAProgress())
	Load the (list of) dataset(s); store parameters in the resulting datasets.
virtual QString	name () const =0
	The name of the file type that this IO supports.
iAAttributes const &	parameter (Operation op) const
	Required parameters for loading/saving the file.
void	save (QString const &fileName, std::shared_ptr< iADataSet > dataSet, QVariantMap const &paramValues, iAProgress const &progress=iAProgress())
	Save the (list of) dataset(s); modify input datasets to reflect the new file name this data is now stored under.
iADataSetTypes	supportedDataSetTypes (Operation op) const
	Types of dataset contained in this file format, which this IO can load/save.

Static Public Attributes
static const QString	ByteOrderStr
static const QString	DataTypeStr
static const QString	HeadersizeStr
static const QString	Name
static const QString	OriginStr
static const QString	SizeStr
static const QString	SpacingStr
Static Public Attributes inherited from iAFileIO
static const QString	CompressionStr

Additional Inherited Members
Public Types inherited from iAFileIO
enum	Operation { Load , Save }
virtual std::shared_ptr< iADataSet >	loadData (QString const &fileName, QVariantMap const &paramValues, iAProgress const &progress)
	I/O for specific file formats should override this to load data from the file with given name.
virtual void	saveData (QString const &fileName, std::shared_ptr< iADataSet > dataSet, QVariantMap const &paramValues, iAProgress const &progress)
	I/O for specific file formats should override this to save data to the file with given name.
Protected Attributes inherited from iAFileIO
std::array< iAAttributes, 2 >	m_params

Constructor & Destructor Documentation

iARawFileIO()

iARawFileIO::iARawFileIO

(

)

Member Function Documentation

extensions()

QStringList iARawFileIO::extensions ( ) const

overridevirtual

The file extensions that this file IO should be used for.

Implements iAFileIO.

loadData()

std::shared_ptr< iADataSet > iARawFileIO::loadData ( QString const &  fileName, QVariantMap const &  paramValues, iAProgress const &  progress  )

overridevirtual

I/O for specific file formats should override this to load data from the file with given name.

default implementation does nothing (instead of being pure virtual, to allow for I/O's that only save a dataset but don't load one)

Reimplemented from iAFileIO.

name()

QString iARawFileIO::name ( ) const

overridevirtual

The name of the file type that this IO supports.

Implements iAFileIO.

saveData()

void iARawFileIO::saveData ( QString const &  fileName, std::shared_ptr< iADataSet >  dataSet, QVariantMap const &  paramValues, iAProgress const &  progress  )

overridevirtual

I/O for specific file formats should override this to save data to the file with given name.

default implementation does nothing (instead of being pure virtual, to allow for I/O's that only load a dataset but don't save one). The file name and all Save parameter values (m_params[Save]) will be set in save() Derived classes must add any potentially necessary metadata in the dataSets so that there is all information in there to load the dataSet again from the given fileName

Reimplemented from iAFileIO.

Member Data Documentation

ByteOrderStr

const QString iARawFileIO::ByteOrderStr

static

DataTypeStr

const QString iARawFileIO::DataTypeStr

static

HeadersizeStr

const QString iARawFileIO::HeadersizeStr

static

Name

const QString iARawFileIO::Name

static

OriginStr

const QString iARawFileIO::OriginStr

static

SizeStr

const QString iARawFileIO::SizeStr

static

SpacingStr

const QString iARawFileIO::SpacingStr

static

---

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

• libs/io/iARawFileIO.h
• libs/io/iARawFileIO.cpp