VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator 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
42 };
43 
44 DT_DLL_vrfmsgs bool hasCapability(const DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber);
45 DT_DLL_vrfmsgs void setCapability(DtU32& capabilitiesBitfield, DtScenarioCapabilities bitNumber, bool value);
46 
47 const DtU32 DtScenarioCapabilities_All = 0xffff;
48 
49 class DT_DLL_vrfmsgs DtIfStatus : public DtSimInterfaceContent
50 {
51 public:
52  typedef std::map<DtU16, int> ObjectCounts;
53 
55  DtIfStatus();
56 
58  virtual ~DtIfStatus();
59 
61  DtIfStatus(const DtIfStatus& orig);
62 
64  DtIfStatus& operator=(const DtIfStatus& orig);
65 
67  virtual int type() const;
68 
69  virtual DtSimInterfaceContent * clone() const;
70 
72  virtual DtTime exerciseStartTime() const;
73  virtual void setExerciseStartTime(DtTime time);
74 
77  virtual DtTime simTime() const;
78  virtual void setSimTime(DtTime time);
79 
81  virtual DtTime simStartSimTime() const;
82  virtual void setSimStartSimTime(DtTime time);
83 
86  virtual void setRunDurationTime(double);
87  virtual double runDurationTime() const;
88 
91  virtual double timeMultiplier() const;
92  virtual void setTimeMultiplier(double timeMultiplier);
93 
96  virtual int controlState() const;
97  virtual void setControlState(int state);
98 
99  virtual DtInetAddr ipAddress() const;
100  virtual void setIpAddress(DtInetAddr ipAddr);
101 
102  virtual unsigned int port() const;
103  virtual void setPort(unsigned int port);
104 
105  virtual bool isFinalStatusMsg() const;
106  virtual void setIsFinalStatusMsg(bool finalMsg);
107 
111  virtual void addLocalObject(int kind, int domain);
112  virtual void removeLocalObject(int kind, int domain);
113  virtual int totalLocalObjects() const;
114  const ObjectCounts& objectCounts() const
115  {
116  return myObjectCounts;
117  }
118 
120 
121  //virtual bool isOldParameterDb() const;
122  //virtual void setIsOldParameterDb(bool isOldParameterDb);
123 
125  virtual int scenarioRunId() const;
126  virtual void setScenarioRunId(int);
127 
128  virtual bool isCurrentParameterDb() const;
129  virtual void setIsCurrentParameterDb(bool isCurrentParameterDb);
130 
131  virtual bool isResourceMonitorEnabled() const;
132  virtual void setIsResourceMonitorEnabled(bool isCurrentParameterDb);
133 
137  virtual bool isLoaded() const;
138  virtual void setIsLoaded(const bool loaded);
139 
142 
143  virtual unsigned int simEngineId() const;
144  virtual void setSimEngineId(unsigned int id);
146 
149  virtual void setLoadingScenario(bool);
150  virtual bool loadingScenario() const;
152 
155  virtual void setImportingScenario(bool);
156  virtual bool importingScenario() const;
158 
161  virtual void setCreatingSimulationObjectGroup(bool);
162  virtual bool creatingSimulationObjectGroup() const;
164 
167  virtual void setClosingScenario(bool);
168  virtual bool closingScenario() const;
170 
173  virtual void setRollingBackScenario(bool);
174  virtual bool rollingBackScenario() const;
176 
179  virtual void setLoadedNewScenario(bool);
180  virtual bool loadedNewScenario() const;
182 
183  virtual int netRepSize() const;
184  virtual bool setFromNet(const char* contentBuffer,
185  unsigned contentSize);
186  virtual bool setToNet();
187 
188  virtual void printDataToString(DtString& str);
189 
190  static DtSimInterfaceContent* creator();
191 
194  virtual bool canSimulate() const;
195  virtual void setCanSimulate(const bool frontEnd);
196 
197  bool oldStyleStatus() const
198  {
199  return (myVersion < 10);
200  }
201 
202  virtual void setIsTimeManaged(bool yesNo);
203  virtual bool isTimeManaged() const;
204 
207 
208  virtual DtU32 scenarioCapabilities() const;
209  virtual void setScenarioCapabilities(DtU32 v);
210  virtual void setScenarioCapability(DtU32 v, bool b);
212 
215 
216  virtual DtString applicationType() const;
217  virtual void setApplicationType(const DtString& type);
219 
222  const DtString& scenarioName() const
223  {
224  return myScenarioName;
225  }
226 
227  const DtString& terrainName() const
228  {
229  return myTerrainName;
230  }
231 
232  const DtString& guiTerrainName() const
233  {
234  return myGuiTerrainName;
235  }
237 
238 protected:
239 
243  DtU32 myVersion;
244  DtU32 myPort;
245  DtU16 myControlState;
246  DtInetAddr myInetAddr;
247  bool myIsFinalStatusMsg;
248  bool myIsCurrentParameterDb;
249  bool myResourceMonitorIsEnabled;
250  bool myIsLoaded;
251  DtTime myExerciseStartTime;
252  DtTime mySimTime;
253  DtTime mySimStartSimTime;
254  double myTimeMultiplier;
255  bool myLoadedNewScenario;
256  DtU32 mySimEngineId;
257  bool myCanSimulate;
258  bool myIsTimeManaged;
259  bool myLoadingScenario;
260  bool myImportingScenario;
261  bool myCreatingSimulationObjectGroup;
262  bool myClosingScenario;
263  bool myRollingBackScenario;
264  DtU32 myScenarioRunId;
266  DtU32 myScenarioCapabilities;
268  DtString myApplicationType;
269 
272  ObjectCounts myObjectCounts;
273 
274  DtTime myRunDurationTime;
275 
277  DtString myScenarioName;
278  DtString myTerrainName;
279  DtString myGuiTerrainName;
280 };
Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)