DtAggregateEchelonManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2022 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtElementIDHierarchy.h>
#include <vrvCore/DtElementIDHierarchyState.h>
#include <vrvCore/DtUniqueID.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <makArchives/DtAggregateSettingsRecord.h>

#include <boost/function.hpp>
#include <vrvUtil/DtSignalConnectionManager.h>

namespace makVrv
{
   class DtDe;
}

namespace makVrv
{
   class DtBaseConnection;

   class DT_DLL_VRVCORE DtAggregateEchelonManager : public DtVirtualBaseClass
   {
   public:
      enum Flags
      {
         Destroyed = 0x80000000
      };

   public:
      static DtAggregateEchelonManager& instance(DtBaseConnection& connection);

      static void registerInstance(DtBaseConnection& sim, DtAggregateEchelonManager*);

      static void processDisplayOperation(DtDe& de, DtElementID id, DtElementIDHierarchyDisplayState::DisplayState operation);

      static const DtElementIDHierarchyStateAttribute* findHierarchyItem(DtDe& de, DtElementID id);

      static const DtElementIDHierarchyDisplayStateAttribute* findDisplayState(DtDe& de, DtElementID id);

      static bool aggregateElementCanBeExpanded(DtDe& de, DtElementID id);

      static bool aggregateElementCanBeCollapsed(DtDe& de, DtElementID id);

      virtual ~DtAggregateEchelonManager();

   protected:
      virtual void hierarchyItemModified(DtElementIDHierarchyNode*);

      virtual void hierarchyItemAboutToBeRemoved(DtElementIDHierarchyNode*);

   public:

      virtual void setDisplayInitiallyExpanded(bool);

      virtual void setRecord(const makArchives::DtAggregateSettingsRecord&);

      virtual void setDestroyed(DtElementID id, bool);
      bool destroyed(DtElementID) const;
      boost::signalslib::signal<void(DtElementID, bool b)   > signal_aggregateDestroyedStateChanged;

      void removeElementPendingDestroyedState(DtElementID id);

      // Get the parent of an element (returns (DtElementID)0 if none).
      DtElementID parent(DtElementID id);

      const DtElementIDHierarchy& hierarchy() const
      {
         return myHierarchy;
      }

      DtElementIDHierarchy& hierarchy()
      {
         return myHierarchy;
      }

      virtual const makArchives::DtAggregateSettingsRecord& aggregateSettings() const;

      boost::signalslib::signal<void(DtElementID, DtElementIDHierarchyNode::DisplayState)   > signal_visibilityStateChanged;

      boost::signalslib::signal<void(DtElementIDHierarchyNode*)   > signal_hierarchyItemModified;

      boost::signalslib::signal<void(DtElementID, const DtElementIDHierarchy::ElementIDs&) > signal_updateHierarchy;

   protected: 
      void setShowLeafNodes(bool enabled);
      void setGhostEchelonLevelItems(bool enabled);
      void setGhostEchelonLevelItemLabels(bool enabled);
      void setEchelonLevel(int l);
      void setDisplayAggregates(bool enabled);

   protected:

      virtual DtElementIDHierarchyNode::DisplayState expectedDisplayStateFor(const DtElementIDHierarchyNode* node); 

      virtual void updateDestroyedState(DtElementIDHierarchyNode* parentNode);

      virtual void updateHierarchy(DtElementID parentId, const DtElementIDHierarchy::ElementIDs& children);

   protected:
      DtAggregateEchelonManager(DtBaseConnection& sim);

      virtual void slot_echelonVisibilityChanged(DtElementIDHierarchy::VisibilityProcessingList);

   protected:
      DtSignalConnectionManager  mySignalConnections;
      DtBaseConnection& myConnection;
      makArchives::DtAggregateSettingsRecord          myAggregateSettings;
      std::map<DtElementID, bool>                     myPendingDestroyedStates;
      DtElementIDHierarchy                            myHierarchy;
   };
}