vrfObjectDataStateProcessor.h

Go to the documentation of this file.

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


#pragma once

#include <vrfVrlSharedSource/vrfProtocol.h>
#include <vrfGuiCore/DtVrfObjectDataStateObjectAgent.hpp>

//#include <vrvCore/DtSimDataProcessor.h>
#include <vrvVrl/DtEntityExistenceListener.h>
#include <vrvVrl/DtVrlinkEntityStateListener.h>

#include <vrvUtil/DtBalancedUpdater.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtSimEntryObjectAgent.hpp>
#include <vrvCore/DtSimDataProcessorInterface.h>

#include <vrfExtObjects/extEntityStateRepository.h>
#include <vlutil/vlPerformanceStats.h>

namespace makVrv
{
   class DtEntityStateListener;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtEntityExistenceListener;
      class DtStateListenerInterface;
   }
}

namespace makVrf 
{
   class DtNetworkMessageInterfaceHandlerAgent;

   namespace VRF_PROTOCOL_NAMESPACE
   {
      class VRF_PROTOCOL_EXPORT DtVrfObjectDataStateProcessor : public makVrv::DtSimDataProcessorInterface
      {
      public:

         static DtVrfObjectDataStateProcessor* findInstance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         static void registerInstance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim,DtVrfObjectDataStateProcessor*);

         DtVrfObjectDataStateProcessor(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim, int sessionId, int messageVersion);

         virtual ~DtVrfObjectDataStateProcessor();
         
         void postDrainInput();

         void setObjectUpdateRate(makVrv::DtUniqueID uniqueId, makVrv::DtSimEntryUpdater::UpdateRate rate);

         void forceObjectUpdate(makVrv::DtUniqueID uniqueId);

         void entityDiscovered(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener& listener);

         void entityToBeDeleted(makVrv::DtEntityStateListener& listener);

         virtual void createAndSendState(makVrv::DtEntityStateListener& listener,
            makVrv::DtSimStateObjectAgent& objectDriver);
         virtual void updateExtendedState(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener& listener);
         virtual void setStateProperties(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener& listener,
            DtVrfNetworkUpdateObjectDataState& state, const DtRwProperties* defaultStateProperties);
         virtual void rangeItemsFrom(const DtExtEntityStateRepository& esr, std::vector<DtRangeItem>&);

         virtual void addRangeRingItemToVisuals(const makVrf::DtRangeItem& item);

         boost::signal<void (makVrv::DtUniqueID, DtVrfNetworkUpdateObjectDataState&) > signal_stateUpdated;

         boost::signal<void (const DtExtEntityStateRepository&, std::vector<makVrf::DtRangeItem>&) > signal_addAdditionalRangeRingItems;

         virtual void setupState(const DtExtEntityStateRepository&, DtVrfNetworkUpdateObjectDataState&);

         virtual bool keyDataChanged(makVrv::DtEntityStateListener& listener, const DtVrfNetworkUpdateObjectDataState& data) const;

      protected:

         static void postDrainInput(void* usr);
         void slot_postUpdateCallback(makVrv::DtEntityStateListener& listener);

         virtual void slot_modelSetChanged();

      protected:
         
         //A Listener and a driver which will be updated with it.
         class VrfObjectDataStateUpdater
         {
         public:

            VrfObjectDataStateUpdater(makVrv::DtEntityStateListener& listener,
               DtVrfObjectDataStateObjectAgent& driver, DtVrfObjectDataStateProcessor&);

            VrfObjectDataStateUpdater(const VrfObjectDataStateUpdater& orig);

            VrfObjectDataStateUpdater& operator=(const VrfObjectDataStateUpdater& orig);

            //Are the updaters equal
            bool operator==(const VrfObjectDataStateUpdater& orig) const;

            void update(double timeT);

         protected:

            makVrv::DtEntityStateListener* myListener;
            DtVrfObjectDataStateObjectAgent* myObjectAgent;
            DtVrfObjectDataStateProcessor* myProcessor;
         };
    
         typedef std::set<makVrv::DtUniqueID> EntityIdList;

         struct EntitySimDataInstance
         {
            makVrv::DtEntityStateListener* myListener;
            DtVrfObjectDataStateObjectAgent* myAgent;
            makVrv::DtSimEntryUpdater::UpdateRate myRate;
         };

         typedef std::map<makVrv::DtUniqueID,EntitySimDataInstance > EntityAgentMap;

         typedef makVrv::DtBalancedUpdater<VrfObjectDataStateUpdater> EntityUpdaterGroup;
         typedef std::map<makVrv::DtSimEntryUpdater::UpdateRate,EntityUpdaterGroup>
            EntityUpdateGroupMap;                  

      protected:

         makVrv::DtSignalConnectionManager myConnections;

         makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& mySimulation;
         makVrv::DT_PROTOCOL_NAMESPACE::DtEntityExistenceListener& myListener;
         DtTimedSection myTimer;
         makVrv::DtSimEntryObjectAgent* mySimEntryAgent;

         EntityAgentMap myEntityAgents;
         EntityUpdateGroupMap myRefreshRateGroups;
         EntityIdList myForceUpdateList;
         
         std::map<makVrv::DtUniqueID, DtVrfNetworkUpdateObjectDataState> myCache;
         
         int mySessionId;
         int myMessageVersion;

         mutable std::set<std::string> myRangeLabels;
         std::map<makVrv::DtUniqueID, DtString> myExtendedLabels;
         DtNetworkMessageInterfaceHandlerAgent* myNetworkMessageInterfaceHandlerAgent;

         typedef std::map<std::string, std::pair<DtRwProperties*, int> > BaseStateMap;
         BaseStateMap myBaseStateMap;

         DtTime myLastStatePropertyUpdate;
         DtClock myClock;

         EntityIdList myForceUpdateForCachedItem;
      };

      class VRF_PROTOCOL_EXPORT DtVrfObjectDataStateProcessorCreator : public makVrv::DtVirtualBaseClass
      {
      public:
         DtVrfObjectDataStateProcessorCreator();

         static DtVrfObjectDataStateProcessorCreator& instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn);

         static void registerInstance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn, 
            DtVrfObjectDataStateProcessorCreator* instance);

         virtual DtVrfObjectDataStateProcessor* create(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn, int sessionId, int messageVersion);
      };
   }
}