ifScenarioStatus.h

Go to the documentation of this file.

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


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


const int DtIfScenarioStatusVersion = 1;

class DT_DLL_vrfmsgs DtIfScenarioStatus : public DtSimInterfaceContent
{
public:

   DtIfScenarioStatus();

   virtual ~DtIfScenarioStatus() override;

   DtIfScenarioStatus(const DtIfScenarioStatus& orig);

   DtIfScenarioStatus& operator=(const DtIfScenarioStatus& orig);

   virtual int type() const override;

   virtual DtSimInterfaceContent * clone() const override;


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


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


   virtual const DtFilename& terrainName() const;
   virtual void setTerrainName(const DtFilename& name);


   virtual const DtFilename& guiTerrainName() const;
   virtual void setGuiTerrainName(const DtFilename& name);

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


   virtual void setSimulationModelSets(const std::vector<DtFilename>&);
   virtual const std::vector<DtFilename>& simulationModelSets() const;
   virtual void clearSimulationModelSets();


   virtual void setFrameRateMode(char);
   virtual char frameRateMode() const;

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

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

   virtual void printDataToString(DtString& str) override;

   static DtSimInterfaceContent* creator();

protected:

   DtU32 myVersion;
   bool myIsTimeManaged;
   DtString myScenarioName;
   DtFilename myScenarioFilename;
   DtFilename myTerrainName;
   DtFilename myGuiTerrainName;
   std::vector<DtFilename> mySimulationModelSets;
   DtRwKeyValueList myScenarioData;
   DtU8 myFrameRateMode;
   DtString myGuiRuntimeLoadBalancingScheme;
   DtString myGuiRuntimeLoadBalancingSchemeData;
};