lgrEditorInterface.h

Go to the documentation of this file.

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


#ifndef lgrEditorInterface_H_
#define lgrEditorInterface_H_

#include "lgrSystemInterface.h"
#include "lgrExportType.h"
#include <lgrUtil/virtualConstructor.h>

#include <memory>
#include <map>
#include <vlutil/vlString.h>

namespace MAKLogger
{

   class DtLogger;
   class DtLgrPacketPrinter;
   class DtLgrEditorCommandFactory;
   class DtLgrEditorDriver;

   class DT_DLL_LGRCORE DtLgrEditorInterface : public virtual DtLgrSystemInterface
   {
   public:

      enum FileDataOperations
      {
         DataAdded,
         DataDeleted,
         DataMoved
      };

      enum ExportType
      {
         UserExport,
         UserExportSelectionOnly,
         InternalExport
      };

      //Used to shorten code.
      typedef DtLgrEditorCommandFactory Factory;

      //Used to shorten code.
      typedef DtLgrEditorInterface ThisClass;

      //Map used to store export types.
      typedef std::map<DtString,DtLgrExportType> ExportTypeMap;

      static DtLgrEditorInterface* create(DtLogger&);

      static DtLgrEditorInterface* createNonThreadsafe(DtLogger& logger,
         const DtLgrEditorDriver& driver);

      virtual ~DtLgrEditorInterface();

      virtual void clearSection(const DtAbsoluteTime& start,
         const DtAbsoluteTime& stop) const;

      virtual void cutSection(const DtAbsoluteTime& start,
         const DtAbsoluteTime& stop) const;

      virtual void exportFile(const DtString& exportType,
         const DtString& filename, bool recheckpoint,
         bool openAfterExport) const;

      virtual void exportSection(const DtString& exportType,
         const DtString& filename, const DtAbsoluteTime& start,
         const DtAbsoluteTime& stop, const DtRelativeTime& offset,
         bool recheckpoint,bool openAfterExport) const;

      virtual void mergeInFile(const DtString& filename, const DtRelativeTime&
         offset) const;

      virtual void appendFileToEnd( const DtString& filename) const;

      virtual void prefixFileToStart( const DtString& filename) const;

      virtual void trimStart() const;

      virtual void offsetTime(const DtRelativeTime& offset) const;

      virtual void convertFile() const;

      virtual void addExportType(const DtString& fileFormat,
         const DtString& fileFilter, bool offsetData,bool generateData,
         ExportType exportType, std::auto_ptr<DtLgrPacketPrinter> printer) const;

      virtual const ExportTypeMap& exportTypes() const;

      virtual const DtAbsoluteTime& lastOperationStart() const;

      virtual const DtAbsoluteTime& lastOperationEnd() const;

      virtual const DtRelativeTime& lastOperationOffset() const;

      virtual const DtString& lastOperationSource() const;

      virtual const DtString& completedExportType() const;

      virtual const DtString& completedExportDestination() const;

      virtual void setRecheckpointOnExport( bool recheckpoint ) const;

      virtual bool recheckpointOnExport() const;

   public:

      DtValueSignal<DtString> exportTypeAddedSignal;

      DtValueSignal<DtString> exportCompletedSignal;

      DtValueSignal<DtString> exportCanceledSignal;

      DtValueSignal<FileDataOperations> dataOperationSignal;

   protected:

      void exportTypeAdded(DtResponse response);

      void dataAdded(DtResponse response);

      void dataDeleted(DtResponse response);

      void dataMoved(DtResponse response);

      void exportCompleted(DtResponse response);

      void recheckpointOnExportChanged( DtResponse response);

      DtLgrEditorInterface(DtLogger& logger,const DtLgrEditorDriver& driver);

      void connectResponse(DtLgrCommandId id,
         void (DtLgrEditorInterface::* function)(DtResponse));

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

   protected:
      ExportTypeMap myExportTypes;
      DtString myNewestExportType;
      FileDataOperations myLastOperation;

      DtAbsoluteTime myLastOperationStart;
      DtAbsoluteTime myLastOperationEnd;
      DtRelativeTime myLastOperationOffset;
      DtString myLastOperationSource;
      DtString myLastExportType;
      DtString myLastExportName;
      bool myRecheckpointOnExport;

   };

}

#endif