DbiBinaryFile.h

Go to the documentation of this file.

#ifndef DBIBINARYFILE_H
#define DBIBINARYFILE_H

#include <fstream>
using std::fstream;
using std::ios_base;

#include <string>
using std::string;

#include <vector>
using std::vector;

#ifndef ROOT_Rtypes
#if !defined(__CINT__) || defined(__MAKECINT__)
#include "Rtypes.h"
#endif
#endif

class DbiTableRow;
class TimeStamp;
class ContextRange;

class DbiBinaryFile
{

public:

  DbiBinaryFile(const char* fileName= "",
                Bool_t input = kTRUE);
  ~DbiBinaryFile();

// State testing.

  string  GetFileName() const { return fFileName; }
  Bool_t  IsOK() const { return ! fHasErrors;}
  Bool_t  IsReading() const { return this->IsOK() && fReading; }
  Bool_t  IsWriting() const { return this->IsOK() && ! fReading; }

// State changing.

  void Close();

// Builtin data type I/O.

  DbiBinaryFile& operator >> (Bool_t& num);
  DbiBinaryFile& operator << (const Bool_t& num);
  DbiBinaryFile& operator >> (Int_t& num);
  DbiBinaryFile& operator << (const Int_t& num);
  DbiBinaryFile& operator >> (UInt_t& num);
  DbiBinaryFile& operator << (const UInt_t& num);
  DbiBinaryFile& operator >> (Double_t& num);
  DbiBinaryFile& operator << (const Double_t& num);

// Simple Virtual object I/O.
// (i.e. object with vptr but only built-in data types)
 
  DbiBinaryFile& operator >> (TimeStamp& ts);
  DbiBinaryFile& operator << (const TimeStamp& ts);

// String I/O.
// Warning: Implimentation assumes that string does not contain
//          a null character.

  DbiBinaryFile& operator >> (string& str);
  DbiBinaryFile& operator << (const string& str);

// Compound object I/O.

  DbiBinaryFile& operator >> (ContextRange& vr);
  DbiBinaryFile& operator << (const ContextRange& vr);

// Vector I/O.

  DbiBinaryFile& operator >>  (vector<DbiTableRow*>& arr);
  DbiBinaryFile& operator <<  (vector<DbiTableRow*>& arr);
  char* ReleaseArrayBuffer() { char* buff = fArrayBuffer;
                               fArrayBuffer = 0;
                               return buff; }

// Global control of all created DbiBinaryFile objects.

  static Bool_t CanReadL2Cache()  { return fgWorkDir.size() && fgReadAccess; }
  static Bool_t CanWriteL2Cache() { return fgWorkDir.size() && fgWriteAccess; }
  static   void SetWorkDir(const string& dir) { fgWorkDir = dir;
                  if ( fgWorkDir.size() && (fgWorkDir[fgWorkDir.size()-1] != '/') ) fgWorkDir += '/'; }
  static   void SetReadAccess(Bool_t access = kTRUE) { fgReadAccess = access; }
  static   void SetWriteAccess(Bool_t access = kTRUE) { fgWriteAccess = access; }

private:

// The functions that do the low-level I/O.
 
 Bool_t CanRead();
 Bool_t CanWrite();
   void CheckFileStatus();

 Bool_t Read(char* bytes, UInt_t numBytes);
 Bool_t Write(const char* bytes, UInt_t numBytes);

// CINT does not recognise fstream; only ifstream and ofstream.
#if !defined(__CINT__)

  fstream*  fFile;
#endif 
                               
 Bool_t   fReading;
 Bool_t   fHasErrors;
 char*    fArrayBuffer;
 string   fFileName;

 static string fgWorkDir;    //Level 2 Cache directory or null if none.
 static Bool_t fgReadAccess; //Have read access if true.
 static Bool_t fgWriteAccess;//Have write access if true.

};

#endif  // DBIBINARYFILE_HfArrayBuffer