singleTaskControllerComponent.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/taskControllerComponent.h"
#include "vrfobjcore/pointTaskVisualization.h"
#include "vrfobjcore/lineTaskVisualization.h"
#include "vrfobjcore/areaTaskVisualization.h"
#include "vrfobjcore/textTaskVisualization.h"


class DT_DLL_vrfobjcore DtSingleTaskControllerComponent : public DtTaskControllerComponent
{

public:

   DtSingleTaskControllerComponent(const DtString& name, DtVrfObject* owner, 
      DtSimManager* simManager, 
      DtComponentDescriptor* compDesc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSingleTaskControllerComponent();

   virtual void postTick();

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

   virtual void taskNotify(const DtSimTask & task);


   virtual void taskComplete(bool success = true);

   virtual void clearTask();

   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 DtTaskMessage* pendingSubtask(int subtaskId, DtString& controller) const;

   virtual void clearCurrentTaskMessage();

   virtual DtTaskMessage * currentTaskMessage() const;

   virtual DtSimTaskStatePtr currentTaskState() 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 std::list<DtTaskMessage*> currentTaskMessages() const;

   virtual DtTaskWithTaskStateListPtr topLevelTasks() const;

   virtual DtPointTaskVisualizationPtr pointTaskVisualization(const DtString& name);

   virtual DtLineTaskVisualizationPtr lineTaskVisualization(const DtString& name);

   virtual DtAreaTaskVisualizationPtr areaTaskVisualization(const DtString& name);

   virtual DtTextTaskVisualizationPtr textTaskVisualization(const DtString& name);

   virtual void destroyTaskVisualization(const DtString& name);

protected:
      virtual void clearPendingSubtasks();

      virtual void clearSubtasksByType(const DtSimTaskMessageType& taskType);
};