FIFFLIB::FiffIO Class Reference

High-level reader/writer that loads and saves complete FIFF measurement files. More...

#include <fiff_io.h>

Public Member Functions
	FiffIO ()
	~FiffIO ()
	FiffIO (QIODevice &pIODevice)
	FiffIO (QList< QIODevice * > &p_qlistIODevices)
	FiffIO (const FiffIO &p_FiffIO)
bool	read (QIODevice &pIODevice)
bool	read (QList< QIODevice > &p_qlistIODevices)
bool	write (QIODevice &pIODevice, const fiff_int_t type, const fiff_int_t idx) const
bool	write (QFile &p_QFile, const fiff_int_t type, const fiff_int_t idx) const
bool	write_raw (QIODevice &pIODevice, const fiff_int_t idx) const

Static Public Member Functions
static bool	setup_read (QIODevice &pIODevice, FiffInfo &info, FiffDirNode::SPtr &dirTree)

Public Attributes
QList< QSharedPointer< FiffRawData > >	m_qlistRaw
QList< QSharedPointer< FiffEvoked > >	m_qlistEvoked

Friends
std::ostream &	operator<< (std::ostream &out, const FiffIO &p_fiffIO)

Detailed Description

High-level reader/writer that loads and saves complete FIFF measurement files.

Definition at line 84 of file fiff_io.h.

Inheritance diagram for FIFFLIB::FiffIO:

Constructor & Destructor Documentation

FiffIO() [1/4]

FiffIO::FiffIO

(

)

Constructs a FiffIO

Definition at line 67 of file fiff_io.cpp.

~FiffIO()

FiffIO::~FiffIO

(

)

Destroys the FiffIO.

Definition at line 73 of file fiff_io.cpp.

FiffIO() [2/4]

FiffIO::FiffIO

(

QIODevice &

pIODevice

)

Constructs a FiffIO object by reading from a I/O device pIODevice.

Parameters

[in]

pIODevice

A fiff IO device like a fiff QFile or QTCPSocket.

Definition at line 79 of file fiff_io.cpp.

FiffIO() [3/4]

FiffIO::FiffIO

(

QList< QIODevice * > &

p_qlistIODevices

)

Constructs a FiffIO object that uses the I/O device pIODevice.

Parameters

[in]

p_qlistIODevices

A QList of fiff IO devices like a fiff QFile or QTCPSocket.

Definition at line 87 of file fiff_io.cpp.

FiffIO() [4/4]

FIFFLIB::FiffIO::FiffIO

(

const FiffIO &

p_FiffIO

)

Copy constructor.

Parameters

[in]

p_FiffIO

FiffIO, which should be copied.

Member Function Documentation

read() [1/2]

bool FiffIO::read

(

QIODevice &

pIODevice

)

Read data from a pIODevice.

Parameters

[in]

pIODevice

A fiff IO device like a fiff QFile or QTCPSocket.

Definition at line 119 of file fiff_io.cpp.

read() [2/2]

bool FIFFLIB::FiffIO::read

(

QList< QIODevice > &

p_qlistIODevices

)

Read data from a QList of pIODevices.

Parameters

[in]

p_qlistIODevices

A QList of fiff IO devices like a fiff QFile or QTCPSocket.

setup_read()

bool FiffIO::setup_read ( QIODevice & pIODevice, FiffInfo & info, FiffDirNode::SPtr & dirTree )

static

Setup a FiffStream

Parameters

[in]	pIODevice	An fiff IO device like a fiff QFile or QTCPSocket.
[in]	info	Overall info for fiff IO device.
[out]	dirTree	Node directory structure.

Returns

true if succeeded, false otherwise.

Definition at line 97 of file fiff_io.cpp.

write() [1/2]

bool FiffIO::write	(	QFile &	p_QFile,
		const fiff_int_t	type,
		const fiff_int_t	idx ) const

Write whole data of a type to a fiff file.

Parameters

[in]	p_QFile	Output file (name extended with type and index, e.g. sample_audvis-type-1.fif).
[in]	type	Type of data to write (fiff constants types, e.g. FIFFB_RAW_DATA).
[in]	idx	Index of type, -1 for all entities of this type.

Returns

true if succeeded, false otherwise.

Definition at line 207 of file fiff_io.cpp.

write() [2/2]

bool FiffIO::write	(	QIODevice &	pIODevice,
		const fiff_int_t	type,
		const fiff_int_t	idx ) const

Write data to a single pIODevice.

Parameters

[in]	pIODevice	A fiff IO device like a fiff QFile or QTCPSocket.
[in]	type	Type of data to write (fiff constants types, e.g. FIFFB_RAW_DATA).
[in]	idx	Index of type, -1 for all entities of this type.

Returns

true if succeeded, false otherwise.

Definition at line 189 of file fiff_io.cpp.

write_raw()

bool FiffIO::write_raw	(	QIODevice &	pIODevice,
		const fiff_int_t	idx ) const

Write raw data to a pIODevice.

Parameters

[in]	pIODevice	A fiff IO device like a fiff QFile or QTCPSocket.
[in]	idx	Index of type, -1 for all entities of this type.

Returns

true if succeeded, false otherwise.

Definition at line 246 of file fiff_io.cpp.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const FiffIO & p_fiffIO )

friend

Overloading ostream for printing member infos.

Parameters

[in]	out	The output stream.
[in]	p_fiffIO	The FiffIO whose members shall be printed.

Returns

The output stream with the FiffIO data appended.

Definition at line 213 of file fiff_io.h.

Member Data Documentation

m_qlistEvoked

QList<QSharedPointer<FiffEvoked> > FIFFLIB::FiffIO::m_qlistEvoked

List of evoked data sets.

Definition at line 225 of file fiff_io.h.

m_qlistRaw

QList<QSharedPointer<FiffRawData> > FIFFLIB::FiffIO::m_qlistRaw

List of raw data sets.

Definition at line 224 of file fiff_io.h.

---

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

• src/libraries/fiff/fiff_io.h
• src/libraries/fiff/fiff_io.cpp