cgfDispatcher.h

Go to the documentation of this file.

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

#pragma once



#include <vrfmsgs/messageTypes.h>
#include "vrfMsgTransport/vrfMessageInterface.h"
#include "vrfmsgs/ifLoadScenario.h"
#include "vrfmsgs/ifSaveScenario.h"
#include "vrfmsgs/ifCloseScenario.h"
#include "vrfmsgs/ifControl.h"
#include "vrfmsgs/ifSaveSimulationObjectGroup.h"
#include "vrfmsgs/ifCreateSimulationObjectGroup.h"
#include "vrfcgf/cgf.h"
#include <vlutil/vlFilename.h>
#include "vrfutil/compressedFileTransporter.h"
#include <vl/startResumeInteraction.h>
#include <vl/stopFreezeInteraction.h>

class DtIfControlMsg;
class DtTimer;
class DtIfImportScenarioDescriptionFile;
class DtIfExportScenarioDescriptionFile;
class DtEvent;

#include "vrfcgf/vrfcgfDefines.h"
class DT_DLL_vrfcgf DtCgfDispatcher
{
public:
   DtCgfDispatcher(DtCgf* cgf,
      DtVrfMessageInterface* messageIf,
      int receivePort = 8000);

   virtual ~DtCgfDispatcher();

   virtual void closeScenario(DtIfCloseScenario* msg);
   virtual void loadScenario(DtIfLoadScenario* msg);
   virtual void reinitializeScenario();

   virtual void saveScenario(DtIfSaveScenario* msg, 
      const DtSimulationAddress& requester);

   virtual void saveSimulationObjectGroup(DtIfSaveSimulationObjectGroup* msg, 
      const DtSimulationAddress& requester);

   virtual void createSimulationObjectGroup(DtIfCreateSimulationObjectGroup* msg, 
      const DtSimulationAddress& requester);

   virtual void importScenarioDescriptionFile(DtIfImportScenarioDescriptionFile*);

   virtual void exportScenarioDescriptionFile(DtIfExportScenarioDescriptionFile*);

   virtual void controlScenario(DtIfControl* msgData, 
      const DtSimulationAddress& sender);

   virtual void setEnableResourceMonitor(bool b);

   virtual void tick();

   virtual void setTimeToQuit(bool yesNo);
   virtual bool timeToQuit() const;

   virtual void clearSimulationObjects();

   virtual DtVrfMessageInterface* messageInterface() const;

   virtual DtCgf* cgf() const;

   virtual int port() const;

   virtual const DtFilename& tempDirectory();
   virtual void setTempDirectory(const DtFilename& f);

   virtual void cleanupSockets();

   virtual unsigned int simMgmtPduProcessLevel() const;
   virtual void setSimMgmtPduProcessLevel(unsigned int level);

   virtual void processCapableTaskAndSetQuery(DtSimMessage* msg);
   virtual void processDIGuyAppearAndAnimationsQuery(DtSimMessage* msg);

public:

   typedef struct dtSimRunDurationUsrData
   {
      DtCgfDispatcher * cgfDispatcher;
      DtSimulationAddress replyTo;
   } DtSimRunDurationUsrData;
   
   static void processMessageCb(DtSimMessage* msg, void* usr);

   virtual void startResumeSimCb(const DtEvent&);

   virtual void stopFreezeSimCb(const DtEvent&);

   static void receiveFileCb(const DtFilename& f, void* usr);

   static void runDurationCompleteCallback(void* timer);
   virtual void processRunDurationComplete(DtSimRunDurationUsrData*);

protected:
   virtual bool shouldTryReload(const DtScenario& scenario);

   virtual bool shouldTryReload(const DtIfImportScenarioDescriptionFile*);

   virtual void pause();

   virtual void run();

   virtual void rewind(int scenarioRunId = 0);

   virtual void step(const DtSimulationAddress& sender);

   virtual void runForDuration(double duration, const DtSimulationAddress& sender);

protected:

   int myPort;
   bool myTimeToQuit;
   DtCgf* myCgf;
   DtVrfMessageInterface* myMessageIf;
   DtFilename myDir;
   DtCompressedFileTransporter myTransporter;

   DtIfLoadScenario* myPendingLoadScenario;
   unsigned int mySimMgmtPduProcessLevel;

   DtIfImportScenarioDescriptionFile* myPendingScenarioDescriptionImport;
};