multiTaskControllerComponent.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/taskControllerComponent.h"
#include "vrftasks/radioMessageTypes.h"

class DtSubtaskStatusEntry;

class DT_DLL_vrfobjcore DtMultiTaskControllerComponent : public DtTaskControllerComponent
{

public:

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

   virtual ~DtMultiTaskControllerComponent();

   virtual bool init();

   virtual void postTick();

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

   virtual void taskComplete(int taskId, bool success);

   virtual void clearTask(int taskId);

   virtual void suspendTask(int taskId);

   virtual DtTaskMessage* currentTaskMessage(int taskId);

   virtual DtSimTaskStatePtr currentTaskState(int taskId) const;

   virtual int sendSubtask(DtSimTask& task, int taskId);

   virtual int sendTask(DtSimTask& task, const DtUUID& receiver, int taskId,
      bool actAsSubtask = true, bool useRadio = false);

   virtual void clearSubtask(int subtaskId, int taskId);

   virtual void addPendingSubtaskId(int subtaskId, int taskId);

   virtual bool findPendingSubtaskId(int subtaskId, int taskId);

   virtual bool isSubtasked() const;

   virtual void removePendingSubtaskId(int subtaskId, int taskId);

   virtual DtSubtaskStatusEntry* subtaskStatus(int subtaskId, int taskId);
      
   virtual void removeAllPendingSubtaskIds(int taskId);

   virtual std::vector<int> currentPendingSubstaskIds(int taskId) const;

   virtual bool decideToGiveUpTask() const;

   virtual void giveUpTask();

   virtual bool taskActive(int taskId) const;

   virtual bool clearTopLevelTasks();

   virtual void clearConflictingTopLevelTasks(const DtSimTaskMessageType& conflictType);

   virtual void clearTasksByType(const DtSimTaskMessageType& taskType);

   virtual void clearTaskById(int taskId);

   virtual DtSuspendedTaskInfo* suspendTaskById(int taskId);

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

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

   virtual DtTaskWithTaskStateListPtr topLevelTasks() const;

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

   virtual makVrf::DtPointTaskVisualizationPtr pointTaskVisualization(int taskId, const DtString& name);

   virtual makVrf::DtLineTaskVisualizationPtr lineTaskVisualization(int taskId, const DtString& name);

   virtual makVrf::DtAreaTaskVisualizationPtr areaTaskVisualization(int taskId, const DtString& name);

   virtual makVrf::DtTextTaskVisualizationPtr textTaskVisualization(int taskId, const DtString& name);

   virtual void destroyTaskVisualization(int taskId, const DtString& name);

   virtual void destroyTaskVisualizations(int taskId);

protected:
   virtual void addCurrentTaskMessage(const DtTaskMessage* taskMessage);
   virtual void clearCurrentTaskMessage(int taskId);

   virtual void clearPendingSubtasks(int taskId);

   virtual void clearSubtasksByType(const DtSimTaskMessageType& taskType, int taskId);

   virtual int taskIdWhichStartedSubtask(int subtaskId);

   virtual void cleanupInactiveSubtaskStatus(int taskId);
};