lgrGenericFileFormats.h

Go to the documentation of this file.

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


//and Contains


#pragma once

#include <lgrCore/lgrEntityTrackingFormat.h>

namespace MAKLogger
{
   class DT_DLL_LGRCORE DtLgrGenericFileFormat : public DtLgrEntityTrackingFormat
   {
   public:
      DtLgrGenericFileFormat(DtLoggerFile*);
      ~DtLgrGenericFileFormat();

      virtual DtTime tapeTimeDate();

      virtual DtFloat64 recordingDuration();

      virtual const DtPacket* configPacket();

      virtual DtString description() const;

      virtual void setDescription(DtString description);

      virtual DtLgrEntityTracker* entityTracker() const;

      virtual void setFileVersion(int version);

   protected:

      virtual DtLgrEntityTracker* entityTracker();

      virtual void readStartMetaData();

      virtual void readEndMetaData();

      virtual void writeStartMetaData();

      virtual void writeMiddleMetaData();

      virtual void writeEndMetaData();

      virtual void validateType(int type);

      virtual bool validateStartMetaDataType(int type);

      virtual bool validateEndMetaDataType(int type);

      virtual void validateStartMetaDataMap();

      virtual void validateEndMetaDataMap();

      virtual int decodeTypeFromFlags(unsigned int flags);

      virtual void decodeIndexPacket();

      virtual size_t currentPacketSize();

      virtual size_t currentPacketDataSize();

      virtual int currentPacketType();

      virtual double currentPacketTime();

      virtual void fillHeader(void* header, const DtPacket& packet);

      virtual bool writeHeader(int fd, const DtPacket& packet);

      virtual bool readHeader();

      virtual DtU32 headerNumBytes() const;

      virtual DtU32 headerNumBytes(const void* header) const;

      virtual DtU32 headerFlags() const;

      virtual DtU32 headerFlags(const void* header) const;

      virtual DtFloat64 headerArrivalTime() const;

      virtual DtFloat64 headerArrivalTime(const void* header) const;

      virtual DtU32 headerEntityId() const;

      virtual DtU32 headerEntityId(const void* header) const;

      virtual size_t headerSize() const;

   protected:
      DtPacket* myNewDescriptionPacket;

      // treat very last packet as index table if it doesn't otherwise validate,
      // since in some earlier formats that packet type was not written correctly.
      bool myLastPacket;

      int myFileVersion;

   };


   class DT_DLL_LGRCORE DtLgrGenericFileFormats
   {
   public:

      static DtLgrFileFormatter* createGenericFileFormat(DtLoggerFile* file);

   };

}