vrfStateViewCollectionManager.h

Go to the documentation of this file.

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



#pragma once

#include <vlutil/vlExceptions.h>

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfObjectDataState.h>
#include <vrfGuiCore/vrlinkSimulatedEnvironmentProcess.h>
#include <vrfGuiCore/spotReportState.h>
#include <vrfGuiCore/iffStateData.h>
#include <vrfGuiCore/propulsionNoiseStateData.h>
#include <vrfGuiCore/vrlinkEmitterSystemState.h>
#include <vrfGuiCore/vrlinkSimulatedWeatherState.h>
#include <vrfGuiCore/vrlinkActiveSonarState.h>
#include <vrfGuiCore/aggregateState.h>
#include <vrfGuiCore/extendedStateData.h>
#include <vrfGuiCore/vrfSpotReportDataHandler.h>
#include <vrfGuiCore/objectDataInterface.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/signalslib.h>

#include <vrvCore/DtSimData.h>
#include <vrvCore/DtElementEntry.h>
#include <vrvCore/DtStateViewCollection.h>
#include <vrvCore/DtEntityState.h>
#include <vrvCore/DtElementData.h>
#include <vrvCore/DtSensorFieldOfViewState.h>

#include <boost/function.hpp>
#include <boost/unordered_set.hpp>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtVrfSelectionFilter;

   class DT_DLL_VRFGUICORE DtStateViewMarkingTextProvider : public DtUUIDMarkingTextProvider
   {
   public:
      DtStateViewMarkingTextProvider(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* sv) : myStateView(sv) {};
      DtStateViewMarkingTextProvider(const DtStateViewMarkingTextProvider& orig) : myStateView(orig.myStateView) {};
      virtual ~DtStateViewMarkingTextProvider() {};
      virtual DtString markingText() { return myStateView->state().myMarkingText.c_str(); };
      virtual DtUUIDMarkingTextProvider* clone() const { return new DtStateViewMarkingTextProvider(*this); };

      operator DtString () { return markingText(); };

   protected:
      makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* myStateView;
   };

   class DT_DLL_VRFGUICORE DtVrfSimulatedEntityStateViewCollection
   : public makVrv::DtStateViewCollection<makVrv::DtVrlinkSimulatedEntityState>
   {
   public:
      DtVrfSimulatedEntityStateViewCollection(makVrv::DtDe& de) 
      : makVrv::DtStateViewCollection<makVrv::DtVrlinkSimulatedEntityState>(
         de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtVrlinkSimulatedBaseStateViewCollection
   : public makVrv::DtStateViewCollection<makVrv::DtVrlinkSimulatedBaseState>
   {
   public:
      DtVrlinkSimulatedBaseStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<makVrv::DtVrlinkSimulatedBaseState>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }

      bool isCompatible(makVrv::DtSimObjectEntry& entry)
      {
         return makVrv::DtStateViewCollection<makVrv::DtVrlinkSimulatedBaseState>::isCompatible(entry);
      }
   };

   class DT_DLL_VRFGUICORE DtVrfObjectDataStateViewCollection : public makVrv::DtStateViewCollection<DtVrfObjectDataState>
   {
   public:
      DtVrfObjectDataStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrfObjectDataState>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtIffStateDataViewCollection : public makVrv::DtStateViewCollection<DtIffStateData>
   {
   public:
      DtIffStateDataViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtIffStateData>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtWeatherStateViewCollection : public makVrv::DtStateViewCollection<DtVrlinkSimulatedWeatherState>
   {
   public:
      DtWeatherStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrlinkSimulatedWeatherState>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtPropulsionNoiseStateDataViewCollection : public makVrv::DtStateViewCollection<DtPropulsionNoiseStateData>
   {
   public:
      DtPropulsionNoiseStateDataViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtPropulsionNoiseStateData>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtEmitterSystemStateViewCollection : public makVrv::DtStateViewCollection<DtVrlinkEmitterSystems>
   {
   public:
      DtEmitterSystemStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrlinkEmitterSystems>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtActiveSonarStateViewCollection : public makVrv::DtStateViewCollection<DtVrlinkActiveSonars>
   {
   public:
      DtActiveSonarStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrlinkActiveSonars>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtEnvironmentStateViewCollection : public makVrv::DtStateViewCollection<DtVrlinkSimulatedEnvironmentProcess>
   {
   public:
      DtEnvironmentStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrlinkSimulatedEnvironmentProcess>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtExtendedStateDataViewCollection : public makVrv::DtStateViewCollection<DtExtendedStateData>
   {
   public:
      DtExtendedStateDataViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtExtendedStateData>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtAggregateStateViewCollection : public makVrv::DtStateViewCollection<DtVrlinkSimulatedAggregateState>
   {
   public:
      DtAggregateStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtVrlinkSimulatedAggregateState>(de, makVrv::DtSimEntryUpdater::NoUpdates)
      {
      }
   };

   class DT_DLL_VRFGUICORE DtSpotReportStateViewCollection : public makVrv::DtStateViewCollection<DtSpotReportState>
   {
   public:
      DtSpotReportStateViewCollection(makVrv::DtDe& de) :
         makVrv::DtStateViewCollection<DtSpotReportState>(de, makVrv::DtSimEntryUpdater::AnyUpdates)
      {
      }
   };

   
   class DT_DLL_VRFGUICORE DtVrfStateViewCollectionManager : public makVrv::DtVirtualBaseClass
   {
   public:
      typedef boost::signal<void (const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*)> StateViewAddedOrRemovedSignal;

   public:

      DtVrfStateViewCollectionManager(makVrv::DtDe&);
      virtual ~DtVrfStateViewCollectionManager();

      static DtVrfStateViewCollectionManager& instance(makVrv::DtDe& de);
      


      virtual DtBoost::shared_ptr<DtObjectDataInterface> lookupObjectData(const makVrv::DtUniqueID& id);

      virtual DtBoost::shared_ptr<DtObjectDataInterface> lookupSpotReportData(const makVrv::DtUniqueID& id);

      virtual DtBoost::shared_ptr<DtObjectDataInterface> lookupObjectData(const DtUUID&);

      virtual DtVector centerOfMass(const boost::unordered_set<DtUUID>& uuids,
         bool ignoreEmbarked = true);

      virtual DtBoost::shared_ptr<DtObjectDataInterface> lookupSpotReportData(const std::string& name);

      template<typename T_ObjectDataInterfaceType>
      DtBoost::shared_ptr<T_ObjectDataInterfaceType> lookupAndCastObjectData(const makVrv::DtUniqueID& id)
      {
         return DtObjectDataInterface::cast<T_ObjectDataInterfaceType>(lookupObjectData(id));
      }

      template<typename T_ObjectDataInterfaceType>
      DtBoost::shared_ptr<T_ObjectDataInterfaceType> lookupAndCastSpotReportData(const makVrv::DtUniqueID& id)
      {
         return DtObjectDataInterface::cast<T_ObjectDataInterfaceType>(lookupSpotReportData(id));
      }

      template<typename T_ObjectDataInterfaceType>
      DtBoost::shared_ptr<T_ObjectDataInterfaceType> lookupAndCastObjectData(const DtUUID& uuid)
      {
         return DtObjectDataInterface::cast<T_ObjectDataInterfaceType>(lookupObjectData(uuid));
      }

      template<typename T_ObjectDataInterfaceType>
      DtBoost::shared_ptr<T_ObjectDataInterfaceType> lookupAndCastSpotReportData(const std::string& name)
      {
         return DtObjectDataInterface::cast<T_ObjectDataInterfaceType>(lookupSpotReportData(name));
      }

      virtual DtBoost::shared_ptr<DtObjectDataInterface> lookupObjectData(makVrv::DtStateView<makVrv::DtSimState>* stateView);

      virtual makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* addMappingBasedOnMarkingTextAndUUID(const std::string& markingText, const DtUUID& uuid);

      virtual makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* findStateView(const DtUUID&, bool fullSearchIfMissing = false);

      virtual makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* findStealthStateView(const std::string& address,
         const std::string& markingText);

      virtual makVrv::DtStateView<DtSpotReportState>* findSpotReportStateView(const std::string& markingText);

      virtual makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* findStateView(const makVrv::DtUniqueID& id);

      makVrv::DtStateView<DtSpotReportState>* findSpotReportStateView(const makVrv::DtUniqueID& id)
      {
         if (!mySpotReportStateViewCollection->hasStateView(id))
         {
            return 0;
         }

         return const_cast<makVrv::DtStateView<DtSpotReportState>*>
            (mySpotReportStateViewCollection->findStateView(id));
      }

      virtual void clearUUIDInformation();

      DtVrfSimulatedEntityStateViewCollection* simulatedEntityStateViewCollection()
      {
         return mySimulatedEntityStateView;
      }

      DtVrlinkSimulatedBaseStateViewCollection* simulatedBaseStateViewCollection()
      {
         return mySimulatedBaseStateViewCollection;
      }

      DtVrfObjectDataStateViewCollection* objectDataStateViewCollection()
      {
         return myObjectDataStateViewCollection;
      }
      
      DtEnvironmentStateViewCollection* environmentStateViewCollection()
      {
         return myEnvironmentStateViewCollection;
      }
      
      DtExtendedStateDataViewCollection* extendedStateDataViewCollection()
      {
         return myExtendedStateDataViewCollection;
      }
      
      DtWeatherStateViewCollection* weatherStateViewCollection()
      {
         return myWeatherStateViewCollection;
      }

      DtIffStateDataViewCollection* iffStateDataViewCollection()
      {
         return myIffStateDataViewCollection;
      }
      
      DtPropulsionNoiseStateDataViewCollection* propulsionNoiseStateDataViewCollection()
      {
         return myPropulsionNoiseStateDataViewCollection;
      }
      
      DtEmitterSystemStateViewCollection* emitterSystemStateViewCollection()
      {
         return myEmitterSystemStateViewCollection;
      }
      
      DtActiveSonarStateViewCollection* activeSonarStateViewCollection()
      {
         return myActiveSonarStateViewCollection;
      }
      
      DtSpotReportStateViewCollection* spotReportStateViewCollection()
      {
         return mySpotReportStateViewCollection;
      }
      
      DtAggregateStateViewCollection* aggregateStateViewCollection()
      {
         return myAggregateStateViewCollection;
      }

      makVrv::DtVrlinkSensorFieldsOfViewStateViewCollection* sensorFieldOfViewStateViewCollection()
      {
         return mySensorFieldOfViewStateViewCollection;
      }

      makVrv::DtUniqueID parentId(const makVrv::DtUniqueID&) const;

      makVrv::DtUniqueID displayIdFromSimId(const makVrv::DtUniqueID& id, int modelSet = -1) const;
      makVrv::DtElementData::SceneObjectIdList displayIdsFromSimId(const makVrv::DtUniqueID& id, int modelSet = -1) const;

      makVrv::DtUniqueID simIdFromDisplayId(const makVrv::DtUniqueID& id) const;

      const std::map<makVrv::DtUniqueID, const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*>&
         stealthStates() const
      {
         return myStealthStates;
      }

      virtual std::string entityName(const makVrv::DtUniqueID simId) const;

      virtual DtUUID objectUUID(makVrv::DtUniqueID simId) const;

      virtual std::string overlayName(const makVrv::DtUniqueID simId) const;

      virtual makVrv::DtElementEntry::ElementType elementType(const makVrv::DtElementID&) const;

      virtual makVrv::DtSimEntryUpdater::UpdateRate updateRateFor(const makVrv::DtBaseStateView* state) const;

      typedef std::vector<makVrv::DtSimEntryUpdater::UpdateRate> UpdateRates;
      virtual makVrv::DtSimEntryUpdater::UpdateRate minimumRate(const UpdateRates&) const;
      virtual makVrv::DtSimEntryUpdater::UpdateRate maximumRate(const UpdateRates&) const;

      virtual void setUpdateRate(makVrv::DtSimEntry*, makVrv::DtSimEntryUpdater::UpdateRate, 
         makVrv::DtBaseStateView* state);

      virtual void forceUpdateForRelevantInformation(makVrv::DtUniqueID id);

      virtual StateViewAddedOrRemovedSignal& signalWhenObjectAdded(const DtVrfSelectionFilter&);
      virtual void processObjectAddedCallbacks(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);
      virtual void removeAddedSignalReference(const DtVrfSelectionFilter&);
      virtual void waiting();

      virtual StateViewAddedOrRemovedSignal& signalWhenObjectRemoved(const DtVrfSelectionFilter&);
      virtual void removeRemovalSignalReference(const DtVrfSelectionFilter&);

      virtual void processObjectRemovedCallbacks(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);

      virtual void slot_simStateAdded(makVrv::DtSimObjectEntry& e);
      virtual void slot_simStateToBeRemoved(makVrv::DtSimObjectEntry& e, makVrv::DtSimState&);

      virtual std::string lookupNameById(makVrv::DtUniqueID id);
      virtual makVrv::DtUniqueID lookupIdByUUID(const DtUUID&);

      virtual bool getSupportsWeightVariations(makVrv::DtUniqueID id);

      virtual const std::vector<makVrv::DtUniqueID>& dIGuyIds();

      virtual void signalWhenAllObjectsDiscovered(const std::map<short, int>&);


      virtual DtUUID uuidFromState(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*) const;
      virtual DtUUID uuidFromState(const makVrv::DtVrlinkSimulatedBaseState*) const;

      boost::signal <void (const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*)> signal_stateAdded;
      boost::signal <void (const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*)> signal_stateRemoved;

      boost::signal <void ()> signal_allObjectsDiscovered;

      boost::signal <void (const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*, const std::string& newName)> signal_nameChanged;

      const std::set<makVrv::DtUniqueID>& tacticalGraphicElements() const;

   protected:
      virtual void slot_onAttributesChanged( const makVrv::DtElementData::EntryAttributesList& signalList );

   protected:
      DtVrfSimulatedEntityStateViewCollection*  mySimulatedEntityStateView;
      DtVrlinkSimulatedBaseStateViewCollection* mySimulatedBaseStateViewCollection;
      DtVrfObjectDataStateViewCollection*       myObjectDataStateViewCollection;
      DtEnvironmentStateViewCollection*         myEnvironmentStateViewCollection;
      DtSpotReportStateViewCollection*          mySpotReportStateViewCollection;
      DtAggregateStateViewCollection*           myAggregateStateViewCollection;
      DtExtendedStateDataViewCollection*        myExtendedStateDataViewCollection;
      DtIffStateDataViewCollection*             myIffStateDataViewCollection;
      DtWeatherStateViewCollection*             myWeatherStateViewCollection;
      DtPropulsionNoiseStateDataViewCollection* myPropulsionNoiseStateDataViewCollection;
      DtEmitterSystemStateViewCollection*       myEmitterSystemStateViewCollection;
      DtActiveSonarStateViewCollection*         myActiveSonarStateViewCollection;
      makVrv::DtVrlinkSensorFieldsOfViewStateViewCollection* mySensorFieldOfViewStateViewCollection;
      makVrv::DtDe&                             myDe;

      std::map<short, int>                      myWaitingForDiscovery;

      typedef boost::unordered_map<makVrv::DtBaseStateView*, UpdateRates> UpdateRateMap;

      UpdateRateMap myUpdateRateMap;

      int myNextToken;
      struct StateViewAddedOrRemovedStruct
      {
         DtVrfSelectionFilter* filter;
         StateViewAddedOrRemovedSignal* added;
         int addedReference;
         StateViewAddedOrRemovedSignal* removed;
         int removedReference;
      };

      typedef std::vector<StateViewAddedOrRemovedStruct> StateViewAddedOrRemovedCallbacks;
      StateViewAddedOrRemovedCallbacks myStateViewAddedOrRemovedCallbacks;

      makVrv::DtSignalConnectionManager myConnectionManager;
      std::map<makVrv::DtElementID, bool> myWaiting;

      typedef boost::unordered_map<DtUUID, makVrv::DtUniqueID> UUIDToIdMap;
      typedef boost::unordered_map<makVrv::DtUniqueID, DtUUID> IdToUUIDMap;

      mutable UUIDToIdMap myUUIDToIdMap;
      mutable IdToUUIDMap myIdToUUIDMap;

      std::map<makVrv::DtUniqueID, const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*> myStealthStates;
      std::string myStealthType;

      std::set<makVrv::DtUniqueID> myTacticalGraphicElements;

      std::vector<makVrv::DtUniqueID> myDIGuyIds;
      boost::unordered_set<makVrv::DtUniqueID> myIdsToCheckForDIGuy;

      boost::unordered_set<DtUUID> myDidNotFindStateViewFor;
   };

   template<typename T> T findStateFor(makVrv::DtSimEntry* entry)
   {
      makVrv::DtSimEntry::SimStateVector::const_iterator pos    = entry->simStates().begin();
      makVrv::DtSimEntry::SimStateVector::const_iterator endPos = entry->simStates().end();
      for(; pos != endPos; ++pos)
      {
         T tState = dynamic_cast<T>(*pos);
         if(tState)
         {
            return tState;
         }
      }

      return 0;
   }

   DT_DLL_VRFGUICORE std::vector<DtUUID> convertMarkingTextVectorToUUIDVector(const std::vector<DtString>& v);
   DT_DLL_VRFGUICORE std::vector<DtUUID> convertMarkingTextVectorToUUIDVector(const std::vector<std::string>& v);

   DT_DLL_VRFGUICORE std::vector<std::string> convertUUIDVectorToUUIDStringVector(const std::vector<DtUUID>& v);

   DT_DLL_VRFGUICORE std::vector<std::string> convertUUIDVectorToMarkingTextVector(const std::vector<DtUUID>& v);
}