remoteBatchManager.h

Go to the documentation of this file.

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

#pragma once

#include "vrfMsgTransport/vrfMsgTransportDefines.h"
#include <vrfutil/backendMap.h>
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlList.h>
#include <boost/signals2.hpp>

class DtScenarioBatchIterator;
class DtCommunicationManager;
class DtClock;
class DtScenario;
class DtScenarioBatch;

typedef void (*DtScenarioCallbackFcn)(void *usr);

class DT_DLL_vrfMsgTransport DtRemoteBatchManager
{
   enum State
   {
      StateIdle,
      StateRunStart,
      StateLoading,
      StateRunning,
      StateRunComplete,
      StateRunBatchComplete,
      StateErrorLoading,
      StateClosing,
   };

public:
   DtRemoteBatchManager(DtCommunicationManager *controller);
   virtual ~DtRemoteBatchManager();

   virtual bool init();

   virtual bool loadBatch(const DtFilename &batchFileName, 
      DtBackendRemappingFcn fcn = NULL, void* userData = NULL);
   virtual bool loadBatch(const DtScenarioBatch &batch, 
      DtBackendRemappingFcn fcn = NULL, void* userData = NULL);

   virtual bool runBatch();

   virtual bool stopBatch();

   virtual bool running();

   virtual bool done();

   virtual const DtScenarioBatchIterator* batchIterator();

   virtual void processBackendsLoadedCallback();

   virtual void addScenarioLoadingCallback(DtScenarioCallbackFcn fcn, void* usr);
   virtual void removeScenarioLoadingCallback(DtScenarioCallbackFcn fcn, void* usr);

   virtual void addScenarioLoadingErrorCallback(DtScenarioCallbackFcn fcn, void* usr);
   virtual void removeScenarioLoadingErrorCallback(DtScenarioCallbackFcn fcn, void* usr);

   virtual void addScenarioBatchCompleteCallback(DtScenarioCallbackFcn fcn, void* usr);
   virtual void removeScenarioBatchCompleteCallback(DtScenarioCallbackFcn fcn, void* usr);

   virtual void addScenarioClosingCallback(DtScenarioCallbackFcn fcn, void* usr);
   virtual void removeScenarioClosingCallback(DtScenarioCallbackFcn fcn, void* usr);

   virtual void processScenarioCallbacksForState(const State &state);

   virtual void removeCallbacksFor(DtScenarioCallbackFcn fcn, void* usrData, const State state);

   virtual void nextScenarioRun();

   virtual void nextScenario();

   virtual void idle();

   virtual void scheduleNextRun();

   virtual void tick();

protected:
   DtRemoteBatchManager();
   DtRemoteBatchManager(const DtRemoteBatchManager &orig);
   DtRemoteBatchManager& operator=(const DtRemoteBatchManager &orig);

   virtual double currentSimulationTime() const;

   virtual void startedLoading(const DtScenario&);
   virtual void backendsLoaded();
   virtual void scenarioRunComplete();

protected:
   DtScenarioBatchIterator *myBatchIterator;
   DtCommunicationManager *myCommunicationManager;
   
   State myState;
   bool myRunning;
   bool myDone;
   DtTime myRunStartTime;
   bool myBackendsLoaded;

   DtList myCallbacks;
   
   DtBackendRemappingFcn myRemappingFcn;
   void* myRemappingFcnUserData;
   boost::signals2::connection myPostAdvanceFrameConnection;
};