ifLoadScenario.h

Go to the documentation of this file.

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


#pragma once

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

class DT_DLL_vrfmsgs DtIfLoadScenario : public DtSimInterfaceContent
{
public:

   DtIfLoadScenario();

   virtual ~DtIfLoadScenario();

   DtIfLoadScenario(const DtIfLoadScenario& orig);

   DtIfLoadScenario& operator=(const DtIfLoadScenario& orig);

   virtual DtSimInterfaceContent * clone() const;

   virtual int type() const;
  
   virtual const DtFilename& componentAttachmentTableFileName() const;
   virtual void setComponentAttachmentTableFileName(const DtString & fileName);
   virtual const DtFilename& terrainFileName() const;
   virtual void setTerrainFileName(const DtString & fileName);

   virtual const DtFilename& guiTerrainFileName() const;
   virtual void setGuiTerrainFileName(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 const DtFilename& planFileName() const;
   virtual void setPlanFileName(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 setImportScenario(bool);
   virtual bool importScenario() const;

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

   virtual void setExerciseStartTime(DtTime time);
   virtual DtTime exerciseStartTime() 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 void setRunDurationTime(double);
   virtual double runDurationTime() const;

   virtual unsigned long requestId() const;
   virtual void setRequestId(unsigned long requestId);

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

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

   virtual const DtFilename& globalPlanFileName() const;
   virtual void setGlobalPlanFileName(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 const DtString& scenarioName() const;
   virtual void setScenarioName(const DtString& name);

   virtual void setScenarioFilename(const DtFilename&);
   virtual const DtFilename& scenarioFilename() const;

   virtual const DtRwKeyValueList& scenarioData() const;
   virtual DtRwKeyValueList& scenarioData();
   virtual void setScenarioData(const DtRwKeyValueList& data);

   virtual void setOrbatEnabled(bool b);
   virtual bool orbatEnabled() const;

   virtual void setCreateGlobalEnvironment(bool b);
   virtual bool createGlobalEnvironment() const;

   virtual void setCreateGlobalDynamicTerrain(bool b);
   virtual bool createGlobalDynamicTerrain() const;

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

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   virtual void setScenarioRunId(int);
   virtual int scenarioRunId() const;

protected:
   DtU32 myRequestId;
   DtU32 myFrameMode;
   DtFloat64 myFrameTime;
   DtU32 myRandomNumberSeed;
   bool myImportScenario;
   DtFilename myComponentAttachmentTableName;
   DtFilename myTerrainFileName;
   DtFilename myGuiTerrainFilename;
   DtFilename myObjParamsFileName;
   DtFilename myPlanFileName;
   DtFilename myOrderOfBattleFileName;
   DtFilename myScenarioScriptsFilename;
   DtFilename myOrbatFilename;
   DtFilename myScenarioFilename;
   bool myAutoReorganize;
   DtFloat64 myTimeMultiplier;
   DtFloat64 mySimTime;
   DtFloat64 myExerciseStartTime;
   std::list<DtString> myAdditionalOpdFileNames;
   std::list<DtString> mySimulationModelSetFileNames;
   DtFilename myGlobalPlanFileName;
   DtFilename myPhysicalWorldFileName;
   DtFilename myForceHostilityFileName;
   DtFilename myScenarioExtrasFileName;
   DtString myScenarioName;
   DtRwKeyValueList myScenarioData;
   DtString myGuiRuntimeLoadBalancingScheme;
   DtString myGuiRuntimeLoadBalancingSchemeData;
   DtString mySimRemoteAttachmentBalancingScheme;
   DtString mySimRemoteAttachmentBalancingSchemeData;
   double myRunDurationTime;
   DtU32 myScenarioRunId;
   bool myOrbatEnabled;
   bool myCreateGlobalEnvironment;
   bool myCreateGlobalDynamicTerrain;
};