VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
scenario.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfutil/vrfutilDefines.h"
12 #include <readerWriter/readerWriter.h>
13 #include <vlutil/vlString.h>
14 #include <vlutil/vlFilename.h>
15 #include <readerWriter/rwString.h>
16 #include <readerWriter/rwBoolean.h>
17 #include <readerWriter/rwReal.h>
18 #include "vrfutil/rwUnsigned.h"
19 #include <readerWriter/rwObjectType.h>
20 #include "vrfutil/rwUUID.h"
21 #include <readerWriter/rwInt.h>
22 #include "vrfutil/simClock.h"
23 #include "vrfutil/stringIntMapper.h"
24 #include "vrfutil/rwNLengthStringVector.h"
25 #include "vrfutil/rwKeyValueList.h"
26 #include <vlpi/simulationAddress.h>
27 
28 #include <boost/unordered_map.hpp>
29 
31 #include <vrfmsgs/messageTypes.h>
32 
33 class DtlInoutStream;
34 
42 
47 
50 typedef bool (*DtPreserveMappingsFcn)(void* usr);
51 
52 class DT_DLL_vrfutil DtScenario : public DtReaderWriter
53 {
54 public:
56  struct ScenarioData
57  {
58  std::string markingText;
59  DtObjectType objectType;
60  std::string label;
61  };
62 
63  typedef boost::unordered_map<DtUUID, ScenarioData> ScenarioDataMap;
64 
65 public:
66 
68  DtScenario();
69 
71  DtScenario(const DtString & name,
72  DtReaderWriterRegistry * const parentRegistry = 0);
73 
75  virtual ~DtScenario();
76 
78  DtScenario(const DtScenario& orig);
79 
81  DtScenario& operator=(const DtScenario& orig);
82 
84  virtual bool init();
85 
87  virtual bool readScenarioFile(const DtFilename& filename);
88 
91  bool saveAsZipFile() const;
92  virtual void setSaveAsZipFile(bool);
93 
95  virtual bool save();
96 
99  static bool saveBufferToScenarioZipFile(const DtFilename& scenanarioZipFile, const DtFilename& zipContentsFile,
100  const DtString& buffer);
101  static bool saveBufferToScenarioZipFile(const DtFilename& scenanarioZipFile, const DtFilename& zipContentsFile,
102  const char* buffer, int length);
103 
107  static bool readBufferFromScenarioZipFile(const DtFilename& scenanarioZipFile, const DtFilename& zipContentsFile,
108  DtString& buffer, bool onlyNeedsExtensionMatch = true);
109 
111  static bool fileExistsInZipFile(const DtFilename& scenanarioZipFile, const DtFilename& zipContentsFile,
112  bool onlyNeedsExtensionMatch = true);
113 
116  static bool extractScenarioFileFromZipFile(const DtFilename& scenarioZipFile, const DtFilename& zipContentsFile,
117  bool onlyNeedsExtensionMatch = true);
118 
120  static bool readScenarioFromZipFile(const DtFilename& f, DtScenario& scenario);
121 
123  static bool saveFileToScenarioZipFile(const DtFilename& scenanarioZipFile, const DtFilename& zipContentsFile);
124 
126  static bool isScenarioZipFile(const DtFilename&);
127 
130  virtual DtString toXml(const DtFilename& scenarioFilename);
131 
133  virtual void setupScenarioFilenames(const DtFilename& scenarioFilename,
134  bool saveObjectMap = true);
135 
138  virtual bool save(const DtFilename& filename,
139  bool saveObjectMap = true);
140 
143  virtual DtScenario* clone() const;
144 
149  virtual void setComponentAttachmentRule(int rule);
150  virtual int componentAttachmentRule() const;
151 
153  virtual void setComponentAttachmentTableFilename(const DtFilename& filename);
154  virtual const DtFilename& componentAttachmentTableFilename() const;
157  virtual void setTerrainDatabaseFilename(const DtFilename& filename);
158  virtual const DtFilename& terrainDatabaseFilename() const;
159 
161  virtual void setGuiTerrainDatabaseFilename(const DtFilename& filename);
162  virtual const DtFilename& guiTerrainDatabaseFilename() const;
163 
165  virtual void setOrderOfBattleFilename(const DtFilename& filename);
166  virtual DtFilename orderOfBattleFilename() const;
167 
169  virtual void setScenarioScriptsFilename(const DtFilename& filename);
170  virtual DtFilename scenarioScriptsFilename() const;
171 
173  virtual void setOrbatFilename(const DtFilename& filename);
174  virtual DtFilename orbatFilename() const;
175 
177  virtual void setPlanFilename(const DtFilename& filename);
178  virtual DtFilename planFilename() const;
179 
181 
182  virtual void setGlobalPlanFilename(const DtFilename& filename);
183  virtual DtFilename globalPlanFilename() const;
185 
187  virtual void setParameterDatabaseFilename(const DtFilename& filename);
188  virtual const DtFilename& parameterDatabaseFilename() const;
189 
191  virtual void setPhysicalWorldFilename(const DtFilename& filename);
192  virtual const DtFilename& physicalWorldFilename() const;
193 
195  virtual void setObjectMapFilename(const DtFilename& filename);
196  virtual DtFilename objectMapFilename() const;
197 
200  virtual void setOverlayFilename(const DtFilename& filename);
201  virtual DtFilename overlayFilename() const;
202 
204  virtual void setSelectionGroupsFilename(const DtFilename& filename);
205  virtual DtFilename selectionGroupsFilename() const;
206 
209  virtual void setSymbolMapFilename(const DtFilename& filename);
210  virtual const DtFilename& symbolMapFilename() const;
211 
214  virtual void setCreateMenuFilename(const DtFilename& filename);
215  virtual const DtFilename& createMenuFilename() const;
216 
220  virtual void setForceHostilityFilename(const DtFilename& filename);
221  virtual DtFilename forceHostilityFilename() const;
222 
226  virtual void setScenarioExtrasFilename(const DtFilename& f);
227  virtual DtFilename scenarioExtrasFilename() const;
229 
235  virtual void setUseDayNightIlluminationModel(bool);
236  virtual bool useDayNightIlluminationModel() const;
237 
239  virtual void setTimeMultiplier(DtReal multiplier);
240  virtual DtReal timeMultiplier() const;
241 
243  virtual void setAutoReorganize(const bool& flag);
244  virtual const bool& autoReorganize() const;
245 
247  virtual void setRandomNumberSeed(long int numberSeed);
248  virtual long int randomNumberSeed() const;
249 
251  virtual DtString frameRateModeString() const;
252  virtual DtFrameMode frameRateMode() const;
253  virtual void setFrameRateModeString(DtString value);
254  virtual void setFrameRateMode(DtFrameMode value);
255 
257  virtual DtReal frameDeltaTime() const;
258  virtual void setFrameDeltaTime(DtReal value);
259 
262  virtual DtTime runDurationTime() const;
263  virtual void setRunDurationTime(DtTime time);
264 
266  virtual void setSimTime(DtTime time);
267  virtual DtTime simTime() const;
268 
270  virtual void setExerciseStartDateAndTime(int year, int month, int day, int hour, int minute, int second);
271 
273  virtual void setExerciseStartDateAndTime(DtTime time);
274 
276  virtual void setExerciseStartTime(DtTime time);
277 
279  virtual DtTime exerciseStartTime() const;
280 
285  virtual void setSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation(bool, int i = 10 * 3600);
286  virtual int setScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation() const;
287  virtual bool shouldSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation() const;
288 
291  virtual void setCreateGlobalEnvironment(bool b);
292  virtual bool createGlobalEnvironment() const;
294 
298  virtual void setCreateGlobalDynamicTerrain(bool b);
299  virtual bool createGlobalDynamicTerrain() const;
301 
305  virtual DtRwNLengthStringVector& additionalOpdFilenames();
306  virtual const DtRwNLengthStringVector& additionalOpdFilenames() const;
307  virtual void addAdditionalOpdFilename(const DtString&);
308  virtual void removeAdditonalOpdFilename(int iIndex);
309  virtual void setAdditionalOpdFilenames(const DtRwNLengthStringVector&);
311 
314  virtual void setScenarioDescription(const DtString&);
315  virtual DtString scenarioDescription() const;
316 
322  virtual DtRwNLengthStringVector& simulationModelSetFilenames();
323  virtual const DtRwNLengthStringVector& simulationModelSetFilenames() const;
324  virtual DtRwNLengthStringVector& unresolvedSimulationModelSetFilenames();
325  virtual const DtRwNLengthStringVector& unresolvedSimulationModelSetFilenames() const;
326  virtual void addSimulationModelSetFilename(const DtString&);
327  virtual void removeSimulationModelSetFilename(int iIndex);
328  virtual void setSimulationModelSetFilenames(const DtRwNLengthStringVector&);
329  virtual void setSimulationModelSetFilenames(const std::vector<DtFilename>&);
330  virtual void setSimulationModelSetFilenames(const std::vector<std::string>&);
332 
338 
339  virtual DtRwKeyValueList& scenarioData();
340  virtual const DtRwKeyValueList& scenarioData() const;
342 
345 
346  virtual DtString scenarioName() const;
347  virtual void setScenarioName(const DtString& name);
348  virtual bool scenarioNameSpecified() const;
350 
356  static DtFilename validTerrainFile(const DtFilename&);
357 
359  virtual bool isParameterDatabaseRwStringSpecified();
360  virtual bool isPhysicalWorldRwStringSpecified();
361  virtual bool isOrderOfBattleRwStringSpecified();
362  virtual bool isScenarioScriptsRwStringSpecified();
363  virtual bool isOrbatRwStringSpecified();
364  virtual bool isOverlayRwStringSpecified();
365  virtual bool isSelectionGroupsRwStringSpecified();
366  virtual bool isSymbolMapRwStringSpecified();
367  virtual bool isCreateMenuRwStringSpecified();
368  virtual bool isPlanRwStringSpecified();
369  virtual bool isObjectMapRwStringSpecified();
370  virtual bool isTimeMultiplierSpecified();
371  virtual bool isAutoReorganizeRwStringSpecified();
372  virtual bool isRandomNumberSeedSpecified();
373  virtual bool isFrameRateModeSpecified();
374  virtual bool isRunDurationTimeSpecified();
375  virtual bool isFrameDeltaTimeSpecified();
376  virtual bool isSimTimeSpecified();
377  virtual bool isExerciseStartTimeSpecified();
378  virtual bool isForceHostilityRWStringSpecified();
379  virtual bool isScenarioExtrasRWStringSpecified();
380 
381  virtual void setFilename(const DtFilename&);
382  virtual const DtFilename& filename() const;
383 
385  virtual bool writeScenarioFile(const DtFilename & filename);
386 
389  virtual void putSelf(std::string& fp, int indentLevel = 0, bool writeUnspecified = false,
390  const DtFilename& path = DtReaderWriter::appPath());
391 
392  virtual void putSelf(DtEnvironmentSP env, DtEnvValueSP parent) const;
393 
396  virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
397  const DtVariableBindingsList& variableBindings);
398  virtual void getSelf(const DtEnvironmentSP env, const DtEnvValueSP root,
399  const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& varBindings);
400 
402  virtual void finalizeGetSelf();
403 
407  virtual bool isValid(bool allowEmptyFilenames = true, DtString* retMessage = 0) const;
408 
410  virtual double version() const;
411 
413  virtual bool relativeToScenarioFile() const;
414 
416  virtual void setToCurrentVersion();
417 
419  static double currentScenarioVersion();
420 
424  virtual bool mapUUIDToScenarioDataFromOobInScenario(const DtFilename& scenarioFile,
425  ScenarioDataMap& scenarioDataMap, bool mapUUIDOnly = true);
426  virtual bool mapUUIDToScenarioDataFromOobInScenario(DtlInputStream*, ScenarioDataMap& scenarioDataMap, bool mapUUIDOnly = true);
427 
429  virtual bool mapUUIDToScenarioDataFromOobInScenario(ScenarioDataMap& scenarioDataMap, bool mapUUIDOnly = true);
430 
434  virtual void updateSimulationModelSetFilenames();
435 
437  static DtFilename reworkDataDirectory(const DtFilename&);
438 
440  static DtFilename replaceDirectoryWithAppropriateVariable(const DtFilename&);
441 
443  virtual void resolveSimulationModelSetPaths();
444 
446  virtual void resolveDataPaths();
447 public:
448 
449  static DtString getFrameModeNameFromFrameModeType(DtFrameMode);
450 
451  static DtFrameMode getFrameModeTypeFromFrameModeName(
452  const DtString& frameModeName);
453 
454 protected:
465  virtual DtFilename absoluteFilename(const DtFilename&) const;
466 
467 protected:
468 
469  DtRwInt myComponentAttachmentRule;
470 
471  DtFilename myComponentAttachmentTableFilename;
472  mutable DtRwString myComponentAttachmentTableRwString;
473  DtFilename myFilename;
474 
475  DtFilename myTerrainDatabaseFilename;
476  mutable DtRwString myTerrainDatabaseRwString;
477 
478  DtFilename myPhysicalWorldFilename;
479  mutable DtRwString myPhysicalWorldRwString;
480 
481  DtFilename myGuiTerrainDatabaseFilename;
482  mutable DtRwString myGuiTerrainDatabaseRwString;
483 
484  DtFilename myOrderOfBattleFilename;
485  mutable DtRwString myOrderOfBattleRwString;
486 
487  DtFilename myScenarioScriptsFilename;
488  mutable DtRwString myScenarioScriptsRwString;
489 
490  DtFilename myOrbatFilename;
491  mutable DtRwString myOrbatRwString;
492 
493  DtFilename myPlanFilename;
494  mutable DtRwString myPlanRwString;
495 
496  DtFilename myGlobalPlanFilename;
497  mutable DtRwString myGlobalPlanRwString;
498 
499  DtFilename myParameterDatabaseFilename;
500  mutable DtRwString myParameterDatabaseRwString;
501 
502  DtFilename myOverlayFilename;
503  mutable DtRwString myOverlayRwString;
504 
505  DtFilename mySelectionGroupsFilename;
506  mutable DtRwString mySelectionGroupsRwString;
507 
508  DtFilename mySymbolMapFilename;
509  mutable DtRwString mySymbolMapRwString;
510 
511  DtFilename myCreateMenuFilename;
512  mutable DtRwString myCreateMenuRwString;
513 
514  DtFilename myObjectMapFilename;
515  mutable DtRwString myObjectMapRwString;
516 
517  DtFilename myForceHostilityFilename;
518  mutable DtRwString myForceHostilityRwString;
519 
520  DtFilename myScenarioExtrasFilename;
521  mutable DtRwString myScenarioExtrasRWString;
522 
523  mutable DtRwReal myTimeMultiplier;
524 
525  bool myAutoReorganize;
526  mutable DtRwBoolean myAutoReorganizeRW;
527 
528  mutable DtRwInt myRandomNumberSeed;
529 
530  mutable DtRwString myFrameRateModeString;
531  DtFrameMode myFrameRateMode;
532  mutable DtRwReal myFrameDeltaTime;
533 
534  mutable DtRwReal myRunDurationTime;
535 
536  mutable DtRwReal mySimTime;
537  mutable DtRwReal myExerciseStartTime;
538 
539  DtRwNLengthStringVector myAdditionalOpdFilenames;
540  DtRwNLengthStringVector mySimulationModelSetFilenames;
541  DtRwNLengthStringVector myResolvedSimulationModelSetFilenames;
542 
543  DtRwString myScenarioName;
544 
545  DtRwKeyValueList myScenarioData;
546 
548  mutable DtRwReal myVersion;
549 
551  bool mySaveAsZipFile;
552 
553 protected:
554 
555  static DtString thePhysicalWorldFilenameExtension;
556  static DtString theOrderOfBattleExtension;
557  static DtString theScenarioScriptsExtension;
558  static DtString theOrbatExtension;
559  static DtString theOverlayExtension;
560  static DtString theSelectionGroupsExtension;
561  static DtString theSymbolMapExtension;
562  static DtString theCreateMenuExtension;
563  static DtString thePlanExtension;
564  static DtString theGlobalPlanExtension;
565  static DtString theObjectMapExtension;
566  static DtString theParameterDatabaseExtension;
567  static DtString theFileExtension;
568  static DtString theForceHostilityExtension;
569  static DtString theScenarioDataExtension;
570 
571  static double theScenarioVersion;
572 };
573 
574 class DtAddressMap;
575 class DtList;
576 class DtBackendMap;
577 
580 typedef bool (*DtLoadBalancingFcn)(DtAddressMap* map, const DtList* backends,
581  bool& remapped, void* usr);
582 
583 typedef bool (*DtRemappingFcn)(DtBackendMap* map, const std::set<DtSimulationAddress>& expectedBackends, void* usr);
584 
585 class DT_DLL_vrfutil DtLoadBalancingFcnInfo
586 {
587 public:
588  DtLoadBalancingFcnInfo();
589  DtLoadBalancingFcnInfo(const std::string&, DtLoadBalancingFcn fcn, void*);
590  DtLoadBalancingFcnInfo(const DtLoadBalancingFcnInfo&);
591 
592  DtLoadBalancingFcnInfo& operator=(const DtLoadBalancingFcnInfo&);
593 
594  std::string myLoadBalancer;
595  DtLoadBalancingFcn myLoadBalancingFcn;
596  void* myLoadBalancingUserData;
597 };
598 
599 const int DtImportScenarioCreateUniqueNamesOnImport = 0x00000001;
600 const int DtImportScenarioImportScenarioEvents = 0x00000002;
601 const int DtImportScenarioCreateSelectionGroup = 0x00000004;
602 const int DtSimulationObjectGroupPreserveForceInformation = 0x00000008;
603 const int DtSimulationObjectGroupUseGroupNameToDisambiguate = 0x00000010;
604 const int DtSimulationObjectGroupAltitudesAreAboveTerrain = 0x00000020;
605 const int DtSimulationObjectGroupCreationMode = 0x00000040;
606 const int DtSimulationObjectGroupAllowAltitudePlacement = 0x00000080;
607 const int DtImportScenarioKeepOnlyOriginalSimulationObjects = 0x00000100;
608 
609 const int DtImportScenarioDefaultFlags = DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents |
610  DtImportScenarioCreateSelectionGroup;
611 const int DtSimulationObjectGroupDefaultFlags = DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents |
612  DtImportScenarioCreateSelectionGroup | DtSimulationObjectGroupPreserveForceInformation | DtSimulationObjectGroupAltitudesAreAboveTerrain;
613 
614 class DT_DLL_vrfutil DtScenarioLoadInformation
615 {
616 public:
617  DtScenarioLoadInformation();
618  DtScenarioLoadInformation(bool createAsNew, DtScenario*, DtLoadBalancingFcnInfo, DtRemappingFcn fcn = 0, void* remappingUsrData = 0,
619  time_t startTimeOfDay = 0, bool import = false, const DtSimulationAddress& address = DtSimSendToAll);
620  DtScenarioLoadInformation(const DtScenarioLoadInformation&);
621 
622  DtScenarioLoadInformation& operator=(const DtScenarioLoadInformation&);
623 
624 public:
625  bool myCreateAsNew;
626  DtScenario* myScenario;
627  DtLoadBalancingFcnInfo myInfo;
628  DtRemappingFcn myRemappingFcn;
629  void* myRemappingUserData;
630  time_t myStartTimeOfDay;
631  bool myImport;
632  DtSimulationAddress myImportLoadAddress;
633 };
634 
635 struct DtSimulationObjectGroupSaveInformation
636 {
637  DtSimulationObjectGroupSaveInformation() : groupCreationFlags(DtSimulationObjectGroupDefaultFlags),
638  storedInZipFile(true)
639  {
640  };
641 
642  DtSimulationObjectGroupSaveInformation(const DtSimulationObjectGroupSaveInformation& orig) :
643  groupName(orig.groupName), groupDescription(orig.groupDescription), label(orig.label),
644  groupCreationFlags(orig.groupCreationFlags), categories(orig.categories), palette(orig.palette),
645  additionalInformation(orig.additionalInformation), menuIcon(orig.menuIcon), rootDirectory(orig.rootDirectory),
646  storedInZipFile(orig.storedInZipFile) {};
647 
648  bool operator==(const DtSimulationObjectGroupSaveInformation& rhs) const
649  {
650  return ((rootDirectory == rhs.rootDirectory) &&
651  (groupName == rhs.groupName) &&
652  (groupDescription == rhs.groupDescription) &&
653  (label == rhs.label) &&
654  (palette == rhs.palette) &&
655  (menuIcon == rhs.menuIcon) &&
656  (groupCreationFlags == rhs.groupCreationFlags) &&
657  (categories == rhs.categories) &&
658  (storedInZipFile == rhs.storedInZipFile) &&
659  (additionalInformation == rhs.additionalInformation));
660  }
661 
662  bool operator!=(const DtSimulationObjectGroupSaveInformation& rhs) const { return !(*this == rhs); };
663 
664  DtFilename rootDirectory;
665  std::string groupName;
666  std::string groupDescription;
667  std::string palette;
668  std::string menuIcon;
669  std::string label;
670  int groupCreationFlags;
671  std::vector<DtString> categories;
672  std::map<DtString, DtString> additionalInformation;
673  bool storedInZipFile;
674 };
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)