taskControllerComponent.h

Go to the documentation of this file.

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




#pragma once

#include "vrfobjcore/controllerComponent.h"
#include "vrftasks/simTaskState.h"
#include "vrfmsgs/messageExecutive.h"
#include "vrftasks/taskAndTaskStateDefines.h"
#include "vrftasks/radioMessageTypes.h"


class DtSimManager;
class DtTaskMessage;
class DtSimMessage;
class DtSuspendedTaskInfo;

typedef void (*DtTaskMessageCallbackFcn)(DtSimMessage * msg, void * usr, 
                                         DtSimTaskStatePtr taskState);

typedef struct DtTaskProcessorCallbackInfo
{
   DtMessageCallbackFcn myFunction;
   void* myUserData;
} DtTaskProcessorCallbackInfo;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtTaskControllerComponent : public DtControllerComponent
{

public:

   enum AcceptLevel
   {
      AcceptLevel_Accept = 0,    
      AcceptLevel_Partial = 1,   
      AcceptLevel_Error = 2,     
      AcceptLevel_NoAccept = 99  
   };

   DtTaskControllerComponent(const DtString& name, DtLocalObject* owner, 
      DtSimulationServices* simServices, 
      DtComponentDescriptor* compDesc = nullptr,
      DtReaderWriterRegistry* parentRegistry = nullptr);

   virtual ~DtTaskControllerComponent() override;

   virtual const char* type() const override = 0;

   virtual AcceptLevel acceptTask(const DtTaskMessage& task);

   virtual bool beginProcessingTask(const DtTaskMessage& task, 
      DtSimTaskStatePtr taskState);
   
   virtual void taskNotify(const DtSimTask & task) override {};

   virtual void setTasked(bool tasked);
   virtual bool tasked() const;

   virtual bool showCurrentTaskInGui() const;

   virtual void setRadio(DtSimRadio * radio) override;

   virtual void registerTaskMsgCallbacks();

   virtual void addTaskProcessorCallback(const DtSimTaskMessageType& taskType, DtTaskMessageCallbackFcn fcn, void* usr);

   virtual void addTaskProcessorCallback(const DtSimTaskMessageType& taskType, DtMessageCallbackFcn fcn, void* usr);


   virtual void removeTaskProcessorCallback(const DtSimTaskMessageType& taskType, DtMessageCallbackFcn fcn, void* usr);

   virtual void removeTaskProcessorCallback(const DtSimTaskMessageType& taskType, DtTaskMessageCallbackFcn fcn, void* usr);

   static void deprecatedTaskProcessorCallbackAdapter(DtSimMessage * msg, void * usr,
      DtSimTaskStatePtr taskState);

   virtual bool taskActive(int taskId) const = 0;

   virtual bool clearTopLevelTasks() = 0;

   virtual void clearConflictingTopLevelTasks(const DtSimTaskMessageType& conflictType) = 0;

   virtual void clearTasksByType(const DtSimTaskMessageType& taskType) = 0;

   virtual void clearTaskById(int taskId) = 0;

   virtual DtSuspendedTaskInfo* suspendTaskById(int taskId) = 0;

   virtual DtSuspendedTaskInfo* suspendSubtaskById(int taskId, int subtaskId) = 0;

   virtual std::list<DtTaskMessage*> currentTaskMessages() const = 0;

   virtual DtTaskWithTaskStateListPtr topLevelTasks() const = 0;

   virtual void enable() override;

   virtual void disable() override;

   virtual void sendTaskCanceled(DtTaskMessage* taskMsg);

   virtual bool taskVisualizationsActive() const override;

protected:

   virtual void suspendSubtasksOfTask(int taskId, DtSuspendedTaskInfo* suspendInfo);

   virtual void suspendSubtaskOfTask(int taskId, int subtaskId, DtSuspendedTaskInfo* suspendInfo);

   virtual DtSimTaskMessageType remapScriptId(const DtSimTaskMessageType&) const;

protected:

   typedef std::pair<DtTaskMessageCallbackFcn, void*> DtTaskCallbackMapPair;
   typedef std::map<DtSimTaskMessageType, DtTaskCallbackMapPair> DtTaskCallbackMap;
   DtTaskCallbackMap myTaskCallbackMap;

   std::list<DtTaskProcessorCallbackInfo*> myTaskProcessorCallbackInfoList;

   bool myTaskIsRunning;

private:
   DtTaskControllerComponent();

   DtTaskControllerComponent(const DtTaskControllerComponent & orig);

   const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &
      orig);
};