scriptReactiveTaskController.h

Go to the documentation of this file.

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

#include "vrfobjcore/vrfobjcoreDefines.h"

#include "vrfobjcore/scriptReactiveTaskControllerPSR.h"
#include "vrfmsgs/simMessage.h"
#include "vrfmsgs/setDataRequestMessage.h"
#include "vrfobjcore/scriptInterface.h"
#include "vrfobjcore/scriptTaskControllerInterface.h"
#include "vrftasks/scriptedTaskTask.h"
#include <set>
#include "vrftasks/setReactiveTaskCancel.h"
#include "vrftasks/setReactiveTaskDisabled.h"
#include "vrftasks/setReactiveTaskPriority.h"
#include <vrftasks/setReactiveTaskTable.h>
#include "vrftasks/setReactiveTaskEnabled.h"
#include <boost/shared_ptr.hpp>
#include "vrfobjcore/scriptInterfaceHandler.h"
#include "vrfobjcore/scriptedTaskManager.h"
#include "vrfobjcore/controllerComponent.h"

class DtRwVariableBindings;
class DtSimMessage;


class DT_DLL_vrfobjcore DtScriptReactiveTaskController : public DtControllerComponent, public DtScriptTaskControllerInterface
{
public:
   DtScriptReactiveTaskController(const DtString& name, 
      DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry* parentRegistry);

   virtual ~DtScriptReactiveTaskController();

   virtual const char* type() const;

   virtual bool init();

   virtual void preFirstTickInit();

   virtual void tick();

   virtual std::list<DtScriptedTaskTask> reactiveTaskStatus() const;

   virtual bool isReactiveTaskEnabled(const DtSimTaskMessageType& scriptId) const;
   virtual void notifySuspend(const DtSimTaskMessageType& scriptId, int taskId);
   virtual void notifyResume(const DtSimTaskMessageType& scriptId, int taskId);
   virtual void processReturnScriptInterface(const DtSimTaskMessageType& scriptId, int taskId, boost::shared_ptr<DtScriptInterface> iFace);

   virtual bool enableReactiveTask(const DtSimTaskMessageType& scriptId, DtRwVariableBindings& params, const DtString& systemName, bool resetIfEnabled = false);

   static void setReactiveTaskCallback(DtSimMessage* msg, void* usr);
   static void scriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info, void* usr);

   virtual void scriptSetTickPeriod(int taskId, const DtString& scriptId, double period);
   virtual void scriptSetTickWhilePaused(int taskId, const DtString& scriptId, bool enable);
   virtual void scriptSetRespondToNewSensorContacts(int taskId, const DtString& scriptId, bool tick);
   virtual void scriptTaskComplete(int taskId, bool success);
   virtual void scriptSetComplete(const DtString&);
   virtual int scriptSendSubtask(DtSimTask& task, int parentTaskId);
   virtual std::vector<int> scriptPendingSubstaskIds(int taskId);
   virtual DtSubtaskStatusEntry* scriptSubtaskStatus(int subtaskId, int parentTaskId);
   virtual void cleanupInactiveSubtaskStatus(int parentTaskId);
   virtual void scriptClearSubtask(int subtaskId, int parentTaskId);
   virtual int scriptSendTask(DtSimTask& task, const DtUUID& entityName, int parentTaskId, bool actAsSubtask = true, bool useRadio = false);
   virtual void setCheckpointModeUseCheckpointState(int taskId, const DtString& scriptId, bool);
   virtual bool checkpointModeUseCheckpointState(int taskId, 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 void addReactiveTaskType(const DtSimTaskMessageType&, const DtString& system = "");

   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 bool createPSR();

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

   virtual std::vector<DtSimTaskMessageType> availableReactiveTasks() const;
   virtual DtString systemFor(const DtSimTaskMessageType& scriptId) const;

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

   virtual bool shouldInvokeCheck(DtRwScriptReactiveTaskEntry* entry);

   virtual DtRwScriptReactiveTaskEntry* createDefaultEntry(const DtString& scriptId, const DtString& system = "");
   virtual bool createAndInitScriptInterface(DtRwScriptReactiveTaskEntry* entry, DtRwVariableBindings* params, bool loadState = false);

   virtual void activateReactiveTask(DtRwScriptReactiveTaskEntry* entry);
   virtual void disableReactiveTask(DtRwScriptReactiveTaskEntry* entry, bool cancelActive);

   virtual void processSetReactiveTaskCallback(DtSetDataRequest* setMsg);
   virtual void processSetCancel(DtSetReactiveTaskCancel* setMsg);
   virtual void processSetDisabled(DtSetReactiveTaskDisabled* setMsg);
   virtual void processSetEnabled(DtSetReactiveTaskEnabled* setMsg);
   virtual void processSetPriority(DtSetReactiveTaskPriority* setMsg);
   virtual void processSetTable(DtSetReactiveTaskTable* setMsg);

   virtual void setupReactiveTasks();

   virtual void processScriptUpdatedCallback(const DtScriptedTaskManagerCallbackInfo& info);

   virtual bool doesScriptIdApply(const DtSimTaskMessageType& scriptId) const;
   virtual bool isForMyEntityType(const DtScriptedTaskMetaData& metaData) const;

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

   virtual void sendOffOutstandingQuestionFor(const DtSimTaskMessageType& scriptId);

   virtual void addReactiveTaskEntry(const DtSimTaskMessageType& scriptId, DtRwScriptReactiveTaskEntry* entry, bool deleteOnUpdate = true);
   virtual void queueReactiveTaskCallback(DtSetDataRequest* setMsg);

protected:
   DtScriptReactiveTaskControllerPSR* myProcessState;
   DtForceType myCurrentForceType;

   std::map<DtSimTaskMessageType, DtString> myAdditionalReactiveTasks;

   std::map<DtSimTaskMessageType, bool> mySavedCheckpointMode;
   std::map<DtSimTaskMessageType, double> mySavedTickPeriodSettings;
   std::map<DtSimTaskMessageType, bool> mySavedTickWhilePausedSettings;

   std::vector<DtSetDataRequest*> myQueuedReactiveTaskCallbacks;
};