scriptMultiTaskController.h

Go to the documentation of this file.

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

#include <vrfmodel/vrfmodelDefines.h>

#include <map>
#include <vrfobjcore/multiTaskControllerComponent.h>
#include "vrfobjcore/scriptedTaskManager.h"
#include "vrftasks/radioMessageTypes.h"
#include <vrfobjcore/scriptInterface.h>
#include "vrfmsgs/vrfObjectMessage.h"
#include "vrfobjcore/scriptMultiTaskControllerPSR.h"
#include "vrfmsgs/simMessage.h"
#include "vrfutil/scriptedTaskMetaData.h"
#include "vrfobjcore/scriptTaskControllerInterface.h"

class DtSimMessage;

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

   virtual ~DtScriptMultiTaskController();

   virtual const char* type() const;

   virtual bool init();

   virtual void preFirstTickInit();

   virtual void tick();

   virtual bool tickWhileDestroyed() const;

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

   virtual void clearTask(int taskId);

   virtual void taskComplete(int taskId, bool success);

   virtual void suspendTask(int taskId);

   virtual DtSimTaskStatePtr currentTaskState(int taskId) const;

   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, const DtString& system = "");
   virtual void removeTypeTaskable(const DtSimTaskMessageType& taskType);

   virtual void addRunnableTaskType(const DtSimTaskMessageType& taskType, const DtString& system);
   virtual void removeRunnableTaskType(const DtSimTaskMessageType& taskType);
   
   virtual void sweepMarkedForDeletion(bool clearFromPsr = true);

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

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

   virtual void scriptSetTickPeriod(const DtString& scriptId, double period);
   virtual void scriptSetTickWhilePaused(const DtString& scriptId, bool enable);
   virtual void scriptSetRespondToNewSensorContacts(const DtString& scriptId, bool respond);
   virtual void scriptTaskComplete(int taskId, bool success);
   virtual int scriptSendSubtask(DtSimTask& task, int parentTaskId);
   virtual std::vector<int> scriptPendingSubstaskIds(int taskId);
   virtual DtSubtaskStatusEntry* scriptSubtaskStatus(int subtaskId, int parentTaskId);
   virtual void scriptClearSubtask(int subtaskId, int parentTaskId);
   virtual void setCheckpointModeUseCheckpointState(const DtString& scriptId, bool);
   virtual bool checkpointModeUseCheckpointState(const DtString& scriptId) const;

   virtual int askUserQuestion(const DtString& scriptId,
      const DtTranslatableStream& title, const DtTranslatableStream& message,
      const std::vector<DtTranslatableStream>& options, int displayFlag);
   virtual int statusOfUserQuestion(int questionId);
   virtual void cancelUserQuestion(int questionId);

   virtual int scriptSendTask(DtSimTask& task, const DtString& entityName, int parentTaskId,
      bool actAsSubtask = true);

   virtual void notifyScriptTaskError(const DtString& scriptId, int taskId);

   virtual DtPointTaskVisualizationPtr pointTaskVisualization(int taskId, const DtString& visName);
   virtual DtLineTaskVisualizationPtr lineTaskVisualization(int taskId, const DtString& visName);
   virtual DtAreaTaskVisualizationPtr areaTaskVisualization(int taskId, const DtString& visName);
   virtual DtTextTaskVisualizationPtr textTaskVisualization(int taskId, const DtString& visName);
   virtual void deleteTaskVisualization(int taskId, const DtString& visName);

   virtual void addAdditionalReactiveTask(const DtSimTaskMessageType&);


   static void newSensorContactCallback(DtVrfObject* object, void* usr);
   virtual void processNewSensorContact(DtVrfObject* object);

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

   virtual int nextBackgroundProcessId() const;

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

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

   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);

   virtual void clearAndRestoreTasks();

   static void userQuestionOperationCallback(DtSimMessage* msg, void* usrData);
   virtual void processUserQuestionOperation(DtSimMessage*);

   virtual void sendOffOutstandingQuestionFor(const DtString& scriptId);

   virtual bool backgroundProcessAvailable() const;

protected:
   std::map<DtSimTaskMessageType, int> myAvailableScripts;
   std::map<DtSimTaskMessageType, int> myBackgroundProcesses;

   std::map<int, boost::shared_ptr<DtScriptInterface> > myCurrentTaskMap;
   std::list<int> myMarkedForDeletionList;
   std::list<DtString> myRespondToNewSensorContactList;
   DtScriptMultiTaskControllerPSR* myProcessState;
   bool myAreCallbacksRegistered;
   std::map<DtSimTaskMessageType, DtString> myAdditionalRunnableTaskTypes;
   DtForceType myCurrentForceType;

   bool myIsDestroyed;

   bool myQueueTasksToBeAdded;
   std::map<DtSimTaskMessageType, DtString> myTasksToBeAdded;

   std::set<DtSimTaskMessageType> myAdditionalReactiveTasks;
};