spawnSinkManager.h

Go to the documentation of this file.

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

#pragma once

#include <vrfobjcore/vrfobjcoreDefines.h>
#include <vrfobjcore/simObjectReference.h>
#include <vrfExtProtocol/objectTypeEnums.h>
#include <vrfMsgTransport/vrfMessageInterface.h>
#include <vrfmsgs/simInterfaceMessage.h>
#include <vrfmsgs/rwSpawnDataList.h>
#include <boost/unordered_map.hpp>

class DtSimulationServices;
class DtScenario;
class DtRwSpawnTemplateList;
class DtLocalObjectManager;
class DtLocalObject;

class DT_DLL_vrfobjcore DtSpawnSinkManager
{
public:
   DtSpawnSinkManager(DtSimulationServices* simManager, DtLocalObjectManager*);

   virtual ~DtSpawnSinkManager();

   virtual bool init();

   virtual bool loadTemplates(const DtFilename& filename, bool sendUpdate = true);

   virtual const DtRwSpawnDataList* spawnTemplates() const;

   virtual DtRwSpawnData* findSpawnDataByUUID(const DtUUID& uuid);

   virtual void updateSpawnSinkTemplates(
      const DtRwSpawnDataList& spawnDataList);

   //****************************************************************************
   //****************************************************************************
   static void preScenarioLoadCallback(DtScenario& scenario,
      void* usrData);

   static void preScenarioRewindCallback(void* usrData);

   static void preScenarioImportCallback(DtScenario& scenario,
      void* usrData);
   virtual void preScenarioImport(DtScenario& scenario);

   static void postScenarioImportCallback(const DtScenario& scenario,
      void* usrData);
   virtual void postScenarioImport(const DtScenario& scenario);

   virtual DtUUID uuidForTemplateName(const DtString& templateName) const;

   virtual bool addSpawnPoint(const DtUUID& templateUuid, const DtUUID& spawnPointUuid);

   virtual void removeSpawnPoint(const DtUUID& templateUuid, const DtUUID& spawnPointUuid);

   virtual void resetManagerTemplates(const DtRwSpawnDataList& templates, const DtFilename& templateFilename, bool sendUpdates = true);

   virtual void clearTemplates();

//****************************************************************************
//****************************************************************************
   static void requestSpawnListCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestSpawnList(DtSimMessage* msg);

   static void spawnTemplateListCallback(DtSimMessage* msg, void* usr);
   virtual void preocesSpawnTemplateList(DtSimMessage* msg);

   virtual void sendSpawnListMessage(const DtSimulationAddress& recipient,
      bool initialSend = false);

   static void addSinkPointCallback(DtSimMessage* msg, void* usr);
   virtual void processAddSinkPoint(DtSimMessage* msg);

   static void requestSpawnDataCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestSpawnData(DtSimMessage* msg);

   static void updateSpawnTemplateCallback(DtSimMessage* msg, void* usr);
   virtual void processUpdateSpawnTemplate(DtSimMessage* msg);

   static void createTemplateCallback(DtSimMessage* msg, void* usr);
   virtual void processCreateTemplate(DtSimMessage* msg);

   static void deleteSpawnTemplateCallback(DtSimMessage* msg, void* usr);
   virtual void processDeleteSpawnTemplate(DtSimMessage* msg);

   virtual void processSimObjectDeleted(DtSimObjectReference ref);

   virtual void processAddSpawnPoint(const DtSimObject *object);

   virtual void addSpawnSinkPoint(DtSimObjectReference ref);

   virtual void renameSpawnPoint(DtLocalObject *spawnEntity, const DtString& oldTemplateName,
      const DtString& newTemplateName);
   virtual void renameSinkPoint(DtLocalObject *spawnEntity, const DtString& oldTemplateName,
      const DtString& newTemplateName);

   virtual void removeSpawnTemplateAsParentOfSinkPoint(const DtUUID& templateUUID, const DtUUID& sinkPoint);
   virtual void addSpawnTemplateAsParentOfSinkPoint(const DtUUID& templateUUID, const DtUUID& sinkPoint);
      
   virtual void upgradeTemplates(const DtRwSpawnDataList& templates, bool andRename = false);
   virtual void removeNameMappings(const DtRwSpawnDataList& templates);
   virtual void resolveUnmatchedSpawnPoints();

   virtual const DtRwSpawnDataList& templates();

   typedef void (*DtClearTemplateUUIDFunction)(void* userData);
   typedef void (*DtRefreshSpawnDataFunction)(void* userData);

   virtual void addClearTemplateUUIDEntry(
      DtClearTemplateUUIDFunction fcn, void* userData);
   virtual void removeClearTemplateUUIDEntry(
      DtClearTemplateUUIDFunction fcn, void* userData);

   virtual void addRefreshSpawnDataEntry(
      DtRefreshSpawnDataFunction fcn, void* userData);
   virtual void removeRefreshSpawnDataEntry(
      DtRefreshSpawnDataFunction fcn, void* userData);

   virtual DtUUID uuidBasedOnName(const DtList& templateList, const DtString&) const;

protected:
   DtSimulationServices* mySimulationServices;
   DtLocalObjectManager* myObjectManager;

   DtRwSpawnDataList myTemplates;
   DtRwSpawnDataList myCurrentTemplates;

   DtNoArgumentCallbackList     myClearTemplatesCallbackList;
   DtNoArgumentCallbackList     myRefreshSpawnDataCallbackList;

   boost::unordered_map<DtRwSpawnData*, DtString> myCurrentUUIDsOnImport;
   bool myTemplatesModified;

   typedef boost::unordered_map<DtUUID, DtUUID> PointByTemplate;
   PointByTemplate mySpawnPoints;
   PointByTemplate mySinkPoints;

   typedef std::map<DtString, DtUUID> WaitingForSinkPoints;
   WaitingForSinkPoints myWaitingForSinkPoints;

   std::map<DtString, DtString> myNewSpawnNameToOldSpawnNameMap;

   boost::signals2::scoped_connection mySimObjectAddedConnection;
   boost::signals2::scoped_connection mySimObjectDeletedConnection;
};