AwReaderInterface.h

// 
//                 Université d’Aix Marseille (AMU) - 
//                 Institut National de la Santé et de la Recherche Médicale (INSERM)
//                 Copyright © 2013 AMU, INSERM
// 
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 3 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//
//
//    Author: Bruno Colombet – Laboratoire UMR INS INSERM 1106 - Bruno.Colombet@univ-amu.fr
//
#ifndef AW_READER_INTERFACE_H_
#define AW_READER_INTERFACE_H_

#include <AwReadWriteLib.h>
#include <AwSensorLayout.h>
#include <QSemaphore>

namespace Aw
{
    enum AwReaderFlags { ReaderHasExtension = 0x00000001, ReaderTriggerChannelIsWritable = 0x00000002 };
}

class AwReaderPlugin;

class AwFileReader : public QObject
{
public:
    enum FileStatus { NoError, WrongFormat, FileAccess, BadHeader };
    AwDataInfoReader infos;             

    AwFileReader(const QString& filename = QString()) { m_flags = 0x00000000; infos.setFileName(filename); }
    virtual ~AwFileReader() { }
    
    inline AwReaderPlugin *plugin() { return m_plugin; }

    inline void setPlugin(AwReaderPlugin *plugin) { m_plugin = plugin; }

    inline int flags() { return m_flags; }

    // Methods (PURE VIRTUAL SO HAVE TO BE IMPLEMENTED)
    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() { return AwChannelList(); }
    virtual AwSensorLayoutList layouts() { return AwSensorLayoutList(); }

signals:
    void triggerValuesWritten(bool status, int number);
public slots:
    virtual void writeTriggerChannel(const QString& name, AwMarkerList& list) {}
    virtual void clearTriggerChannel(const QString& name) {}

protected:
    AwReaderPlugin *m_plugin;
    int m_flags;
};

class AwReaderPlugin : public QObject
{
public:
    AwReaderPlugin() { m_flags = 0x00000000; }
    QString name;                   
    QString version;                
    QString description;            
    QStringList fileExtensions;     
    QString manufacturer;           
    
    inline int flags() { return m_flags; }

    virtual AwFileReader *newInstance(const QString& filename = QString()) = 0;

    virtual void deleteInstance(AwFileReader *fr) { delete fr; fr = NULL; }
    virtual QStringList montages() { return QStringList(); }
protected:
    int m_flags;
};

Q_DECLARE_INTERFACE(AwReaderPlugin, "AwReaderPluginInterface_1.0")
Q_DECLARE_INTERFACE(AwFileReader, "AwFileReaderInterface_1.0")

#endif /*PLUGIN_INTERFACE_H_*/