lgrFileFormatter.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrFileFormatter_H_
#define lgrFileFormatter_H_

#include <lgrCore/lgrCore.h>
#include <lgrUtil/virtualConstructor.h>
#include "loggerFileMetaData.h"
#include <lgrUtil/filePosition.h>
#include <vector>

namespace MAKLogger
{

   class DtLoggerFile;
   class DtSmartBuffer;
   class DtMessageBuffer;
   class DtLgrEntityTracker;

   class DT_DLL_LGRCORE DtLgrFileFormatter
   {
   protected:

      DtLgrFileFormatter(DtLoggerFile*);

   public:

      virtual ~DtLgrFileFormatter();

   private:
      DtLgrFileFormatter(const DtLgrFileFormatter&);
      DtLgrFileFormatter& operator=(const DtLgrFileFormatter&);

   public:

      virtual DtLoggerFile* loggerFile();
      virtual const DtLoggerFile* loggerFile() const;

      virtual void setSerialMode(bool enable);

      virtual bool serialMode() const;

      DtLoggerFileMetaData* metaData();
      const DtLoggerFileMetaData* metaData() const;

      virtual void copyMetaData(const DtLgrFileFormatter* formatter);

      virtual DtLgrEntityTracker* entityTracker() const;

      virtual void setTimeLimit(double limit);



      virtual void initializeSerialMode(DtFilePosition firstPacket = 0,
         DtFilePosition lastPacket = 0, bool skipCheckpointRead=false) = 0;

      virtual bool isEofValid() const = 0;

      virtual bool hasLastPacket() const = 0;

      virtual bool recoverLastPacket() = 0;

      virtual double firstPacketTime() const = 0;

      virtual size_t firstPacketSize() const = 0;

      virtual double lastPacketTime() const = 0;

      virtual size_t lastPacketSize() const = 0;

      virtual bool atEndOfFile() = 0;

      virtual bool seekToFirstPacket() = 0;

      virtual bool seekToFirstPacket(int type) = 0;

      virtual bool seekToLastPacket() = 0;

      virtual bool seekToLastPacket(int type) = 0;

      virtual bool seekToFirstPacketBeforeTime(double time) = 0;

      virtual bool seekToFirstPacketBeforeTime(int type,double time) = 0;

      virtual bool seekToFirstPacketAfterTime(double time) = 0;

      virtual bool seekToFirstPacketAfterTime(int type,double time) = 0;

      virtual bool seekToNextSerialPacket() = 0;

      virtual bool seekToNextPacket() = 0;

      virtual bool seekToNextPacket(int type) = 0;

      virtual bool seekToPreviousPacket() = 0;

      virtual bool seekToPreviousPacketOfType(int type) = 0;

      virtual void seekToPosition(DtFilePosition) = 0;

      virtual double currentPacketTime() = 0;

      virtual int currentPacketType() = 0;

      virtual size_t currentPacketSize() = 0;

      virtual DtFilePosition currentPosition() = 0;

      virtual bool hasCheckpoints() const = 0;

      virtual void readMetaData() = 0;

      virtual void readMetaData(DtLoggerFileMetaData::DataPosition position) = 0;

      virtual void writeMetaData(DtLoggerFileMetaData::DataPosition position) = 0;

      virtual void readPacketsUptoCount(DtMessageBuffer&,DtMemoryBufferSP,int packetCount) = 0;

      virtual void readPacketsUptoSize(DtMessageBuffer&,DtMemoryBufferSP) = 0;

      virtual double readPacketsUpToTime(DtMessageBuffer&,DtMemoryBufferSP,double time,
         bool inclusive = true) = 0;

      virtual void writePackets(const DtMessageBuffer&) = 0;

      virtual void writePacket(const DtPacket& packet) = 0;

      virtual size_t writePacket(const DtPacket&,void* memory, size_t memorySize,
         int fileWriteBufferOffset = -1 ) = 0;

      virtual void setDuration(double duration) = 0;

      virtual void setStartEndTimes(double start, double end) = 0;

      virtual double duration() const = 0;

      virtual void setDescription(DtString description) = 0;

      virtual DtString description() const = 0;

      virtual size_t headerSize() const = 0;

      virtual size_t tailSize() const = 0;


   protected:

      DtLoggerFile* myLoggerFile;
      DtLoggerFileMetaData* myLoggerMetaData;
      bool mySerialMode;
      double myReadTimeLimit;
   };
}

#endif