vrfEnvironmentObjectDataStateProcessor.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 <vrvVrl/DtVrlinkTacticalGraphicStateListener.h>
#include <vrvVrl/DtEnvironmentalExistenceListener.h>
#include <vrvUtil/DtBalancedUpdater.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtSimEntryObjectAgent.hpp>
#include <vlutil/vlPerformanceStats.h>

namespace makVrv
{
   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtStateListenerInterface;
   }
}

namespace makVrf 
{
   class DtNetworkMessageInterfaceHandlerAgent;

   namespace VRF_PROTOCOL_NAMESPACE
   {
      class VRF_PROTOCOL_EXPORT DtVrfEnvironmentObjectDataStateProcessor : public makVrv::DtVirtualBaseClass
      {
      public:

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

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

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

         virtual ~DtVrfEnvironmentObjectDataStateProcessor();
         
         void postDrainInput();

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

         void forceObjectUpdate(makVrv::DtUniqueID uniqueId);

         void environmentDiscovered(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener);

         void environmentToBeDeleted(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener);

         virtual void createAndSendState(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
            makVrv::DtSimStateObjectAgent& objectDriver);

         virtual void setupState(
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener, DtVrfNetworkUpdateObjectDataState& state);

         virtual void rangeItemsFrom(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
            std::vector<DtRangeItem>& item);

         virtual void addRangeRingItemToVisuals(const DtRangeItem& item);

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

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

      protected:

         static void postDrainInput(void* usr);

         virtual void slot_postUpdateCallback(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener);

         virtual bool keyDataChanged(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface&
            listener) const;

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

            VrfEnvironmentObjectDataStateUpdater(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
               DtVrfObjectDataStateObjectAgent& driver,
               DtVrfEnvironmentObjectDataStateProcessor& processor);

            VrfEnvironmentObjectDataStateUpdater(const VrfEnvironmentObjectDataStateUpdater& orig);

            VrfEnvironmentObjectDataStateUpdater& operator=(const VrfEnvironmentObjectDataStateUpdater& orig);

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

            void update(double timeT);

         protected:

            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* myListener;
            DtVrfObjectDataStateObjectAgent* myObjectAgent;
            DtVrfEnvironmentObjectDataStateProcessor* myProcessor;
         };
    
         typedef std::vector<makVrv::DtUniqueID> EnvironmentIdList;

         struct EnvironmentSimDataInstance
         {
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* myListener;
            DtVrfObjectDataStateObjectAgent* myAgent;
            makVrv::DtSimEntryUpdater::UpdateRate myRate;
         };

         typedef std::map<makVrv::DtUniqueID,EnvironmentSimDataInstance > EnvironmentAgentMap;

         typedef makVrv::DtBalancedUpdater<VrfEnvironmentObjectDataStateUpdater> EnvironmentUpdaterGroup;
         typedef std::map<makVrv::DtSimEntryUpdater::UpdateRate,EnvironmentUpdaterGroup>
            EnvironmentUpdateGroupMap;                  

      protected:

         makVrv::DtSignalConnectionManager myConnections;

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

         DtNetworkMessageInterfaceHandlerAgent* myNetworkMessageInterfaceHandlerAgent;

         EnvironmentAgentMap myEnvironmentAgents;
         EnvironmentUpdateGroupMap myRefreshRateGroups;
         EnvironmentIdList myForceUpdateList;
         
         int mySessionId;
         int myMessageVersion;

         mutable std::set<std::string> myRangeLabels;

         typedef std::map<makVrv::DtUniqueID, DtVrfNetworkUpdateObjectDataState> StateMap;
         StateMap myStateMap;
      };

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

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

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

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