scriptMultiTaskControllerPSR.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/rwUserQuestionHandler.h"
#include "vrfobjcore/vrfProcessStateRepository.h"
#include "vrfutil/rwVariableBindings.h"
#include "vrfutil/rwStringList.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwScriptInformation.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwUserQuestion.h"
#include "vrftasks/scriptedTaskTask.h"

class DT_DLL_vrfobjcore DtScriptMultiTaskControllerPSR : public DtVrfProcessStateRepository
{
protected:
   typedef void (*DtScriptPSRScenarioSaveFcn)(void*);

public:
   DtScriptMultiTaskControllerPSR(DtVrfObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtScriptMultiTaskControllerPSR(const DtScriptMultiTaskControllerPSR& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   const DtScriptMultiTaskControllerPSR& operator=( 
      const DtScriptMultiTaskControllerPSR& orig);

   virtual ~DtScriptMultiTaskControllerPSR();

   virtual DtScriptMultiTaskControllerPSR* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual void putSelf(std::string&, int, bool, const DtFilename&);
   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
                                      const DtVariableBindingsList& variableBindings);

   virtual DtString type() const;

   virtual void addEntry(int tid, DtReaderWriter* entry, bool overwrite = true);

   virtual void removeEntry(int tid);

   virtual const DtReaderWriter* findEntry(int tid);

   virtual void clearEntries();

   virtual void setCallback(DtScriptPSRScenarioSaveFcn callback, void* usr);

   virtual void removeScriptInformation(const DtString&);

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

   virtual double scriptTickPeriod(const DtString& scriptId) const;

   virtual void setScriptTickWhilePaused(const DtString& scriptId, bool enable);

   virtual bool scriptTickWhilePaused(const DtString& scriptId) const;

   virtual bool timeToExecuteScript(const DtString&, double curSimTime, double curRealTime, bool isPaused);

   virtual double nextTimeToExecuteScript(const DtString&, double curTime) const;

   virtual void setNextTimeToExecuteScript(const DtString& scriptId, double time);

   virtual void setNextTimeToExecuteScriptWhilePaused(const DtString& scriptId, double time);

   virtual void setScriptBackgroundProcessId(const DtString& scriptId, int id);

   virtual int scriptBackgroundProcessId(const DtString& scriptId) const;

   static DtVrfProcessStateRepository* creator (const DtString& rwName,
      DtVrfObject* vrfObject, DtReaderWriterRegistry* parentRegistry);

   virtual DtRwUserQuestionHandler& userQuestionHandler();
   virtual const DtRwUserQuestionHandler& userQuestionHandler() const;

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

protected:
   DtRwVariableBindings myEntries;
   typedef DtRwTemplatedListPtr<DtRwScriptInformation, false> ScriptInformation;
   ScriptInformation myScriptInformation;

   typedef std::map<DtString, DtRwScriptInformation> MapScriptInformation;
   MapScriptInformation myMapScriptInformation;

   DtScriptPSRScenarioSaveFcn mySaveCallback;
   void* myCallbackObject;

   DtRwUserQuestionHandler myUserQuestionHandler;
};