lgrMarkingFilter.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 <lgrCore/lgrPacketFilter.h>
#include <lgrCore/lgrEntityTracker.h>
#include <lgrUtil/virtualConstructor.h>

#include <set>
#include <map>

namespace MAKLogger
{

   class DtPacket;
   class DtLgrSimDriver;
   class DtLgrSimManager;

   class DT_DLL_LGRCORE DtLgrMarkingFilter : public DtLgrPacketFilter
   {
   public:

      typedef std::set<DtString> MarkingSet;

   public:

      DtLgrMarkingFilter();

      DtLgrMarkingFilter(DtLgrSimDriver* simDriver);

      virtual ~DtLgrMarkingFilter();

   protected:

      DtLgrMarkingFilter(const DtLgrMarkingFilter&);
      DtLgrMarkingFilter& operator=(const DtLgrMarkingFilter&);

   public:

      virtual const DtString& type() const;

      virtual void activate(const DtMessageIOInfo* info);

      virtual void deactivate();

      virtual char* serialize(int& size) const;

      virtual int setFromSerialization(const char* data,int size);

      virtual bool filterPacket(DtPacket* packet);

      virtual bool isMarkingFiltered(const DtString& marking) const;

      virtual void filterMarking(const DtString& marking);

      virtual void addConfiguredMarkings(const std::vector<DtString>& markingList, bool filtered);

      virtual void filterMarkingList(const std::vector<DtString>& markingList);

      virtual void setMarkingFiltered(const DtString& marking, bool filtered);

      virtual void setMarkingsFiltered(const std::vector<DtString>& markings, bool enableFilter);

      virtual void clearObjectFilterStatus();

      virtual void clearMarkings();

      virtual void unfilterAll();

      virtual const MarkingSet& filteredMarkings() const;

      virtual const MarkingSet& configuredMarkings() const;

   public:

      static const DtString& theType();

   protected:

      typedef std::map<DtLgrEntityTracker::EntryHandle, DtString> TrackerHandleEntityMarkingMap;
      typedef std::map<DtString, DtString> EntityNameMarkingMap;
      typedef std::map<DtU64, bool> IdFilterMap;

   protected:

      virtual bool hasMarking(const DtPacket* packet) const = 0;

      virtual DtU64 uniqueId(const DtPacket* packet) const = 0;

      virtual DtString entityName(const DtPacket* packet) = 0;

      virtual bool getEntityName(const DtPacket* packet, DtString& name) = 0;

      virtual DtLgrEntityTracker::EntryHandle trackerHandle(const DtString& name) const;

      virtual bool isFiltered(DtU64 uid, bool& isFiltered) const;

      virtual void updateHandleMarkingMap(DtLgrEntityTracker::EntryHandle handle, DtString& marking);

      virtual void updateMarkings();

   protected:

      DtLgrSimManager* mySimManager;

      TrackerHandleEntityMarkingMap myTrackerHandleEntityMarkingMap;

      EntityNameMarkingMap myEntityNameMarkingMap;

      DtLgrEntityTracker::EntryHandleSet myFilteredTrackerHandles;

      MarkingSet myFilteredMarkings;

      MarkingSet myConfiguredMarkings;

      IdFilterMap myObjectFilterStatus;

   protected:

      static DtString theFilterType;

   };
}