bids_abstract_format_reader.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef BIDS_ABSTRACT_FORMAT_READER_H
#define BIDS_ABSTRACT_FORMAT_READER_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../bids_global.h"
 
#include <fiff/fiff_info.h>
#include <fiff/fiff_raw_data.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QString>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE BIDSLIB
//=============================================================================================================
 
namespace BIDSLIB
{
 
//=============================================================================================================
class BIDSSHARED_EXPORT AbstractFormatReader
{
public:
    using UPtr = std::unique_ptr<AbstractFormatReader>;
 
    //=========================================================================================================
    virtual ~AbstractFormatReader() = default;
 
    //=========================================================================================================
    virtual bool open(const QString& sFilePath) = 0;
 
    //=========================================================================================================
    virtual FIFFLIB::FiffInfo getInfo() const = 0;
 
    //=========================================================================================================
    virtual Eigen::MatrixXf readRawSegment(int iStartSampleIdx, int iEndSampleIdx) const = 0;
 
    //=========================================================================================================
    virtual long getSampleCount() const = 0;
 
    //=========================================================================================================
    virtual float getFrequency() const = 0;
 
    //=========================================================================================================
    virtual int getChannelCount() const = 0;
 
    //=========================================================================================================
    virtual FIFFLIB::FiffRawData toFiffRawData() const = 0;
 
    //=========================================================================================================
    virtual QString formatName() const = 0;
 
    //=========================================================================================================
    virtual bool supportsExtension(const QString& sExtension) const = 0;
 
protected:
    AbstractFormatReader() = default;
};
 
} // namespace BIDSLIB
 
#endif // BIDS_ABSTRACT_FORMAT_READER_H