scriptTaskControllerInterface.h

Go to the documentation of this file.

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

#include "vrftasks/simTask.h"
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/taskStatusEntry.h"
#include "vrfobjcore/pointTaskVisualization.h"
#include "vrfobjcore/lineTaskVisualization.h"
#include "vrfobjcore/areaTaskVisualization.h"
#include "vrfobjcore/textTaskVisualization.h"


class DtTranslatableStream;

class DT_DLL_vrfobjcore DtScriptTaskControllerInterface
{
public:
   virtual ~DtScriptTaskControllerInterface();

   virtual void scriptSetTickPeriod(const DtString& scriptId, double period) = 0;

   virtual void setCheckpointModeUseCheckpointState(const DtString& scriptId, bool) = 0;
   virtual bool checkpointModeUseCheckpointState(const DtString& scriptId) const = 0;

   virtual void scriptSetTickWhilePaused(const DtString& scriptId, bool enable) = 0;

   virtual void scriptSetRespondToNewSensorContacts(const DtString& scriptId, bool tick) = 0;
   virtual void scriptTaskComplete(int taskId, bool success) = 0;
   virtual int scriptSendSubtask(DtSimTask& task, int parentTaskId) = 0;
   virtual std::vector<int> scriptPendingSubstaskIds(int taskId) = 0;
   virtual DtSubtaskStatusEntry* scriptSubtaskStatus(int subtaskId, int parentTaskId) = 0;
   virtual void scriptClearSubtask(int subtaskId, int parentTaskId) = 0;
   virtual int scriptSendTask(DtSimTask& task, const DtString& entityName, int parentTaskId, bool actAsSubtask = true) = 0;

   virtual void notifyScriptTaskError(const DtString& scriptId, int taskId) = 0;

   virtual int askUserQuestion(const DtString& scriptId, const DtTranslatableStream& title, const DtTranslatableStream& message,
      const std::vector<DtTranslatableStream>& options, int displayFlag) = 0;
   virtual int statusOfUserQuestion(int questionId) = 0;
   virtual void cancelUserQuestion(int questionId) = 0;

   virtual DtPointTaskVisualizationPtr pointTaskVisualization(int taskId, const DtString& visName) = 0;
   virtual DtLineTaskVisualizationPtr lineTaskVisualization(int taskId, const DtString& visName) = 0;
   virtual DtAreaTaskVisualizationPtr areaTaskVisualization(int taskId, const DtString& visName) = 0;
   virtual DtTextTaskVisualizationPtr textTaskVisualization(int taskId, const DtString& visName) = 0;
   virtual void deleteTaskVisualization(int taskId, const DtString& visName) = 0;

protected:
   DtScriptTaskControllerInterface();
   DtScriptTaskControllerInterface(const DtScriptTaskControllerInterface& other);
   DtScriptTaskControllerInterface& operator=(const DtScriptTaskControllerInterface& other);
};