singleTaskControllerComponent.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/taskControllerComponent.h"

class DtSubtaskStatusEntry;
class DtRwPropertiesStructure;

class DT_DLL_vrfobjcore DtSingleTaskControllerComponent : public DtTaskControllerComponent
{

public:

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

   virtual ~DtSingleTaskControllerComponent() override;

   virtual void postTick() override;

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

   virtual void taskNotify(const DtSimTask & task) override;


   virtual void taskComplete(bool success = true);

   virtual void clearTask() override;

   virtual void suspendTask();

   virtual int sendSubtask(DtSimTask& task);

   virtual void clearSubtask(int subtaskId);

   virtual void addPendingSubtaskId(int subtaskId);

   virtual bool findPendingSubtaskId(int subtaskId);

   virtual bool isSubtasked() const;

   virtual void removePendingSubtaskId(int subtaskId);

   virtual void removeAllPendingSubtaskIds();

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

   virtual DtSubtaskStatusEntry* subtaskStatus(int subtaskId);

   //virtual DtTaskMessage* pendingSubtask(int subtaskId, DtString& controller) const;

   virtual void clearCurrentTaskMessage();

   virtual DtTaskMessage * currentTaskMessage() const;

   virtual DtSimTaskStatePtr currentTaskState() const;



   const DtString TaskStatusRunning = "TaskRunning";
   const DtString TaskStatusNotActive = "TaskNotActive";
  
   virtual void initializeTaskInformationStateProperty(const DtSimTaskMessageType& taskType);

   virtual void updateCurrentTaskInformationStatusProperty(const DtString& status);

   virtual DtString taskInformationStatusPropertyValue(const DtSimTaskMessageType& taskType) const;

   virtual DtString currentTaskInformationStatusPropertyValue() const;

   virtual DtRwPropertiesStructure* taskInformationProperty(const DtSimTaskMessageType& taskType);

   virtual DtRwPropertiesStructure* currentTaskInformationProperty();

   virtual bool decideToGiveUpTask() const;

   virtual void giveUpTask();

   virtual bool taskActive(int taskId) const override;

   virtual bool clearTopLevelTasks() override;

   virtual void clearConflictingTopLevelTasks(const DtSimTaskMessageType& conflictType) override;

   virtual void clearTasksByType(const DtSimTaskMessageType& taskType) override;

   virtual void clearTaskById(int taskId) override;

   virtual DtSuspendedTaskInfo* suspendTaskById(int taskId) override;

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

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

   virtual DtTaskWithTaskStateListPtr topLevelTasks() const override;

   virtual void disable() override;

   virtual void updateImgui() override;

protected:
      virtual void clearPendingSubtasks();

      virtual void clearSubtasksByType(const DtSimTaskMessageType& taskType);

      virtual void cleanupInactiveSubtaskStatus();
};