scriptMultiTaskController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once

#include <vrfmodel/vrfmodelDefines.h>

#include <map>
#include <vrfobjcore/multiTaskControllerComponent.h>
#include "vrfobjcore/scriptedTaskManager.h"
#include "vrftasks/radioMsgTypes.h"
#include <vrfmodel/scriptInterface.h>
#include "vrfmsgs/vrfObjectMessage.h"
#include "vrfobjcore/scriptMultiTaskControllerPSR.h"
#include "vrfmsgs/simMsg.h"
#include "vrfutil/scriptedTaskMetaData.h"


class DT_DLL_vrfmodel DtScriptMultiTaskController : public DtMultiTaskControllerComponent
{
public:
   DtScriptMultiTaskController(const DtString& name, 
      DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry* parentRegistry);

   virtual ~DtScriptMultiTaskController();

   virtual DtString type() const;

   virtual bool init();

   virtual void preFirstTickInit();

   virtual void tick();

   virtual bool beginProcessingTask(const DtTaskMessage& task, DtSimTaskStatePtr taskState);

   virtual void clearTask(int taskId);

   virtual void taskComplete(int taskId, bool success);

   virtual bool createPSR();
   
   virtual void registerScriptTaskCallbacks();
   virtual void unregisterScriptTaskCallbacks();

   virtual void registerTaskMsgCallbacks();
   virtual void unregisterTaskMsgCallbacks();

   virtual bool isTypeTaskable(const DtSimTaskMessageType& taskType) const;
   virtual void addTypeTaskable(const DtSimTaskMessageType& taskType);
   virtual void removeTypeTaskable(const DtSimTaskMessageType& taskType);
   
   virtual void sweepMarkedForDeletion(bool clearFromPsr = true);

   virtual DtScriptedTaskManager* scriptManager() const { return myScriptManager; }

   virtual void setScriptTickPeriod(const DtString& scriptId, double period);

   static void scriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info, void* usr);
   static void scenarioSaveCallback(void* usr);

   static DtSimComponent* creator(const DtString& name, 
      DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry* parentRegistry);

protected:
   DtScriptMultiTaskController(const DtScriptMultiTaskController& other);
   DtScriptMultiTaskController& operator=(const DtScriptMultiTaskController& other);

   virtual void processScriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info);
   virtual void processScenarioSaveCallback();

   virtual DtScriptInterface* createScriptInterface(const DtSimTaskMessageType& taskType);
   virtual void destroyScriptInterface(DtScriptInterface* iFace);
   virtual void propagateScriptIdChange(const DtString& oldId, const DtString& newId);
   virtual bool isForMyEntityType(const DtScriptedTaskMetaData& metaData);
   virtual void processMetaDataChange(const DtScriptedTaskManagerCallbackInfo& info);
   virtual void restartScriptInterfaceByType(const DtSimTaskMessageType& taskType);

   DtScriptedTaskManager* myScriptManager;
   std::map<DtSimTaskMessageType, int> myAvailableScripts;
   std::map<int, DtScriptInterface*> myCurrentTaskMap;
   std::list<int> myMarkedForDeletionList;
   DtScriptMultiTaskControllerPSR* myProcessState;
   bool myAreCallbacksRegistered;
};