MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FIFFLIB::FiffIO Class Reference

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

Definition at line 80 of file fiff_io.h.

Inheritance diagram for FIFFLIB::FiffIO:
Inheritance graph

Constructor & Destructor Documentation

◆ FiffIO() [1/4]

FiffIO::FiffIO ( )

Constructs a FiffIO

Definition at line 61 of file fiff_io.cpp.

◆ ~FiffIO()

FiffIO::~FiffIO ( )

Destroys the FiffIO.

Definition at line 67 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]pIODeviceA fiff IO device like a fiff QFile or QTCPSocket.

Definition at line 73 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_qlistIODevicesA QList of fiff IO devices like a fiff QFile or QTCPSocket.

Definition at line 81 of file fiff_io.cpp.

◆ FiffIO() [4/4]

FIFFLIB::FiffIO::FiffIO ( const FiffIO p_FiffIO)

Copy constructor.

Parameters
[in]p_FiffIOFiffIO, which should be copied.

Member Function Documentation

◆ read() [1/2]

bool FiffIO::read ( QIODevice &  pIODevice)

Read data from a pIODevice.

Parameters
[in]pIODeviceA fiff IO device like a fiff QFile or QTCPSocket.

Definition at line 113 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_qlistIODevicesA 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]pIODeviceAn fiff IO device like a fiff QFile or QTCPSocket.
[in]infoOverall info for fiff IO device.
[out]dirTreeNode directory structure.
Returns
true if succeeded, false otherwise.

Definition at line 91 of file fiff_io.cpp.

◆ write() [1/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]pIODeviceA fiff IO device like a fiff QFile or QTCPSocket.
[in]typeof data to write fiff constants types, e.g. FIFFB_RAW_DATA.
[in]idxindex of type, -1 for all entities of this type.

Definition at line 183 of file fiff_io.cpp.

◆ write() [2/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_QFilefilename including the path but not the type, e.g. ./sample_date/sample_audvis.fif -> will be extended to ./sample_date/sample_audvis-type-1.fif.
[in]typeof data to write fiff constants types, e.g. FIFFB_RAW_DATA.
[in]idxindex of type, -1 for all entities of this type.

Definition at line 201 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]pIODeviceA fiff IO device like a fiff QFile or QTCPSocket.
[in]idxindex of type, -1 for all entities of this type.

Definition at line 240 of file fiff_io.cpp.

Friends And Related Function Documentation

◆ operator<<

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

Overloading ostream for printing member infos

Parameters
[in]p_fiffIOthe fiffIO, whose members shall be printed.

Definition at line 202 of file fiff_io.h.


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