messageOutput.h

Go to the documentation of this file.

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


#pragma once

#include <lgrCore/lgrCore.h>

#include <lgrUtil/observeEvent.h>
#include <lgrUtil/absoluteTime.h>

#include <set>

namespace MAKLogger
{
   template<typename T> class DtCollector;
   class DtMessageBuffer;
   class DtMessageFilter;
   class DtMessageIOInfo;
   class DtPacket;
   class DtMessageInput;

   class DT_DLL_LGRCORE DtMessageOutput
   {
   public:
      DtMessageOutput();

      virtual ~DtMessageOutput();

   private:
      DtMessageOutput(const DtMessageOutput&);
      DtMessageOutput& operator=(const DtMessageOutput&);
   public:

      virtual void activate(const DtMessageInput* fileInput) = 0;

      virtual bool isActivated() const = 0;

      virtual void deactivate() = 0;


      virtual void setSourceTime(const DtAbsoluteTime& sourceTime, bool inclusive);
      virtual DtAbsoluteTime sourceTime() const;

      virtual bool sourceTimeInclusive() const;

      virtual void outputMessages(const DtMessageBuffer& buffer);

      virtual void outputMessage(const DtPacket* packet);

      virtual bool outputPacket(const DtPacket& packet) = 0;

      virtual void filterMessages(DtMessageBuffer& buffer);

      virtual void filterMessage(DtPacket* packet) = 0;
      virtual void filterMessageAllowingCheckpoints(DtPacket* packet);

      virtual const DtMessageIOInfo* info() const = 0;

      virtual void flush() = 0;

      virtual void setOutputScaling(double scaling, bool enableStatic, bool isPaused=false) = 0;

      virtual void setSendImmediate(bool enable);

      virtual void setSendRetained(bool enable);

      virtual void setSendInitial(bool enable);

      void attachFilter(DtMessageFilter*);

      void detachFilter(DtMessageFilter*);

      void filters(DtCollector<DtMessageFilter*> filterCollection) const;

      DtObserveEvent<DtPacket>* preOutputPacketEvent();

      DtObserveEvent<DtPacket>* postOutputPacketEvent();

      DtObserveEvent<DtPacket>* packetFilteredEvent();

   protected:
      std::set<DtMessageFilter*> myFilters;

      DtObserveEvent<DtPacket> myPreOutputPacketEvent;

      DtObserveEvent<DtPacket> myPostOutputPacketEvent;

      DtObserveEvent<DtPacket> myFilteredPacketEvent;

      bool mySendImmediateFlag;

      bool mySendRetainedFlag;

      bool mySendInitialFlag;

      DtAbsoluteTime mySourceTime;

      bool mySourceTimeBoundary;

   };

}