ifSaveComplete.h

Go to the documentation of this file.

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


#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlpi/netStructs.h>
#include <vlutil/vlFilename.h>
#include <list>
#include "vrfutil/rwKeyValueList.h"

enum DtSaveResult {DtSuccess, DtFailure} ;

class DT_DLL_vrfmsgs DtIfSaveComplete : public DtSimInterfaceContent
{
public:

   DtIfSaveComplete();

   virtual ~DtIfSaveComplete();

   DtIfSaveComplete(const DtIfSaveComplete& orig);

   DtIfSaveComplete& operator=(const DtIfSaveComplete& orig);

   virtual int type() const;

   virtual void setRequestId(unsigned int id);
   virtual unsigned int requestId() const;

   virtual void setResult(DtSaveResult result);
   virtual DtSaveResult result() const;

   virtual const DtFilename& terrainFileName() const;
   virtual void setTerrainFileName(const DtString & fileName);

   virtual const DtFilename& guiTerrainName() const;
   virtual void setGuiTerrainName(const DtString& filename);

   virtual const DtFilename& componentAttachmentTableFileName() const;
   virtual void setComponentAttachmentTableFileName(const DtString & fileName);
   virtual const bool& autoReorganize() const;
   virtual void setAutoReorganize(bool yesNo);

   virtual double timeMultiplier() const;
   virtual void setTimeMultiplier(double timeMultiplier);

   virtual const DtFilename& objectParametersFileName() const;
   virtual void setObjectParametersFileName(const DtString & fileName);

   virtual const DtFilename& physicalWorldFileName() const;
   virtual void setPhysicalWorldFileName(const DtString & fileName);

   virtual const DtFilename& orderOfBattleFileName() const;
   virtual void setOrderOfBattleFileName(const DtString & fileName);

   virtual const DtFilename& scenarioScriptsFileName() const;
   virtual void setScenarioScriptsFileName(const DtString & fileName);

   virtual const DtFilename& orbatFileName() const;
   virtual void setOrbatFileName(const DtString & fileName);

   virtual void setRunDurationTime(double);
   virtual double runDurationTime() const;

   virtual const DtFilename& planFileName() const;
   virtual void setPlanFileName(const DtString & fileName);

   virtual const DtFilename& forceHostilityFileName() const;
   virtual void setForceHostilityFileName(const DtString& fileName);

   virtual const DtFilename& scenarioExtrasFileName() const;
   virtual void setScenarioExtrasFileName(const DtString& fileName);

   virtual unsigned int randomNumberSeed() const;
   virtual void setRandomNumberSeed(unsigned int numberSeed);

   virtual int frameMode() const;
   virtual void setFrameMode(int frameMode);

   virtual double frameTime() const;
   virtual void setFrameTime(double frameTime);

   virtual void setSimTime(DtTime time);
   virtual DtTime simTime() const;

   virtual void setExerciseStartTime(DtTime time);
   virtual DtTime exerciseStartTime() const;

   virtual std::list<DtString>& additionalOpdFileNames();
   virtual const std::list<DtString>& additionalOpdFileNames() const;

   virtual void setGuiRuntimeLoadBalancingScheme(const DtString& scheme, const DtString& userData);
   virtual void getGuiRuntimeLoadBalancingScheme(DtString& scheme, DtString& userData) const;

   virtual void setSimRemoteAttachmentBalancingScheme(const DtString& scheme, const DtString& userData);
   virtual void getSimRemoteAttachmentBalancingScheme(DtString& scheme, DtString& userData) const;

   virtual std::list<DtString>& simulationModelSetFileNames();
   virtual const std::list<DtString>& simulationModelSetFileNames() const;

   virtual DtString scenarioName() const;
   virtual void setScenarioName(const DtString& name);

   virtual DtRwKeyValueList& scenarioData();
   virtual const DtRwKeyValueList& scenarioData() const;

   virtual void setIsCheckpoint(bool);
   virtual bool isCheckpoint() const;

   virtual void setSnapshotRequestSimTimeSave(double);
   virtual double snapshotRequestSimTimeSave() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual int netRepSize() const;
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);
   virtual bool setToNet();
   virtual char* setToNet(char*);

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:
   DtU32 myRequestId;
   DtSaveResult myResult;
   DtU32 myFrameMode;
   DtFloat64 myFrameTime;
   DtU32 myRandomNumberSeed;
   DtFilename myTerrainFileName;
   DtFilename myComponentAttachmentTableName;
   DtFilename myObjParamsFileName;
   DtFilename myPhysicalWorldFileName;
   DtFilename myPlanFileName;
   DtFilename myOrderOfBattleFileName;
   DtFilename myScenarioScriptsFilename;
   DtFilename myOrbatFilename;
   DtFilename myForceHostilityFileName;
   DtFilename myScenarioExtrasFileName;
   bool myAutoReorganize;
   DtFloat64 myTimeMultiplier;
   DtReal mySimTime;
   DtReal myExerciseStartTime;
   std::list<DtString> myAdditionalOpdFileNames;
   std::list<DtString> mySimulationModelSetFileNames;
   DtString myScenarioName;
   DtRwKeyValueList myScenarioData;
   DtFilename myGuiTerrainName;
   double myRunDurationTime;
   DtString myGuiRuntimeLoadBalancingScheme;
   DtString myGuiRuntimeLoadBalancingSchemeData;
   DtString mySimRemoteAttachmentBalancingScheme;
   DtString mySimRemoteAttachmentBalancingSchemeData;

   bool myIsCheckpoint;
   DtReal mySnapshotRequestSimTimeSave;
};