environmentSimDataProcessor.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/vrlinkSimulatedEnvironmentProcess.h>
#include <vrfutil/rwUUID.h>

#include <vrvCore/DtSimEntryUpdater.h>
#include <vrvCore/DtSimDataProcessorInterface.h>
#include <vrvVrl/DtVrlinkConnection.h>

#include <vrvUtil/DtBalancedUpdater.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vlutil/vlPerformanceStats.h>

namespace makVrv
{
   class DtSimEntryObjectAgent;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtVrlinkEnvironmentalStateListenerInterface;
      class DtEnvironmentalExistenceListener;
   }
}

class DtVrfRemoteController;
class DtReflectedObject;

namespace makVrf
{
   class DtEnvironmentStateObjectAgent;
   
   namespace VRF_PROTOCOL_NAMESPACE
   {
      class VRF_PROTOCOL_EXPORT DtEnvironmentSimDataProcessor : public makVrv::DtSimDataProcessorInterface
      {
      public:

         DtEnvironmentSimDataProcessor(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim, DtVrfRemoteController*);

         virtual ~DtEnvironmentSimDataProcessor();

         static DtEnvironmentSimDataProcessor* findInstance(
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim)
         {
            return dynamic_cast<DtEnvironmentSimDataProcessor*>(
               sim.findInstance("DtEnvironmentSimDataProcessor"));
         }

         static void registerInstance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim,
            DtEnvironmentSimDataProcessor* proc)
         {
            sim.registerInstance("DtEnvironmentSimDataProcessor",proc);
         }
         
         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,
            DtEnvironmentStateObjectAgent& objectDriver, bool force = false);
         virtual bool setState(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
            DtVrlinkNetworkUpdateSimulatedEnvironmentProcess& state, const DtRwProperties& stateProperties, bool forceStatePropertyUpdate = false);
         virtual DtVector setupPoints(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
            DtVrlinkNetworkUpdateSimulatedEnvironmentProcess& state);

         virtual void postRemoteControllerInit();
         virtual void cleanup();

      protected:

         static void postDrainInput(void* usr);

         virtual void slot_modelSetChanged();

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


         virtual bool updateState(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener);
         virtual bool updateExtendedState(
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener);

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

         static void uuidChangedCallback(DtReflectedObject* obj, const DtUUID& uuid, void* usr);
         virtual void processUUIDChanged(DtReflectedObject* obj, const DtUUID& uuid);

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

            EnvironmentStateUpdater(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface& listener,
               DtEnvironmentStateObjectAgent& driver, DtEnvironmentSimDataProcessor& processor);

            EnvironmentStateUpdater(const EnvironmentStateUpdater& orig);

            EnvironmentStateUpdater& operator=(const EnvironmentStateUpdater& orig);

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

            void update(double timeT);

         protected:

            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* myListener;
            DtEnvironmentStateObjectAgent* myObjectAgent;
            DtEnvironmentSimDataProcessor* myProcessor;
         };
    
         typedef std::set<makVrv::DtUniqueID> EnvironmentIdList;

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

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

         typedef makVrv::DtBalancedUpdater<EnvironmentStateUpdater> 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;

         EnvironmentAgentMap myEnvironmentAgents;
         EnvironmentUpdateGroupMap myRefreshRateGroups;
         EnvironmentIdList myForceUpdateList;
         
         typedef boost::unordered_map<makVrv::DtUniqueID, DtVrlinkNetworkUpdateSimulatedEnvironmentProcess> StateMap;
         StateMap myStateMap;
         std::map<makVrv::DtUniqueID, DtString> myExtendedLabels;

         struct BaseState
         {
            BaseState() : vrlEnvProc(), stateProps(0), count(0) {};
            BaseState(int c) : vrlEnvProc(), stateProps(0), count(c) {};


            DtVrlinkNetworkUpdateSimulatedEnvironmentProcess vrlEnvProc;
            DtRwProperties* stateProps;
            int count;
         };

         typedef std::map<std::string, BaseState > BaseStateMap;
         BaseStateMap myBaseStateMap;
         std::map<makVrv::DtUniqueID, DtUUID> myUUIDMap;
         bool myReportUUIDChanges;
         bool myReportForceChanges;

         DtVrfRemoteController* myRemoteController;
      };

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

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

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

         virtual DtEnvironmentSimDataProcessor* create(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn, DtVrfRemoteController*);
      };
   }
}