TapeRead.hpp

/* TapeRead.hpp */
/* $Id: TapeRead.hpp,v 1.1 2004/01/28 13:26:25 vlad Exp $ */
#ifndef __TapeRead_hpp
#define __TapeRead_hpp

#include <mix/ErrCodes.h>


class TapeRead
{
public:

  TapeRead (const char* szPath);

  virtual ~TapeRead ();

  /*
   *  Setting tape read parameters.
   */

  virtual void  set_max_block_size (int nSize);

  virtual int   get_max_block_size () const;

  virtual void  set_max_errors (int nErrors);

  virtual int   get_max_errors () const;


  virtual const char*       get_tape_name () const;

  virtual unsigned char*    get_block_buffer () const;


  /*
   *  Reading methods.
   */

  virtual ErrCode   observe ();

  virtual void      finish ();

  /*
   *  Statistics is accessible at every stage of tape processing.
   */

  virtual int   files_on_tape () const;

  virtual int   size_of_tape () const;

  /*
   *  Events to process.  Order of actual calls.
   */

  virtual void  start_of_tape ();

  virtual void  start_of_file (int iFile);

  virtual void  block_of_file (int iFile, int iBlock,
                   const unsigned char* pBlockData,
                   int nBlockSize);

  virtual void  end_of_block_sequence (int iFile,
                       int iBlock1, int iBlock2,
                       int nBlockSize);

  virtual void  end_of_file (int iFile, int nBlocks, int nFileSize);

  virtual void  end_of_tape ();

  virtual void  final (bool bNormal);

protected:

  char      *szDataLocAddress;

  int       nMaxBlockSize;

  int       nMaxErrors;

  unsigned char *pBlockBuffer;

  int       nFiles;

  int       nTapeSize;

  bool      bFinish;

};


#endif /* TapeRead.hpp */