VR-Forces 4.1 Class Documentation
ifSaveComplete.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2004 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: ifSaveComplete.h,v $ $Revision: 1.14 $ $State: Exp $
7 *******************************************************************************/
8 
11 
12 #ifndef DtIfSaveComplete_H_
13 #define DtIfSaveComplete_H_
14 
15 #include <vrfExtProtocol/ifaceCont.h>
16 #include <vlpi/NetStructs.h>
17 #include <vlutil/vlFilename.h>
18 #include <list>
19 #include "vrfmsgs/vrfmsgsDefines.h"
20 #include "vrfutil/rwKeyValueList.h"
21 
22 
23 class DtNetIfSaveComplete
24 {
25 public:
26  DtNetFloat64 myFrameTime;
27  DtNetFloat64 myTimeMultiplier;
28  DtNetFloat64 mySimTime;
29  DtNetFloat64 myExerciseStartTime;
30  DtNetU32 myRequestId;
31  DtNetU32 myResult;
32  DtNetInt32 myFrameMode;
33  DtNetU32 myRandomNumberSeed;
34  DtNetBoolean myAutoReorganize;
35  DtNetU32 myNumberOfAdditionalOpds;
36  DtNetU32 myNumberOfSimulationModelSets;
37 };
38 
39 enum DtSaveResult {DtSuccess, DtFailure} ;
40 
41 
44 class DT_DLL_vrfmsgs DtIfSaveComplete : public DtSimInterfaceContent
45 {
46 public:
47 
49  DtIfSaveComplete();
50 
52  virtual ~DtIfSaveComplete();
53 
55  DtIfSaveComplete(const DtIfSaveComplete& orig);
56 
58  DtIfSaveComplete& operator=(const DtIfSaveComplete& orig);
59 
61  virtual int type() const;
62 
64  virtual void setRequestId(unsigned int id);
65  virtual unsigned int requestId() const;
66 
68  virtual void setResult(DtSaveResult result);
69  virtual DtSaveResult result() const;
70 
71  virtual const DtFilename& terrainFileName() const;
72  virtual void setTerrainFileName(const DtString & fileName);
73 
74  virtual const DtFilename& guiTerrainName() const;
75  virtual void setGuiTerrainName(const DtString& filename);
76 
77  virtual const DtFilename& componentAttachmentTableFileName() const;
78  virtual void setComponentAttachmentTableFileName(const DtString & fileName);
79  virtual const bool& autoReorganize() const;
80  virtual void setAutoReorganize(bool yesNo);
81 
82  virtual double timeMultiplier() const;
83  virtual void setTimeMultiplier(double timeMultiplier);
84 
85  virtual const DtFilename& objectParametersFileName() const;
86  virtual void setObjectParametersFileName(const DtString & fileName);
87 
88  virtual const DtFilename& physicalWorldFileName() const;
89  virtual void setPhysicalWorldFileName(const DtString & fileName);
90 
91  virtual const DtFilename& orderOfBattleFileName() const;
92  virtual void setOrderOfBattleFileName(const DtString & fileName);
93 
94  virtual const DtFilename& scenarioScriptsFileName() const;
95  virtual void setScenarioScriptsFileName(const DtString & fileName);
96 
97  virtual const DtFilename& planFileName() const;
98  virtual void setPlanFileName(const DtString & fileName);
99 
100  virtual const DtFilename& forceHostilityFileName() const;
101  virtual void setForceHostilityFileName(const DtString& fileName);
102 
103  virtual const DtFilename& scenarioExtrasFileName() const;
104  virtual void setScenarioExtrasFileName(const DtString& fileName);
105 
106  virtual unsigned int randomNumberSeed() const;
107  virtual void setRandomNumberSeed(unsigned int numberSeed);
108 
109  virtual int frameMode() const;
110  virtual void setFrameMode(int frameMode);
111 
112  virtual double frameTime() const;
113  virtual void setFrameTime(double frameTime);
114 
116  virtual void setSimTime(DtTime time);
117  virtual DtTime simTime() const;
118 
120  virtual void setExerciseStartTime(DtTime time);
121  virtual DtTime exerciseStartTime() const;
122 
123  virtual std::list<DtString>& additionalOpdFileNames();
124  virtual const std::list<DtString>& additionalOpdFileNames() const;
125 
126  virtual std::list<DtString>& simulationModelSetFileNames();
127  virtual const std::list<DtString>& simulationModelSetFileNames() const;
128 
129  virtual DtFilename globalPlanFileName() const;
130  virtual void setGlobalPlanFileName(const DtString& filename);
131 
132  virtual DtString scenarioName() const;
133  virtual void setScenarioName(const DtString& name);
134 
135  virtual DtRwKeyValueList& scenarioData();
136  virtual const DtRwKeyValueList& scenarioData() const;
137 
138  virtual DtSimInterfaceContent * clone() const;
139 
140  virtual int netRepSize() const;
141  virtual bool setFromNet(const char* contentBuffer,
142  unsigned contentSize);
143  virtual bool setToNet();
144  virtual void setToNet(char*);
145 
146  virtual void printDataToString(DtString& str);
147 
148  static DtSimInterfaceContent* creator();
149 
150 protected:
151  DtU32 myRequestId;
152  DtSaveResult myResult;
153  DtInt32 myFrameMode;
154  DtFloat64 myFrameTime;
155  DtU32 myRandomNumberSeed;
156  DtFilename myTerrainFileName;
157  DtFilename myComponentAttachmentTableName;
158  DtFilename myObjParamsFileName;
159  DtFilename myPhysicalWorldFileName;
160  DtFilename myPlanFileName;
161  DtFilename myGlobalPlanFileName;
162  DtFilename myOrderOfBattleFileName;
163  DtFilename myScenarioScriptsFilename;
164  DtFilename myForceHostilityFileName;
165  DtFilename myScenarioExtrasFileName;
166  bool myAutoReorganize;
167  DtFloat64 myTimeMultiplier;
168  DtReal mySimTime;
169  DtReal myExerciseStartTime;
170  std::list<DtString> myAdditionalOpdFileNames;
171  std::list<DtString> mySimulationModelSetFileNames;
172  DtString myScenarioName;
173  DtRwKeyValueList myScenarioData;
174  DtFilename myGuiTerrainName;
175 };
176 
177 #endif
178 
Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)