AwFileReader Class Reference

Base class to implement a file reader object. More...

#include <AwReaderInterface.h>

Inheritance diagram for AwFileReader:

Public Slots
virtual void	writeTriggerChannel (const QString &name, AwMarkerList &list)
virtual void	clearTriggerChannel (const QString &name)

Public Member Functions
	AwFileReader (const QString &filename=QString())
AwReaderPlugin *	plugin ()
int	flags ()
virtual FileStatus	openFile (const QString &path)=0
virtual FileStatus	canRead (const QString &path)=0
virtual long	readDataFromChannels (float start, float duration, QList< AwChannel * > &channelList)=0
virtual void	cleanUpAndClose ()=0
virtual AwChannelList	triggerChannels ()
virtual AwSensorLayoutList	layouts ()

Public Attributes
AwDataInfoReader	infos
	a AwDataInfoReader giving informations about channels and blocks in data file.

Detailed Description

Base class to implement a file reader object.

A reader must derived from AwFileReader. Some virtual methods must be overriden others are optional.

Remarks

A Reader plug-in can provide a complete sensors layout. It is also possible to allow writing back data to a Trigger channel. This features can be added by implementing some methods.

Constructor & Destructor Documentation

AwFileReader::AwFileReader ( const QString &  filename = QString() )

inline

Default constructor

Member Function Documentation

virtual FileStatus AwFileReader::canRead ( const QString &  path )

pure virtual

Override this method to check if the file can be read by the reader.

virtual void AwFileReader::cleanUpAndClose ( )

pure virtual

Override this method to close open file(s) and memory if needed

virtual void AwFileReader::clearTriggerChannel ( const QString &  name )

inlinevirtualslot

Override this method to clear the Trigger channel.

int AwFileReader::flags ( )

inline

Returns the current active features for the reader.

virtual AwSensorLayoutList AwFileReader::layouts ( )

inlinevirtual

Returns a list of Sensor Layout. Could be empty if no layout which is the default implementation.

virtual FileStatus AwFileReader::openFile ( const QString &  path )

pure virtual

Override this method to open the file and fill up the data structure.

AwReaderPlugin* AwFileReader::plugin ( )

inline

Returns a pointer to the plug-in object which had instantiated the reader object.

virtual long AwFileReader::readDataFromChannels ( float  start, float  duration, QList< AwChannel * > &  channelList  )

pure virtual

Override this method to read data from the file. start is the position in seconds from the beginning of the file. duration is the amount of data to load, expressed in seconds. channeList is a list of channels that must be loaded.

virtual AwChannelList AwFileReader::triggerChannels ( )

inlinevirtual

Returns a list of trigger channels present in the file. The list may be empty.

virtual void AwFileReader::writeTriggerChannel ( const QString &  name, AwMarkerList &  list  )

inlinevirtualslot

Override this method to write data to the Trigger channel. The name of the trigger channel must be specified. A markers list must be specified.

---

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

• AwReaderInterface.h