VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
vrfExtendedApplicationSettings.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2016 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
8 
9 #pragma once
10 
11 #include <vrfGuiCore/vrfGuiCore.h>
12 #include <vrfGuiCore/vrfGuiApplicationSettings.h>
13 #include <vrfGuiCore/entityMapperKey.h>
14 #include <vrfGuiCore/vrfExtendedApplicationSettings.h>
15 #include <vrfGuiCore/vrfDisplayUnitsSettingsManager.h>
16 #include <vrvCore/DtDisplayUnitsSettingsManager.h>
17 
18 #include <set>
19 
20 namespace makVrv
21 {
22  class DtDe;
23 }
24 
25 namespace makVrf
26 {
29  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettingsData : public DtVrfGuiApplicationSetting
30  {
31  protected:
32  enum Flags
33  {
34  ObserversPublished = 0x00000001,
35  DoNotShowMeTellMeAboutFavorites = 0x00000002,
36  ShowWeather = 0x00000004,
37  ShowNavigationAreas = 0x00000008,
38  ShowNavigationProgress = 0x00000010,
39  SaveScenarioToZipFile = 0x00000020,
40  WeatherAreaUnfilled = 0x00000040,
41  ShowEchelonIdColumn = 0x00000080,
42  FilteredListsAreOrbatEnabled = 0x00000100,
43  ShowFavoritesIcon = 0x00000400,
44  ShowForceColor = 0x00000800,
45  ShowCloudLayers = 0x00001000,
46  HideSearchBars = 0x00002000,
47  Defaults = ObserversPublished | ShowWeather | ShowCloudLayers | ShowNavigationProgress | SaveScenarioToZipFile | FilteredListsAreOrbatEnabled | ShowForceColor
48  };
49 
50  public:
51  DtVrfExtendedApplicationSettingsData(makVrv::DtDe* = 0);
52  DtVrfExtendedApplicationSettingsData(const DtVrfExtendedApplicationSettingsData&);
53 
54  virtual ~DtVrfExtendedApplicationSettingsData();
55 
57  virtual void setObserversPublished(bool);
58  virtual bool observersPublished() const;
59 
61  virtual void setDoNotShowTellMeAboutFavorites(bool);
62  virtual bool doNotShowTellMeAboutFavorites() const;
63 
67  virtual void setDateAndTimeOfDayFormat(const std::string&);
68  virtual std::string dateAndTimeOfDayFormat() const;
69 
71  virtual void setTimezone(const std::string&);
72  virtual std::string timezone() const;
73 
75  virtual void setFormatsSet(const std::string&);
76  virtual std::string formatsSet() const;
77 
79  virtual void setHideSearchBars(bool);
80  virtual bool hideSearchBars() const;
81 
83  virtual void setShowWeather(bool);
84  virtual bool showWeather() const;
85 
87  virtual void setShowCloudLayers(bool);
88  virtual bool showCloudLayers() const;
89 
92  virtual void setWeatherAreaFilled(bool);
93  virtual bool weatherAreaFilled() const;
94 
97  virtual void setAsynchLoadBufferTime(double d);
98  virtual double asynchLoadBufferTime() const;
99 
101  virtual void setSaveScenarioToZipFile(bool);
102  virtual bool saveScenarioToZipFile() const;
103 
105  virtual void setShowFavoritesIcon(bool);
106  virtual bool showFavoritesIcon() const;
107 
109  virtual void setShowNavigationAreas(bool);
110  virtual bool showNavigationAreas() const;
111 
114  virtual void setSimQueryUpdateTime(double);
115  virtual double simQueryUpdateTime() const;
116 
118  virtual void setMaximumNavigationAreaCellSize(double length, double width);
119  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
120 
122  void setShowProgressOnGenerationStart(bool b);
123  bool showProgressOnGenerationStart() const;
124 
126  virtual void setUseLocalTimezone(bool);
127  virtual bool useLocalTimezone() const;
128 
130  virtual void setNumberOfRecentlyCreatedItems(int);
131  virtual int numberOfRecentlyCreatedItems() const;
132 
134  virtual void addRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
135 
137  virtual bool isRecentlyCreated(const std::string& palette, const DtEntityMapperKey&) const;
138 
140  virtual void removeRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
141 
143  virtual void removeAllRecentlyCreated(const std::string& palette);
144 
146  virtual DtVrfGuiApplicationSetting* clone() const;
147 
149  virtual std::string classType() const;
150 
152  virtual void write(boost::archive::xml_oarchive& out, const unsigned int);
153  virtual void read(boost::archive::xml_iarchive& in, const unsigned int);
154 
156  virtual void setAllowChangingOfExtendedLabels(bool);
157  virtual bool allowChangingOfExtendedLabels() const;
158 
161  virtual void setDefaultLayoutSettingsFile(const std::string&);
162  virtual std::string defaultLayoutSettingsFile() const;
163 
165  virtual void setQtDesignerLocation(const std::string&);
166  virtual std::string qtDesignerLocation() const;
167 
169  virtual void setShowEchelonIdColumn(bool);
170  virtual bool showEchelonIdColumn() const;
171 
174  virtual bool filteredListsAreOrbatEnabled() const;
175  virtual void setFilteredListsAreOrbatEnabled(bool);
176 
178  virtual void setDefaultIconList(const std::string&);
179  virtual const std::string& defaultIconList() const;
180 
182  virtual void setShowForceColor(bool);
183  virtual bool showForceColor() const;
184 
186  virtual void setAllowBackendShutdown(bool);
187  virtual bool allowBackendShutdown() const;
188 
190  virtual void setCloseScenarioSendTimeoutRetry(double d);
191  virtual double closeScenarioSendTimeoutRetry() const;
192 
194  virtual void setCloseRetryCount(int);
195  virtual int closeRetryCount() const;
196 
197  virtual int dataVersion() { return 22; };
198 
199  protected:
200  virtual void setFlag(Flags, bool);
201 
202  protected:
203  int myFlags;
204  std::string myDateAndTimeOfDayFormat;
205  std::string myTimezone;
206  std::string myFormatsSet;
207  bool myUseLocalTimezone;
208  bool myAllowChangingOfExtendedLabels;
209 
211  typedef std::map<std::string, bool> PaletteItemsVisibilityMap;
212  PaletteItemsVisibilityMap myPaletteItemsVisibilityMap;
213 
214  double mySimQueryUpdateTime;
215  double myMaximumNavigationAreaCellWidth;
216  double myMaximumNavigationAreaCellLength;
217  double myAsynchLoadBufferTime;
218 
219  std::string myDefaultLayoutSettingsFile;
220  std::string myQtDesignerLocation;
221 
222  std::map<std::string, std::vector<std::string> > myRecentlyCreated;
223  std::map<std::string, std::set<std::string> > myRecentlyCreatedSet;
224  int myNumberOfRecentlyCreated;
225 
226  std::string myDefaultIconList;
227 
229  bool myAllowBackendShutdown;
230 
232  double myCloseScenarioSendTimeoutRetry;
233  int myCloseRetryCount;
234  };
235 
238  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettings : public makVrv::DtVirtualBaseClass
239  {
240  public:
241  DtVrfExtendedApplicationSettings(makVrv::DtDe&);
242 
243  virtual ~DtVrfExtendedApplicationSettings();
244 
246  virtual void setObserversPublished(bool);
247  virtual bool observersPublished() const;
248 
250  virtual void setDoNotShowTellMeAboutFavorites(bool);
251  virtual bool doNotShowTellMeAboutFavorites() const;
252 
254  virtual void setShowWeather(bool);
255  virtual bool showWeather() const;
256 
258  virtual void setShowCloudLayers(bool);
259  virtual bool showCloudLayers() const;
260 
263  virtual void setWeatherAreaFilled(bool);
264  virtual bool weatherAreaFilled() const;
265 
267  virtual void setShowNavigationAreas(bool);
268  virtual bool showNavigationAreas() const;
269 
271  virtual void setSaveScenarioToZipFile(bool);
272  virtual bool saveScenarioToZipFile() const;
273 
276  virtual void setAsynchLoadBufferTime(double d);
277  virtual double asynchLoadBufferTime() const;
278 
280  virtual void setShowProgressOnGenerationStart(bool b);
281  virtual bool showProgressOnGenerationStart() const;
282 
284  virtual void setPaletteItemVisible(const std::string& item , bool);
285  virtual bool paletteItemVisible(const std::string& item, bool* keyExists = 0) const;
286 
290  virtual void setDateAndTimeOfDayFormat(const std::string&);
291  virtual std::string dateAndTimeOfDayFormat() const;
292 
294  virtual void setTimezone(const std::string&);
295  virtual std::string timezone() const;
296 
298  virtual void setFormatSets(const std::string&);
299  virtual std::string formatSets() const;
300 
302  virtual void setAllowChangingOfExtendedLabels(bool);
303  virtual bool allowChangingOfExtendedLabels() const;
304 
306  virtual void setShowFavoritesIcon(bool);
307  virtual bool showFavoritesIcon() const;
308 
310  virtual void setUseLocalTimezone(bool);
311  virtual bool useLocalTimezone() const;
312 
314  virtual void setHideSearchBars(bool);
315  virtual bool hideSearchBars() const;
316 
319  virtual void setSimQueryUpdateTime(double);
320  virtual double simQueryUpdateTime() const;
321 
323  virtual void setMaximumNavigationAreaCellSize(double length, double width);
324  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
325 
327  virtual void setDefaultLayoutSettingsFile(const std::string&);
328  virtual std::string defaultLayoutSettingsFile() const;
329 
331  virtual void setQtDesignerLocation(const std::string&);
332  virtual std::string qtDesignerLocation() const;
333 
334  static DtVrfExtendedApplicationSettings& instance( makVrv::DtDe& de );
335  static void registerInstance(makVrv::DtDe&, DtVrfExtendedApplicationSettings*);
336 
338  virtual void setCloseScenarioSendTimeoutRetry(double d);
339  virtual double closeScenarioSendTimeoutRetry() const;
340 
342  virtual void setCloseRetryCount(int);
343  virtual int closeRetryCount() const;
344 
346  virtual void setShowEchelonIdColumn(bool);
347  virtual bool showEchelonIdColumn() const;
348 
351  virtual bool filteredListsAreOrbatEnabled() const;
352  virtual void setFilteredListsAreOrbatEnabled(bool);
353 
355  virtual void setDefaultIconList(const std::string&);
356  virtual const std::string& defaultIconList() const;
357 
359  virtual void setShowForceColor(bool);
360  virtual bool showForceColor() const;
361 
363  virtual void setNumberOfRecentlyCreatedItems(int);
364  virtual int numberOfRecentlyCreatedItems() const;
365 
367  virtual void addRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
368 
370  virtual bool isRecentlyCreated(const std::string& palette, const DtEntityMapperKey&) const;
371 
373  virtual void removeRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
374 
376  virtual void removeAllRecentlyCreated(const std::string& palette);
377 
379  virtual void setAllowBackendShutdown(bool);
380  virtual bool allowBackendShutdown() const;
381 
383  boost::signals2::signal<void ()> signal_extendedApplicationOptionsChanged;
384 
386  boost::signals2::signal<void (bool)> signal_searchBarVisibilityChanged;
387 
389  boost::signals2::signal<void (double)> signal_simQueryUpdateTimeChanged;
390 
392  boost::signals2::signal<void (std::string)> signal_defaultIconListChanged;
393 
394  protected:
395  virtual void slot_activated();
396 
397  protected:
398  makVrv::DtDe& myDe;
399  };
400 }
makVrf::DtEntityMapperKey
Definition: entityMapperKey.h:23
makVrv::DtVirtualBaseClass
Virtual base class.
Definition: DtVirtualBaseClass.h:19
makVrf::DtVrfExtendedApplicationSettings::signal_extendedApplicationOptionsChanged
boost::signals2::signal< void()> signal_extendedApplicationOptionsChanged
Signal sent any time an option changes.
Definition: vrfExtendedApplicationSettings.h:383
makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreatedSet
std::map< std::string, std::set< std::string > > myRecentlyCreatedSet
Definition: vrfExtendedApplicationSettings.h:223
makVrf::DtVrfExtendedApplicationSettingsData::myNumberOfRecentlyCreated
int myNumberOfRecentlyCreated
Definition: vrfExtendedApplicationSettings.h:224
makVrf::DtVrfExtendedApplicationSettingsData
This class will be used to store the extended application states and will be referenced by the DtVrfE...
Definition: vrfExtendedApplicationSettings.h:29
makVrf::DtVrfExtendedApplicationSettingsData::myDateAndTimeOfDayFormat
std::string myDateAndTimeOfDayFormat
Definition: vrfExtendedApplicationSettings.h:204
makVrf::DtVrfExtendedApplicationSettingsData::mySimQueryUpdateTime
double mySimQueryUpdateTime
Definition: vrfExtendedApplicationSettings.h:214
makVrf::DtVrfExtendedApplicationSettingsData::Flags
Flags
Definition: vrfExtendedApplicationSettings.h:32
DT_DLL_VRFGUICORE
#define DT_DLL_VRFGUICORE
Contains DLL export macros.
Definition: vrfGuiCore.h:25
makVrf::DtVrfExtendedApplicationSettings
The DtVrfExtendedApplicationSettings class will use the DtVrfGuiApplicationSettings class to keep a f...
Definition: vrfExtendedApplicationSettings.h:238
DtDisplayUnitsSettingsManager.h
Contains the DtDisplayUnitsSettingsManager class declaration.
makVrf::DtVrfGuiApplicationSetting
Definition: vrfGuiApplicationSettings.h:37
makVrf::DtVrfExtendedApplicationSettings::signal_searchBarVisibilityChanged
boost::signals2::signal< void(bool)> signal_searchBarVisibilityChanged
Signal sent when the search bar hide/show changes. Flag is true if shown.
Definition: vrfExtendedApplicationSettings.h:386
makVrf::DtVrfExtendedApplicationSettingsData::myAllowChangingOfExtendedLabels
bool myAllowChangingOfExtendedLabels
Definition: vrfExtendedApplicationSettings.h:208
makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreated
std::map< std::string, std::vector< std::string > > myRecentlyCreated
Definition: vrfExtendedApplicationSettings.h:222
makVrf::DtVrfExtendedApplicationSettingsData::myQtDesignerLocation
std::string myQtDesignerLocation
Definition: vrfExtendedApplicationSettings.h:220
makVrf::DtVrfExtendedApplicationSettingsData::myFlags
int myFlags
Definition: vrfExtendedApplicationSettings.h:203
makVrf::DtVrfExtendedApplicationSettings::myDe
makVrv::DtDe & myDe
Definition: vrfExtendedApplicationSettings.h:398
makVrf::DtVrfExtendedApplicationSettingsData::myCloseScenarioSendTimeoutRetry
double myCloseScenarioSendTimeoutRetry
The amount of time to wait before sending close message again if no response from back-end (default 1...
Definition: vrfExtendedApplicationSettings.h:232
makVrf::DtVrfExtendedApplicationSettingsData::myCloseRetryCount
int myCloseRetryCount
Definition: vrfExtendedApplicationSettings.h:233
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellWidth
double myMaximumNavigationAreaCellWidth
Definition: vrfExtendedApplicationSettings.h:215
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultIconList
std::string myDefaultIconList
Definition: vrfExtendedApplicationSettings.h:226
makVrf::DtVrfExtendedApplicationSettingsData::myUseLocalTimezone
bool myUseLocalTimezone
Definition: vrfExtendedApplicationSettings.h:207
makVrf::DtVrfExtendedApplicationSettingsData::myPaletteItemsVisibilityMap
PaletteItemsVisibilityMap myPaletteItemsVisibilityMap
Definition: vrfExtendedApplicationSettings.h:212
vrfExtendedApplicationSettings.h
Contains makVrf::DtVrfExtendedApplicationSettings class.
makVrf::DtVrfExtendedApplicationSettings::signal_simQueryUpdateTimeChanged
boost::signals2::signal< void(double)> signal_simQueryUpdateTimeChanged
Signal when sim query update time changes.
Definition: vrfExtendedApplicationSettings.h:389
makVrf::DtVrfExtendedApplicationSettingsData::myAllowBackendShutdown
bool myAllowBackendShutdown
Separate flag out to make it easier to edit in file.
Definition: vrfExtendedApplicationSettings.h:229
makVrv::DtDe
The DtDe is the core component of any VR-Vantage application.
Definition: DtDe.h:69
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellLength
double myMaximumNavigationAreaCellLength
Definition: vrfExtendedApplicationSettings.h:216
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultLayoutSettingsFile
std::string myDefaultLayoutSettingsFile
Definition: vrfExtendedApplicationSettings.h:219
makVrf::DtVrfExtendedApplicationSettings::signal_defaultIconListChanged
boost::signals2::signal< void(std::string)> signal_defaultIconListChanged
Signal when the default icon list changed.
Definition: vrfExtendedApplicationSettings.h:392
makVrf::DtVrfExtendedApplicationSettingsData::myFormatsSet
std::string myFormatsSet
Definition: vrfExtendedApplicationSettings.h:206
makVrf::DtVrfExtendedApplicationSettingsData::myAsynchLoadBufferTime
double myAsynchLoadBufferTime
Definition: vrfExtendedApplicationSettings.h:217
makVrf::DtVrfExtendedApplicationSettingsData::myTimezone
std::string myTimezone
Definition: vrfExtendedApplicationSettings.h:205
makVrf::DtVrfExtendedApplicationSettingsData::PaletteItemsVisibilityMap
std::map< std::string, bool > PaletteItemsVisibilityMap
No longer used as of VRF 4.5, but, kept around for reading previous files.
Definition: vrfExtendedApplicationSettings.h:211
makVrf::DtVrfExtendedApplicationSettingsData::dataVersion
virtual int dataVersion()
Override in subclass to version data.
Definition: vrfExtendedApplicationSettings.h:197
Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)