DtStateViewCollection.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtStateView.h>
#include <vrvCore/DtDe.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtSimObjectEntry.h>
#include <vrvCore/DtDataBank.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <boost/bind.hpp>

namespace makVrv
{
   template<class T>
   class DtStateViewCollection
   {

   public:

      typedef std::map<DtUniqueID, DtStateView<T>* > StateViewMap;

      DtStateViewCollection(DtDe& de, DtSimEntryUpdater::UpdateRate rate);

      virtual ~DtStateViewCollection();

      void setUpdateRate(DtSimEntryUpdater::UpdateRate rate);

      size_t size() const;

      const StateViewMap& stateViewMap() const;

      bool hasStateView(DtUniqueID id) const;

      const DtStateView<T>* findStateView(DtUniqueID id) const;

      boost::signalslib::signal<void (const DtStateView<T>&)> signal_stateViewAdded;

      boost::signalslib::signal<void (const DtStateView<T>&)> signal_stateViewAboutToBeRemoved;

   protected:

      bool isCompatible(DtSimObjectEntry& entry);

      bool isCompatible(DtSimState& entry);

      void onSimObjectEntryAdded(DtSimObjectEntry& entry);

      void onSimObjectEntryAboutToBeRemoved(DtSimObjectEntry& entry);

      void onSimObjectStateEntryAdded(DtSimObjectEntry& entry, DtSimState&);

      void onSimObjectStateEntryAboutToBeRemoved(DtSimObjectEntry& entry, DtSimState&);

      void populateFromExistingEntries();

   protected:

      DtDe& myDe;
      StateViewMap myStateViewMap;
      DtSimEntryUpdater::UpdateRate myRate;
      DtSignalConnectionManager myConnections;
   };


   template<class T>
   DtStateViewCollection<T>::DtStateViewCollection(DtDe& de, 
      DtSimEntryUpdater::UpdateRate rate)
   : myDe(de)
   , myStateViewMap()
   , myRate(rate)
   {
      DtSimData& simDataObj = myDe.dataBank().simData();

      myConnections.manageConnection(simDataObj.signal_simObjectEntryAdded.connect(
          boost::bind(&DtStateViewCollection<T>::onSimObjectEntryAdded, this, _1)));

      myConnections.manageConnection(simDataObj.signal_simObjectEntryToBeRemoved.connect(
          boost::bind(&DtStateViewCollection<T>::onSimObjectEntryAboutToBeRemoved, this, _1)));

      myConnections.manageConnection(simDataObj.signal_simStateAdded.connect(
          boost::bind(&DtStateViewCollection<T>::onSimObjectStateEntryAdded, this, _1, _2)));

      myConnections.manageConnection(simDataObj.signal_simStateToBeRemoved.connect(
          boost::bind(&DtStateViewCollection<T>::onSimObjectStateEntryAboutToBeRemoved, this, _1, _2)));

      populateFromExistingEntries();
   }

   template<class T>
   DtStateViewCollection<T>::~DtStateViewCollection()
   {
       // myConnections disconnects signal_simObjectEntryAdded, 
       // signal_simObjectEntryToBeRemoved, signal_simStateAdded,
       // signal_simStateToBeRemoved
   }

   template<class T>
   void DtStateViewCollection<T>::onSimObjectEntryAdded(DtSimObjectEntry& entry)
   {
      if(isCompatible(entry))
      {
         onSimObjectEntryAboutToBeRemoved(entry);

         DtStateView<T>* sview = new DtStateView<T>(entry);
         sview->setUpdateRate(myRate);
         myStateViewMap[entry.id()] = sview;
         signal_stateViewAdded(*sview);
      }
   }

   template<class T>
   void DtStateViewCollection<T>::onSimObjectStateEntryAdded(DtSimObjectEntry& entry, DtSimState& state)
   {
      if(isCompatible(state))
      {
         onSimObjectStateEntryAboutToBeRemoved(entry, state);

         DtStateView<T>* sview = new DtStateView<T>(entry);
         sview->setUpdateRate(myRate);
         myStateViewMap[entry.id()] = sview;
         signal_stateViewAdded(*sview);
      }
   }

   template<class T>
   void DtStateViewCollection<T>::onSimObjectEntryAboutToBeRemoved(
      DtSimObjectEntry& entry)
   {
      if(isCompatible(entry))
      {
         typename StateViewMap::iterator iter = myStateViewMap.find(entry.id());
         if(iter != myStateViewMap.end())
         {
            signal_stateViewAboutToBeRemoved(*iter->second );
            delete iter->second;
            myStateViewMap.erase(iter);
         }
      }
   } 

   template<class T>
   void DtStateViewCollection<T>::onSimObjectStateEntryAboutToBeRemoved(
      DtSimObjectEntry& entry, DtSimState& state)
   {
      if(isCompatible(state))
      {
         typename StateViewMap::iterator iter = myStateViewMap.find(entry.id());
         if(iter != myStateViewMap.end())
         {
            signal_stateViewAboutToBeRemoved(*iter->second );
            delete iter->second;
            myStateViewMap.erase(iter);
         }
      }
   } 

   template<class T>
   bool DtStateViewCollection<T>::isCompatible(DtSimObjectEntry& entry)
   {
      return DtStateView<T>::isCompatible(entry);
   }

   template<class T>
   bool DtStateViewCollection<T>::isCompatible(DtSimState& state)
   {
      return DtStateView<T>::isCompatible(state);
   }

   template<class T>
   size_t DtStateViewCollection<T>::size() const
   {
      return myStateViewMap.size();
   }

   template<class T>
   void DtStateViewCollection<T>::populateFromExistingEntries()
   {
      DtSimData::SimEntryMap::const_iterator pos;
      for(pos=myDe.dataBank().simData().simEntryMap().begin(); 
         pos != myDe.dataBank().simData().simEntryMap().end(); ++pos )
      {
         DtSimObjectEntry* pEntry = dynamic_cast<DtSimObjectEntry*>(pos->second);
         if(pEntry)
         {
            onSimObjectEntryAdded(*pEntry);
         }
      }
   }

   template<class T>
   void DtStateViewCollection<T>::setUpdateRate(DtSimEntryUpdater::UpdateRate rate)
   {
      myRate = rate;

      typename StateViewMap::const_iterator pos;
      for(pos = myStateViewMap.begin(); pos != myStateViewMap.end(); ++pos )
      {
         pos->second->setUpdateRate(myRate);
      }
   }

   template<class T>
   const typename DtStateViewCollection<T>::StateViewMap& DtStateViewCollection<T>::stateViewMap() const
   {
      return myStateViewMap;
   }

   template<class T>
   bool DtStateViewCollection<T>::hasStateView(DtUniqueID id) const
   {
      typename StateViewMap::const_iterator iter = myStateViewMap.find(id);
      return (iter != myStateViewMap.end());
   }

   template<class T>
   const DtStateView<T>* DtStateViewCollection<T>::findStateView(DtUniqueID id) const
   {
      typename StateViewMap::const_iterator iter = myStateViewMap.find(id);
      if(iter != myStateViewMap.end())
      {
         return iter->second;
      }

      return 0;
   }
}