embeddedEntityInfoManager.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/scriptedTaskManager.h"
#include "vrfobjcore/vrfobjcoreDefines.h"

#include "vrftasks/radioMessageTypes.h"
#include "vrfmsgs/messageTypes.h"

#include <list>
#include <map>

class DtObjectType;
class DtPrintInfoCacheCommand;
class DtSimManager;
class DtSimMessage;
class DtVrfObject;

struct DtEmbeddedEntity;

class DT_DLL_vrfobjcore DtEmbeddedEntityInfoManager
{
public:
   DtEmbeddedEntityInfoManager(DtSimManager* simManager);
   ~DtEmbeddedEntityInfoManager();

   virtual bool init();

   virtual bool hasCachedDataFor(const DtObjectType& objType) const;

   virtual bool typeIsQueuedForUpdate(const DtObjectType& objType) const;

   virtual const std::vector<DtEmbeddedEntity> embeddedEntityListFor(const DtObjectType& objType)const;
   virtual const std::vector<DtSetMessageType> availableSetsFor(const DtObjectType& objType)const;
   virtual const std::vector<DtSimTaskMessageType> availableTasksFor(const DtObjectType& objType) const;

   virtual const DtSimManager* simManager() const;
   virtual DtSimManager* simManager();

   virtual void performCacheUpdates();

   virtual void suspend();

   virtual void resume();

   virtual void resetCache();

   static void eeInfoCacheRequestCallback(DtSimMessage* msg, void* usrData);
   virtual void processEeInfoCacheRequest(DtSimMessage* msg);

   virtual std::string toString();

protected:

   virtual bool isCachableType(const DtObjectType&) const;

   virtual void queueCacheUpdateFor(const std::vector<DtEmbeddedEntity>& entities, const DtVector& position);

   virtual DtVrfObject* createPrototypeObject(const DtObjectType& objType, const DtVector& position);

   virtual std::vector<DtEmbeddedEntity> retrieveEmbeddedEntityList(const DtVrfObject* const obj);
   virtual std::vector<DtSetMessageType> retrieveAvailableSets(const DtVrfObject* const obj);
   virtual std::vector<DtSimTaskMessageType> retrieveAvailableTasks(const DtVrfObject* const obj);

   virtual void populateCacheUsing(const DtVrfObject* const obj, bool suppressRecursion);

   static void objectAddedCallback(const DtVrfObject* obj, void* usrData);
   virtual void processObjectAdded(const DtVrfObject& obj);

   static void scriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info, void* usrData);
   virtual void processScriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info);

   virtual void sendCacheResponseFor(const DtObjectType& requestedType);

   virtual void addTaskBinding(const DtObjectType& objType, const DtSimTaskMessageType& taskType);
   virtual void removeTaskBinding(const DtObjectType& objType, const DtSimTaskMessageType& taskType);

private:
   DtEmbeddedEntityInfoManager(const DtEmbeddedEntityInfoManager& orig);

   DtEmbeddedEntityInfoManager& operator=(const DtEmbeddedEntityInfoManager& orig);

protected:

   DtSimManager* mySimManager;

   std::map<DtObjectType, std::vector<DtEmbeddedEntity> > myEmbeddedEntityListCache;
   std::map<DtObjectType, std::vector<DtSetMessageType> > myAvailableSetsCache;
   std::map<DtObjectType, std::vector<DtSimTaskMessageType> > myAvailableTasksCache;

   std::map<DtObjectType, DtVector> myTypesToCache;

   DtPrintInfoCacheCommand* myPrintInfoCacheCommand;

   bool mySuspended;
};