ArchiveFileHandler.h

Go to the documentation of this file.

// $Id: ArchiveFileHandler.h,v 1.1.1.1 2009/07/06 23:57:24 eml Exp $

#ifndef GCP_UTIL_ARCHIVEFILEHANDLER_H
#define GCP_UTIL_ARCHIVEFILEHANDLER_H

#include "gcp/util/common/FileHandler.h"

#include "gcp/control/code/unix/libunix_src/common/archive.h"
#include "gcp/control/code/unix/libunix_src/common/arraymap.h"
#include "gcp/control/code/unix/libmonitor_src/monitor_stream.h"
#include "gcp/control/code/unix/libunix_src/common/netbuf.h"
#include "gcp/control/code/unix/libunix_src/common/netobj.h"

#include <iostream>

namespace gcp {
  namespace util {

    class ArchiveFileHandler : public FileHandler {
    public:

      ArchiveFileHandler();

      ArchiveFileHandler(const ArchiveFileHandler& objToBeCopied);

      ArchiveFileHandler(ArchiveFileHandler& objToBeCopied);

      void operator=(const ArchiveFileHandler& objToBeAssigned);

      void operator=(ArchiveFileHandler& objToBeAssigned);

      friend std::ostream& operator<<(std::ostream& os, ArchiveFileHandler& obj);

      virtual ~ArchiveFileHandler();

      // Open the file for reading.  If memMap = true, the file will
      // be memory-mapped

      void openForRead(bool memMap=false);

      ArrayMap* getArrayMap() {
    return arrayMap_;
      }

    private:

      ArrayMap* arrayMap_;            // The register map of the archive file
      gcp::control::NetReadStr* nrs_; // The file input stream 
      int nrsSize_;                   // The size of the input stream buffer
      unsigned nFramesInFile_;

      // The number of header bytes in each msg in the file

      unsigned nBytesInMsgHeader_;

      // The total number of bytes in the head of the file (before the
      // register frames begin)

      unsigned nBytesInFileHeader_;

      // The total number of bytes in each frame in the file.  Note
      // that this is larger than the number of bytes in the array map
      // by nBytesInMsgHeader_

      unsigned nBytesInFrameMsg_;

      // The offset in bytes of the register array.frame.utc from the
      // head of the array map

      unsigned offsetInBytesOfFrameUtcInArrayMap_;

      // Initialize the net read stream

      void initializeNetReadStr();

      // Get the next message from the file

      gcp::control::MsReadState readNextMsg();

      // Read the arraymap from the file

      void readArrayMap();

      // Get the maximum buffer size from the file

      void readSize();

    public:

      void readTimestamps();

      void advanceToFrame(unsigned iFrame, off_t offset=0);

      // Return the MJD of the specified frame

      double getMjd(unsigned iFrame);

      // Binary searches for the first frame in the file before/after the
      // specified date

      unsigned findFirstFrameBefore(std::string date);
      unsigned findFirstFrameAfter(std::string date);

      // Return the total number of frames in this file

      unsigned nFrame();

    }; // End class ArchiveFileHandler

  } // End namespace util
} // End namespace gcp



#endif // End #ifndef GCP_UTIL_ARCHIVEFILEHANDLER_H