AwReadWrite
Read Write Library for AnyWave
Public Member Functions | List of all members
AwDataInfo Class Reference

This is the base class to manage informations about Reader or Writer Plugins. More...

#include <AwReadWriteLib.h>

Inheritance diagram for AwDataInfo:
AwDataInfoReader AwDataInfoWriter

Public Member Functions

AwBlockList & blocks ()
 
AwChannelList & channels ()
 
qint32 channelsCount ()
 
QString & patientName ()
 
QString & recordingDate ()
 
QString & recordingTime ()
 
QString & manufacturer ()
 
AwBlocknewBlock ()
 
float totalDuration ()
 
quint32 totalSamples ()
 
bool isEpoched ()
 
QString & fileName ()
 
void setFileName (const QString &name)
 
void setManufacturer (const QString &man)
 
void setTime (const QString &time)
 
void setDate (const QString &date)
 
void setPatientName (const QString &name)
 

Detailed Description

This is the base class to manage informations about Reader or Writer Plugins.

This class is used by reader and writer plugins to store low level information. This class contains the list of data blocks of a file and some attributes related to patient and manufacturer.

Remarks
Reader plug-ins must update this object by adding block of data and by setting useful informations.
See also
AwBlock | AwDataInfoReader | AwDataInfoWriter

Member Function Documentation

AwBlockList& AwDataInfo::blocks ( )
inline

Returns the number of data blocks in the file.

AwChannelList& AwDataInfo::channels ( )
inline

Returns the list of channels present in the file.

qint32 AwDataInfo::channelsCount ( )
inline

Returns the number of channels present in the file.

QString& AwDataInfo::fileName ( )
inline

Returns the full path to the current open data file.

bool AwDataInfo::isEpoched ( )
inline

Returns true if the file contains more than one block. The file is then considered as Epoched.

QString& AwDataInfo::manufacturer ( )
inline

Get the name of the manufacturer. It could be an empty string.

AwBlock * AwDataInfo::newBlock ( )

Adds a new block and returns the pointer to the newly created object.

QString& AwDataInfo::patientName ( )
inline

Gets the patient's name. It could be an empty string.

QString& AwDataInfo::recordingDate ( )
inline

Gets the recording date. It could be an empty string.

QString& AwDataInfo::recordingTime ( )
inline

Gets the recording time. It could be an empty string.

void AwDataInfo::setDate ( const QString &  date)
inline

Sets the recording date.

void AwDataInfo::setFileName ( const QString &  name)
inline

Sets the full path to data file.

void AwDataInfo::setManufacturer ( const QString &  man)
inline

Sets the manufacturer name.

void AwDataInfo::setPatientName ( const QString &  name)
inline

Sets the patient's name.

void AwDataInfo::setTime ( const QString &  time)
inline

Sets the recording time.

float AwDataInfo::totalDuration ( )

Returns the total duration in seconds for the whole file. This is calculated by adding the duration of all blocks present in the file

quint32 AwDataInfo::totalSamples ( )

Returns the total number of samples for the whole file.


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