BdsDataFile.h

Go to the documentation of this file.

/*******************************************************************************
 *  BdsDataFile.h   Data File Access
 *          T.Barnaby,  BEAM Ltd,   2008-06-24
 *******************************************************************************
 */
#ifndef BdsDataFile_H
#define BdsDataFile_H
 
#include <BString.h>
#include <BFile.h>
#include <BdsLib.h>
#include <BdsD.h>
 
namespace Bds {
 
class DataBlockPos {
public:
                DataBlockPos(BTimeStamp startTime = 0, BTimeStamp endTime = 0, BUInt64 position = 0, BUInt order = 0, int ref = 0, BUInt numSamples = 0) : startTime(startTime), endTime(endTime), position(position), order(order), ref(ref), numSamples(numSamples){}
    int         operator<(const DataBlockPos& b) const { return startTime < b.startTime;    }
    BTimeStamp      startTime;
    BTimeStamp      endTime;
    BUInt64         position;
    BUInt           order;
    int         ref;
    BUInt           numSamples;
};
 
class DataFileOptions {
public:
                DataFileOptions(int options = 0){   ooptionList = options; }
                operator int (){    return ooptionList; }
    DataFileOptions&    operator|=(int o){  ooptionList |= o; return *this; }
            
    int     ooptionList;
    BArray<BUInt>   oignoreBlockList;
};
 
class DataFile {
public:
    enum DataOrder      { DataOrderUnknown, DataOrderAll, DataOrderSample, DataOrderChannel };
    enum Features       { FeatureNone = 0x00, FeatureCanWrite = 0x01, FeatureCanRead = 0x02 };
    enum WriteOptionsList   { WriteOptionNone = 0x00, WriteOptionSensorData = 0x01, WriteOptionNoMetadata = 0x02 };
    enum ReadOptionsList    { ReadOptionNone = 0x00, ReadOptionValidate = 0x01, ReadOptionFileNameProcess = 0x02, ReadOptionFixCorruptions = 0x04, ReadOptionReorder = 0x08, ReadOptionDeleteDuplicates = 0x10, ReadOptionInfoExtra = 0x20, ReadOptionIgnoreSamplerate = 0x40, ReadOptionPrintBlocks = 0x80, ReadOptionFixSampleRate = 0x100 };
 
                DataFile();
    virtual         ~DataFile();
    
    virtual void        init();                             
    virtual BError      open(BString fileName, BString mode);               
    virtual BError      close();                            
 
    virtual BError      setFormat(BString format);                  
    virtual BString     getFileName();                          
    virtual DataOrder   getDataOrder();                         
    virtual int     getFeatures();                          
    virtual BString     getFixesInfo();                         
    void            getNotices(BStringList& notices);               
    
                // Write routines
    virtual BError      setInfo(const DataInfo& dataInfo, const ChannelInfos& channelInfos, WriteOptionsList options = WriteOptionNone);        
    virtual BError      start(BUInt channel, BUInt segment);                    
    virtual BError      writeData(const DataBlock& data);                   
    virtual BError      end();                                  
    virtual BError      flush();                                
 
                // Read routines
    virtual BError      fileNameProcess();                          
    virtual BError      getFormat(BString& format);                     
    virtual BError      getInfo(DataInfo& dataInfo, DataFileOptions options, BList<DataError>& errors); 
    virtual BError      seekBlock(BUInt32 channel, BUInt segment, BTimeStamp time, BUInt32& blockNumber, BUInt64& sampleNumber, DataBlock& data);   
    virtual BError      readData(BUInt32 channel, BUInt segment, BUInt32 blockNumber, DataBlock& dataBlock);    
 
    virtual BError      getMetaData(ChannelInfos& channelInfos, BUInt32 options, BList<DataError>& errors);         
    
                // Misc functions
    void            dataErrorFixup(const DataInfo& dataInfo, BList<DataError>& errors);     
    BInt64          timeCompare(BTimeStamp t1, BTimeStamp t2, BUInt diff);          
    int         duplicateCheck(const DataBlock& data1, const DataBlock& data2, BUInt channel = 0);  
    BUInt64         getFilePosition();
    static DataFormats  getFormats();                           
 
protected:
    BString         ofileName;
    BString         omode;
    BTimeStamp      ofileNameTime;
    BFile           ofile;
    BString         oformat;
    BStringList     onotices;
};
 
}
#endif