include/vrfVrlSharedSource/DtExtendedStateDataProcessor.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtExtendedStateDataProcessor.h,v $ $Revision: 1.2 $ $State: Exp $
******************************************************************************/


#pragma once

#include <vrfGuiCore/DtExtendedStateDataObjectAgent.hpp>

#include <vrvVrl/vrvVrl.h>

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

namespace makVrv
{
   class DtStateListenerInterface;
   class DtEntityStateListener;
   class DtAggregateStateListener;
   class DtSimpleTypedDictionary;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtVrlinkEnvironmentalStateListenerInterface;
   }
}

namespace makVrf 
{
   namespace VRF_PROTOCOL_NAMESPACE
   {

      class DtExtendedStateDataProcessor : public makVrv::DtSimDataProcessorInterface
      {
      public:

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

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

         DtExtendedStateDataProcessor(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual ~DtExtendedStateDataProcessor();
         
         void postDrainInput();

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

         void forceObjectUpdate(makVrv::DtUniqueID uniqueId);

         virtual void createAndSendState(makVrv::DtUniqueID id, makVrv::DtSimStateObjectAgent& objectDriver);

         virtual DtSimpleTypedDictionary& extendedStateFor(makVrv::DtUniqueID id, bool forceUpdate = true);

         virtual bool hasStateFor(makVrv::DtUniqueID) const;

         virtual DtExtendedStateData stateFor(makVrv::DtUniqueID id) const;

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

      protected:

         static void postDrainInput(void* usr);

         virtual void entityToBeDestroyed(makVrv::DtEntityStateListener&);
         virtual void aggregateToBeDestroyed(makVrv::DtAggregateStateListener&);
         virtual void environmentalToBeDestroyed(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface&);
         virtual void itemToBeDestroyed(makVrv::DtUniqueID);

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

            ExtendedStateDataUpdater(makVrv::DtUniqueID id, DtExtendedStateDataObjectAgent& driver,
               DtExtendedStateDataProcessor& processor);

            ExtendedStateDataUpdater(const ExtendedStateDataUpdater& orig);

            ExtendedStateDataUpdater& operator=(const ExtendedStateDataUpdater& orig);

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

            void update(double timeT);

         protected:
            makVrv::DtUniqueID myId;
            DtExtendedStateDataObjectAgent* myObjectAgent;
            DtExtendedStateDataProcessor* myProcessor;
         };
    
         typedef std::vector<makVrv::DtUniqueID> ExtendedStateDataIdList;

         struct ExtendedStateDataInstance
         {  
            makVrv::DtUniqueID myId;
            DtExtendedStateDataObjectAgent* myAgent;
            makVrv::DtSimEntryUpdater::UpdateRate myRate;
            DtExtendedStateData myStateData;
         };

         typedef std::map<makVrv::DtUniqueID,ExtendedStateDataInstance > ExtendedStateDataAgentMap;

         typedef makVrv::DtBalancedUpdater<ExtendedStateDataUpdater> ExtededStateDataUpdaterGroup;
         typedef std::map<makVrv::DtSimEntryUpdater::UpdateRate,ExtededStateDataUpdaterGroup>
            ExtendedStateDataUpdateGroupMap;                  

      protected:

         makVrv::DtSignalConnectionManager myConnections;

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

         ExtendedStateDataAgentMap myExtendedStateDataAgents;
         ExtendedStateDataUpdateGroupMap myRefreshRateGroups;
         ExtendedStateDataIdList myForceUpdateList;
      };
   }
}