VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
vrfSimulationSettingsRecord.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 2017 MAK Technologies, Inc.
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
11 
12 #pragma once
13 
14 #include <vrfGuiCore/vrfGuiCore.h>
15 #include <vrvUtil/DtUnicode.h>
16 
17 #include <boost/serialization/access.hpp>
18 #include <boost/serialization/nvp.hpp>
19 #include <boost/serialization/list.hpp>
20 #include <boost/serialization/map.hpp>
21 #include <boost/serialization/vector.hpp>
22 #include <boost/serialization/string.hpp>
23 
24 namespace makVrf
25 {
26  class DT_DLL_VRFGUICORE DtVrfSimulationSettingsRecord
27  {
28  public:
29  enum VrfSimulationSettingsOptions
30  {
31  DtAllowOrbatDeletionChoice = 0x00000001,
32  DtAggregateOnCreate = 0x00000400,
33  DtCheckForUnusedTriggersOnPlanSave = 0x00100000,
34  DtSaveScenarioAsStartingSnapshot = 0x00200000,
35  DtEnablePeriodicCheckpointing = 0x00400000,
36  AutomaticallyStartMissingBackends = 0x00800000,
37  };
38 
39 
40  struct SimulationModelSetConfiguration
41  {
42  std::string title;
43  std::vector<std::string> simulationModelSets;
44  std::string additionalInformation;
45  friend class boost::serialization::access;
46 
50  template<class Archive>
51  void serialize(Archive & ar, const unsigned int version)
52  {
53  ar & BOOST_SERIALIZATION_NVP(title);
54  ar & BOOST_SERIALIZATION_NVP(simulationModelSets);
55  ar & BOOST_SERIALIZATION_NVP(additionalInformation);
56  }
57  };
58 
59  public:
60  DtVrfSimulationSettingsRecord();
61  DtVrfSimulationSettingsRecord(const DtVrfSimulationSettingsRecord& orig);
62 
63  virtual ~DtVrfSimulationSettingsRecord();
64 
65  public:
66 
67  virtual void setFlag(int flag, bool set);
68 
70  virtual void setCheckForUnusedTriggersOnPlanSave(bool);
71  virtual bool checkForUnusedTriggersOnPlanSave() const;
72 
73  void setSaveScenarioAsStartingSnapshot(bool);
74  bool saveScenarioAsStartingSnapshot() const;
75 
76  void setEnablePeriodicCheckpointing(bool);
77  bool enablePeriodicCheckpointing() const;
78 
79  virtual void setAllowOrbatDeletionChoice(bool);
80  virtual bool allowOrbatDeletionChoice() const;
81 
82  void setPeriodicCheckpointingFrequency(int);
83  int periodicCheckpointingFrequency() const;
84 
85  void setPeriodicCheckpointingDirectory(const std::string&);
86  const std::string& periodicCheckpointingDirectory() const;
87 
88  void setStartupTerrain(const std::string&);
89  const std::string& startupTerrain() const;
90 
91  void setStartupScenario(const std::string&);
92  const std::string& startupScenario() const;
93 
94  void setStartupSimulationModelSet(const std::string&);
95  const std::string& startupSimulationModelSet() const;
96 
97  void setAggregateOnCreate(bool);
98  bool aggregateOnCreate() const;
99 
100  void setDefaultScenarioFile(const std::string&);
101  const std::string& defaultScenarioFile() const;
102 
103  void setSimulationObjectGroupTerrain(const std::string&);
104  const std::string& simulationObjectGroupTerrain() const;
105 
106  void setDefaultEnvironmentCondition(const std::string&);
107  const std::string& defaultEnvironmentCondition() const;
108 
109  void setDefaultSimulationModelSetFile(const std::string&);
110  const std::string& defaultSimulationModelSetFile() const;
111 
113  virtual const std::vector<SimulationModelSetConfiguration>& simulationModelSetConfigurations() const;
114  virtual void setSimulationModelSetConfigurations(const std::vector<SimulationModelSetConfiguration>&);
115 
117  virtual void setDefaultScenarioStartTime(time_t);
118  virtual time_t defaultScenarioStartTime() const;
119 
121  virtual void setAutomaticallyStartMissingBackends(bool);
122  virtual bool automaticallyStartMissingBackends() const;
123 
124  protected:
125  friend class boost::serialization::access;
126 
130  template<class Archive>
131  void serialize(Archive & ar, const unsigned int version)
132  {
133  ar & BOOST_SERIALIZATION_NVP(mySimulationOptions);
134  ar & BOOST_SERIALIZATION_NVP(myDefaultScenarioFile);
135  ar & BOOST_SERIALIZATION_NVP(myDefaultSimulationModelSetFile);
136  ar & BOOST_SERIALIZATION_NVP(mySimulationModelSetConfigurations);
137  ar & BOOST_SERIALIZATION_NVP(myDefaultScenarioStartTime);
138  ar & BOOST_SERIALIZATION_NVP(mySimulationObjectGroupTerrain);
139  ar & BOOST_SERIALIZATION_NVP(myStartupTerrain);
140  ar & BOOST_SERIALIZATION_NVP(myStartupScenario);
141  ar & BOOST_SERIALIZATION_NVP(myStartupSimulationModelSet);
142  ar & BOOST_SERIALIZATION_NVP(myPeriodicCheckpointingTime);
143  ar & BOOST_SERIALIZATION_NVP(myPeriodicCheckpointingDirectory);
144  ar & BOOST_SERIALIZATION_NVP(myDefaultEnvironmentCondition);
145  }
146 
147  protected:
148  VrfSimulationSettingsOptions mySimulationOptions;
149  std::string myDefaultScenarioFile;
150  std::string myDefaultSimulationModelSetFile;
151  std::string mySimulationObjectGroupTerrain;
152  std::vector<SimulationModelSetConfiguration> mySimulationModelSetConfigurations;
153  time_t myDefaultScenarioStartTime;
154 
155  std::string myStartupTerrain;
156  std::string myStartupScenario;
157  std::string myStartupSimulationModelSet;
158 
159  int myPeriodicCheckpointingTime;
160  std::string myPeriodicCheckpointingDirectory;
161  std::string myDefaultEnvironmentCondition;
162  };
163 }
164 
165 BOOST_CLASS_VERSION(makVrf::DtVrfSimulationSettingsRecord,1)
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)