VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ifStatus.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include <vrfExtProtocol/simInterfaceContent.h>
12 #include <vlpi/netStructs.h>
13 #include <vlutil/vlUtil.h>
14 #include <vlutil/vlInetAddr.h>
15 #include "vrfmsgs/vrfmsgsDefines.h"
16 #include <vrfutil/backend.h>
17 
18 const int DtIfStatusVersion = 10;
19 
27 #define DtKeyFromKindDomain(kind, domain) ((kind << 8) | (0x00FF & domain))
28 
34 enum DtScenarioCapabilities
35 {
37  DtScenarioCapabilities_Time = 0,
39  DtScenarioCapabilities_CreateObjects = 1,
41  DtScenarioCapabilities_SimulateTerrainEnvironmentServer = 2,
43  DtScenarioCapabilities_PublishSMS = 3
44 };
45 
46 DT_DLL_vrfmsgs bool hasCapability(const DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber);
47 DT_DLL_vrfmsgs void setCapability(DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber, bool value);
48 
49 const DtU32 DtScenarioCapabilities_All = 0xffff;
50 
51 class DT_DLL_vrfmsgs DtIfStatus : public DtSimInterfaceContent
52 {
53 public:
54  typedef std::map<DtU16, int> ObjectCounts;
55 
57  DtIfStatus();
58 
60  virtual ~DtIfStatus();
61 
63  DtIfStatus(const DtIfStatus& orig);
64 
66  DtIfStatus& operator=(const DtIfStatus& orig);
67 
69  virtual int type() const;
70 
71  virtual DtSimInterfaceContent * clone() const;
72 
74  virtual DtTime exerciseStartTime() const;
75  virtual void setExerciseStartTime(DtTime time);
76 
79  virtual DtTime simTime() const;
80  virtual void setSimTime(DtTime time);
81 
83  virtual DtTime simStartSimTime() const;
84  virtual void setSimStartSimTime(DtTime time);
85 
88  virtual void setRunDurationTime(double);
89  virtual double runDurationTime() const;
90 
93  virtual double timeMultiplier() const;
94  virtual void setTimeMultiplier(double timeMultiplier);
95 
98  virtual int controlState() const;
99  virtual void setControlState(int state);
100 
101  virtual DtInetAddr ipAddress() const;
102  virtual void setIpAddress(DtInetAddr ipAddr);
103 
104  virtual unsigned int port() const;
105  virtual void setPort(unsigned int port);
106 
107  virtual bool isFinalStatusMsg() const;
108  virtual void setIsFinalStatusMsg(bool finalMsg);
109 
113  virtual void addLocalObject(int kind, int domain);
114  virtual void removeLocalObject(int kind, int domain);
115  virtual int totalLocalObjects() const;
116  const ObjectCounts& objectCounts() const
117  {
118  return myObjectCounts;
119  }
120 
122 
123  //virtual bool isOldParameterDb() const;
124  //virtual void setIsOldParameterDb(bool isOldParameterDb);
125 
127  virtual int scenarioRunId() const;
128  virtual void setScenarioRunId(int);
129 
130  virtual bool isCurrentParameterDb() const;
131  virtual void setIsCurrentParameterDb(bool isCurrentParameterDb);
132 
133  virtual bool isResourceMonitorEnabled() const;
134  virtual void setIsResourceMonitorEnabled(bool isCurrentParameterDb);
135 
139  virtual bool isLoaded() const;
140  virtual void setIsLoaded(const bool loaded);
141 
144 
145  virtual unsigned int simEngineId() const;
146  virtual void setSimEngineId(unsigned int id);
148 
151  virtual void setLoadingScenario(bool);
152  virtual bool loadingScenario() const;
154 
157  virtual void setReinitializingScenario(bool);
158  virtual bool reinitializingScenario() const;
160 
163  virtual void setImportingScenario(bool);
164  virtual bool importingScenario() const;
166 
169  virtual void setHostingDynamicTerrainServer(bool);
170  virtual bool hostingDynamicTerrainServer() const;
172 
175  virtual void setCreatingSimulationObjectGroup(bool);
176  virtual bool creatingSimulationObjectGroup() const;
178 
181  virtual void setClosingScenario(bool);
182  virtual bool closingScenario() const;
184 
187  virtual void setRollingBackScenario(bool);
188  virtual bool rollingBackScenario() const;
190 
193  virtual void setLoadedNewScenario(bool);
194  virtual bool loadedNewScenario() const;
196 
197  virtual int netRepSize() const;
198  virtual bool setFromNet(const char* contentBuffer,
199  unsigned contentSize);
200  virtual bool setToNet();
201 
202  virtual void printDataToString(DtString& str);
203 
204  static DtSimInterfaceContent* creator();
205 
208  virtual bool canSimulate() const;
209  virtual void setCanSimulate(const bool frontEnd);
210 
211  bool oldStyleStatus() const
212  {
213  return (myVersion < 10);
214  }
215 
216  virtual void setIsTimeManaged(bool yesNo);
217  virtual bool isTimeManaged() const;
218 
221 
222  virtual DtU32 scenarioCapabilities() const;
223  virtual void setScenarioCapabilities(DtU32 v);
224  virtual void setScenarioCapability(DtU32 v, bool b);
226 
229 
230  virtual DtString applicationType() const;
231  virtual void setApplicationType(const DtString& type);
233 
236  const DtString& scenarioName() const
237  {
238  return myScenarioName;
239  }
240 
241  const DtString& terrainName() const
242  {
243  return myTerrainName;
244  }
245 
246  const DtString& guiTerrainName() const
247  {
248  return myGuiTerrainName;
249  }
251 
252 protected:
253 
257  DtU32 myVersion;
258  DtU32 myPort;
259  DtU16 myControlState;
260  DtInetAddr myInetAddr;
261  bool myIsFinalStatusMsg;
262  bool myIsCurrentParameterDb;
263  bool myResourceMonitorIsEnabled;
264  bool myIsLoaded;
265  DtTime myExerciseStartTime;
266  DtTime mySimTime;
267  DtTime mySimStartSimTime;
268  double myTimeMultiplier;
269  bool myLoadedNewScenario;
270  DtU32 mySimEngineId;
271  bool myCanSimulate;
272  bool myIsTimeManaged;
273  bool myLoadingScenario;
274  bool myReinitializingScenario;
275  bool myImportingScenario;
276  bool myHostingDynamicTerrainServer;
277  bool myCreatingSimulationObjectGroup;
278  bool myClosingScenario;
279  bool myRollingBackScenario;
280  DtU32 myScenarioRunId;
282  DtU32 myScenarioCapabilities;
284  DtString myApplicationType;
285 
288  ObjectCounts myObjectCounts;
289 
290  DtTime myRunDurationTime;
291 
293  DtString myScenarioName;
294  DtString myTerrainName;
295  DtString myGuiTerrainName;
296 };
Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)