ifStatus.h

Go to the documentation of this file.

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


#pragma once

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

const int DtIfStatusVersion = 10;

#define DtKeyFromKindDomain(kind, domain) ((kind << 8) | (0x00FF & domain))

enum DtScenarioCapabilities
{
   DtScenarioCapabilities_Time = 0,
   DtScenarioCapabilities_CreateObjects = 1,
   DtScenarioCapabilities_SimulateTerrainEnvironmentServer = 2,
   DtScenarioCapabilities_PublishSMS = 3
};

DT_DLL_vrfmsgs bool hasCapability(const DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber);
DT_DLL_vrfmsgs void setCapability(DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber, bool value);

const DtU32 DtScenarioCapabilities_All = 0xffff;

class DT_DLL_vrfmsgs DtIfStatus : public DtSimInterfaceContent
{
public:
   typedef std::map<DtU16, int> ObjectCounts;

   DtIfStatus();

   virtual ~DtIfStatus();

   DtIfStatus(const DtIfStatus& orig);

   DtIfStatus& operator=(const DtIfStatus& orig);

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

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

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

   virtual DtTime simStartSimTime() const;
   virtual void setSimStartSimTime(DtTime time);

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

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

   virtual int controlState() const;
   virtual void setControlState(int state);

   virtual DtInetAddr ipAddress() const;
   virtual void setIpAddress(DtInetAddr ipAddr);

   virtual unsigned int port() const;
   virtual void setPort(unsigned int port);

   virtual int appIdRangeMax() const;
   virtual void setAppIdRangeMax(int);

   virtual bool isFinalStatusMsg() const;
   virtual void setIsFinalStatusMsg(bool finalMsg);

   virtual void addLocalObject(int kind, int domain);
   virtual void removeLocalObject(int kind, int domain);
   virtual int totalLocalObjects() const;
   const ObjectCounts& objectCounts() const
   {
      return myObjectCounts;
   }


   //virtual bool isOldParameterDb() const;
   //virtual void setIsOldParameterDb(bool isOldParameterDb);

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

   virtual bool isCurrentParameterDb() const;
   virtual void setIsCurrentParameterDb(bool isCurrentParameterDb);

   virtual bool isResourceMonitorEnabled() const;
   virtual void setIsResourceMonitorEnabled(bool isCurrentParameterDb);

   virtual bool isLoaded() const;
   virtual void setIsLoaded(const bool loaded);


   virtual unsigned int simEngineId() const;
   virtual void setSimEngineId(unsigned int id);

   virtual void setLoadingScenario(bool);
   virtual bool loadingScenario() const;

   virtual void setSavingScenario(bool);
   virtual bool savingScenario() const;

   virtual void setReinitializingScenario(bool);
   virtual bool reinitializingScenario() const;

   virtual void setImportingScenario(bool);
   virtual bool importingScenario() const;

   virtual void setHostingDynamicTerrainServer(bool);
   virtual bool hostingDynamicTerrainServer() const;

   virtual void setCreatingSimulationObjectGroup(bool);
   virtual bool creatingSimulationObjectGroup() const;

   virtual void setClosingScenario(bool);
   virtual bool closingScenario() const;

   virtual void setRollingBackScenario(bool);
   virtual bool rollingBackScenario() const;

   virtual void setLoadedNewScenario(bool);
   virtual bool loadedNewScenario() 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 bool canSimulate() const;
   virtual void setCanSimulate(const bool frontEnd);

   bool oldStyleStatus() const
   {
      return (myVersion < 10);
   }

   virtual void setIsTimeManaged(bool yesNo);
   virtual bool isTimeManaged() const;


   virtual DtU32 scenarioCapabilities() const;
   virtual void setScenarioCapabilities(DtU32 v);
   virtual void setScenarioCapability(DtU32 v, bool b);


   virtual DtString applicationType() const;
   virtual void setApplicationType(const DtString& type);

   const DtString& scenarioName() const
   {
      return myScenarioName;
   }

   const DtString& terrainName() const
   {
      return myTerrainName;
   }

   const DtString& guiTerrainName() const
   {
      return myGuiTerrainName;
   }

protected:

   DtU32 myVersion;
   DtU32 myPort;
   int myAppIdRangeMax;
   DtU16 myControlState;
   DtInetAddr myInetAddr;
   bool myIsFinalStatusMsg;
   bool myIsCurrentParameterDb;
   bool myResourceMonitorIsEnabled;
   bool myIsLoaded;
   DtTime myExerciseStartTime;
   DtTime mySimTime;
   DtTime mySimStartSimTime;
   double myTimeMultiplier;   
   bool myLoadedNewScenario;
   DtU32 mySimEngineId;
   bool myCanSimulate;
   bool myIsTimeManaged;
   bool myLoadingScenario;
   bool mySavingScenario;
   bool myReinitializingScenario;
   bool myImportingScenario;
   bool myHostingDynamicTerrainServer;
   bool myCreatingSimulationObjectGroup;
   bool myClosingScenario;
   bool myRollingBackScenario;
   DtU32 myScenarioRunId;
   DtU32 myScenarioCapabilities; 
   DtString myApplicationType;

   ObjectCounts myObjectCounts;

   DtTime myRunDurationTime;

   DtString myScenarioName;
   DtString myTerrainName;
   DtString myGuiTerrainName;
};