VR-Forces 5.0.3 Developer's Guide
 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) 2022 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <vrfGuiCore/vrfGuiCore.h>
13 #include <vrfGuiCore/vrfGuiApplicationSettings.h>
14 #include <vrfGuiCore/entityMapperKey.h>
15 #include <vrfGuiCore/vrfExtendedApplicationSettings.h>
16 #include <vrfGuiCore/vrfDisplayUnitsSettingsManager.h>
17 #include <vrvCore/DtDisplayUnitsSettingsManager.h>
18 
19 #include <set>
20 
21 namespace makVrv
22 {
23  class DtDe;
24 }
25 
26 namespace makVrf
27 {
28 
31  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettingsData : public DtVrfGuiApplicationSetting
32  {
33  protected:
34 
35  enum Flags
36  {
37  ObserversPublished = 0x00000001,
38  DoNotShowMeTellMeAboutFavorites = 0x00000002,
39  ShowWeather = 0x00000004,
40  ShowNavigationAreas = 0x00000008,
41  ShowNavigationProgress = 0x00000010,
42  SaveScenarioToZipFile = 0x00000020,
43  WeatherAreaUnfilled = 0x00000040,
44  ShowEchelonIdColumn = 0x00000080,
45  FilteredListsAreOrbatEnabled = 0x00000100,
46  ShowFavoritesIcon = 0x00000400,
47  ShowForceColor = 0x00000800,
48  ShowCloudLayers = 0x00001000,
49  HideSearchBars = 0x00002000,
50  Defaults = ObserversPublished | ShowWeather | ShowCloudLayers | ShowNavigationProgress | SaveScenarioToZipFile | FilteredListsAreOrbatEnabled | ShowForceColor
51  };
52 
53  public:
54 
55  DtVrfExtendedApplicationSettingsData( makVrv::DtDe* = 0 );
56  DtVrfExtendedApplicationSettingsData( const DtVrfExtendedApplicationSettingsData& );
57 
58  virtual ~DtVrfExtendedApplicationSettingsData();
59 
61  virtual void setObserversPublished(bool);
62  virtual bool observersPublished() const;
63 
65  virtual void setDoNotShowTellMeAboutFavorites(bool);
66  virtual bool doNotShowTellMeAboutFavorites() const;
67 
71  virtual void setDateAndTimeOfDayFormat(const std::string&);
72  virtual std::string dateAndTimeOfDayFormat() const;
73 
75  virtual void setTimezone(const std::string&);
76  virtual std::string timezone() const;
77 
79  virtual void setFormatsSet(const std::string&);
80  virtual std::string formatsSet() const;
81 
83  virtual void setHideSearchBars(bool);
84  virtual bool hideSearchBars() const;
85 
87  virtual void setShowWeather(bool);
88  virtual bool showWeather() const;
89 
91  virtual void setShowCloudLayers(bool);
92  virtual bool showCloudLayers() const;
93 
96  virtual void setWeatherAreaFilled(bool);
97  virtual bool weatherAreaFilled() const;
98 
101  virtual void setAsynchLoadBufferTime(double d);
102  virtual double asynchLoadBufferTime() const;
103 
105  virtual void setSaveScenarioToZipFile(bool);
106  virtual bool saveScenarioToZipFile() const;
107 
109  virtual void setShowFavoritesIcon(bool);
110  virtual bool showFavoritesIcon() const;
111 
113  virtual void setShowNavigationAreas(bool);
114  virtual bool showNavigationAreas() const;
115 
118  virtual void setSimQueryUpdateTime(double);
119  virtual double simQueryUpdateTime() const;
120 
122  virtual void setObjectConsoleBufferSize( int size );
123  virtual int objectConsoleBufferSize() const;
124 
126  virtual void setMaximumNavigationAreaCellSize(double length, double width);
127  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
128 
130  void setShowProgressOnGenerationStart(bool b);
131  bool showProgressOnGenerationStart() const;
132 
134  virtual void setUseLocalTimezone(bool);
135  virtual bool useLocalTimezone() const;
136 
138  virtual void setNumberOfRecentlyCreatedItems(int);
139  virtual int numberOfRecentlyCreatedItems() const;
140 
142  virtual void addRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
143 
145  virtual bool isRecentlyCreated(const std::string& palette, const DtEntityMapperKey&) const;
146 
148  virtual void removeRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
149 
151  virtual void removeAllRecentlyCreated(const std::string& palette);
152 
154  virtual DtVrfGuiApplicationSetting* clone() const;
155 
157  virtual std::string classType() const;
158 
160  virtual void write(boost::archive::xml_oarchive& out, const unsigned int);
161  virtual void read(boost::archive::xml_iarchive& in, const unsigned int);
162 
164  virtual void setAllowChangingOfExtendedLabels(bool);
165  virtual bool allowChangingOfExtendedLabels() const;
166 
169  virtual void setDefaultLayoutSettingsFile(const std::string&);
170  virtual std::string defaultLayoutSettingsFile() const;
171 
173  virtual void setQtDesignerLocation(const std::string&);
174  virtual std::string qtDesignerLocation() const;
175 
177  virtual void setShowEchelonIdColumn(bool);
178  virtual bool showEchelonIdColumn() const;
179 
182  virtual bool filteredListsAreOrbatEnabled() const;
183  virtual void setFilteredListsAreOrbatEnabled(bool);
184 
186  virtual void setDefaultIconList(const std::string&);
187  virtual const std::string& defaultIconList() const;
188 
190  virtual void setShowForceColor(bool);
191  virtual bool showForceColor() const;
192 
194  virtual void setAllowBackendShutdown(bool);
195  virtual bool allowBackendShutdown() const;
196 
198  virtual void setCloseScenarioSendTimeoutRetry(double d);
199  virtual double closeScenarioSendTimeoutRetry() const;
200 
202  virtual void setCloseRetryCount(int);
203  virtual int closeRetryCount() const;
204 
205  virtual int dataVersion() { return 23; };
206 
207  protected:
208 
209  virtual void setFlag( Flags, bool );
210 
211  protected:
212 
213  int myFlags;
214 
215  std::string myDateAndTimeOfDayFormat;
216  std::string myTimezone;
217  std::string myFormatsSet;
218  bool myUseLocalTimezone;
219  bool myAllowChangingOfExtendedLabels;
220 
222  typedef std::map<std::string, bool> PaletteItemsVisibilityMap;
223  PaletteItemsVisibilityMap myPaletteItemsVisibilityMap;
224 
225  double mySimQueryUpdateTime;
226  int myObjectConsoleBufferSize;
227 
228  double myMaximumNavigationAreaCellWidth;
229  double myMaximumNavigationAreaCellLength;
230  double myAsynchLoadBufferTime;
231 
232  std::string myDefaultLayoutSettingsFile;
233  std::string myQtDesignerLocation;
234 
235  std::map<std::string, std::vector<std::string> > myRecentlyCreated;
236  std::map<std::string, std::set<std::string> > myRecentlyCreatedSet;
237  int myNumberOfRecentlyCreated;
238 
239  std::string myDefaultIconList;
240 
242  bool myAllowBackendShutdown;
243 
245  double myCloseScenarioSendTimeoutRetry;
246  int myCloseRetryCount;
247 
248  };
249 
250 
253  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettings : public makVrv::DtVirtualBaseClass
254  {
255  public:
256 
257  DtVrfExtendedApplicationSettings( makVrv::DtDe& );
258 
259  virtual ~DtVrfExtendedApplicationSettings();
260 
262  virtual void setObserversPublished(bool);
263  virtual bool observersPublished() const;
264 
266  virtual void setDoNotShowTellMeAboutFavorites(bool);
267  virtual bool doNotShowTellMeAboutFavorites() const;
268 
270  virtual void setShowWeather(bool);
271  virtual bool showWeather() const;
272 
274  virtual void setShowCloudLayers(bool);
275  virtual bool showCloudLayers() const;
276 
279  virtual void setWeatherAreaFilled(bool);
280  virtual bool weatherAreaFilled() const;
281 
283  virtual void setShowNavigationAreas(bool);
284  virtual bool showNavigationAreas() const;
285 
287  virtual void setSaveScenarioToZipFile(bool);
288  virtual bool saveScenarioToZipFile() const;
289 
292  virtual void setAsynchLoadBufferTime(double d);
293  virtual double asynchLoadBufferTime() const;
294 
296  virtual void setShowProgressOnGenerationStart(bool b);
297  virtual bool showProgressOnGenerationStart() const;
298 
300  virtual void setPaletteItemVisible(const std::string& item , bool);
301  virtual bool paletteItemVisible(const std::string& item, bool* keyExists = 0) const;
302 
306  virtual void setDateAndTimeOfDayFormat(const std::string&);
307  virtual std::string dateAndTimeOfDayFormat() const;
308 
310  virtual void setTimezone(const std::string&);
311  virtual std::string timezone() const;
312 
314  virtual void setFormatSets(const std::string&);
315  virtual std::string formatSets() const;
316 
318  virtual void setAllowChangingOfExtendedLabels(bool);
319  virtual bool allowChangingOfExtendedLabels() const;
320 
322  virtual void setShowFavoritesIcon(bool);
323  virtual bool showFavoritesIcon() const;
324 
326  virtual void setUseLocalTimezone(bool);
327  virtual bool useLocalTimezone() const;
328 
330  virtual void setHideSearchBars(bool);
331  virtual bool hideSearchBars() const;
332 
335  virtual void setSimQueryUpdateTime(double);
336  virtual double simQueryUpdateTime() const;
337 
339  virtual void setObjectConsoleBufferSize( int size );
340  virtual int objectConsoleBufferSize() const;
341 
343  virtual void setMaximumNavigationAreaCellSize(double length, double width);
344  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
345 
347  virtual void setDefaultLayoutSettingsFile(const std::string&);
348  virtual std::string defaultLayoutSettingsFile() const;
349 
351  virtual void setQtDesignerLocation(const std::string&);
352  virtual std::string qtDesignerLocation() const;
353 
354  static DtVrfExtendedApplicationSettings& instance( makVrv::DtDe& de );
355  static void registerInstance(makVrv::DtDe&, DtVrfExtendedApplicationSettings*);
356 
358  virtual void setCloseScenarioSendTimeoutRetry(double d);
359  virtual double closeScenarioSendTimeoutRetry() const;
360 
362  virtual void setCloseRetryCount(int);
363  virtual int closeRetryCount() const;
364 
366  virtual void setShowEchelonIdColumn(bool);
367  virtual bool showEchelonIdColumn() const;
368 
371  virtual bool filteredListsAreOrbatEnabled() const;
372  virtual void setFilteredListsAreOrbatEnabled(bool);
373 
375  virtual void setDefaultIconList(const std::string&);
376  virtual const std::string& defaultIconList() const;
377 
379  virtual void setShowForceColor(bool);
380  virtual bool showForceColor() const;
381 
383  virtual void setNumberOfRecentlyCreatedItems(int);
384  virtual int numberOfRecentlyCreatedItems() const;
385 
387  virtual void addRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
388 
390  virtual bool isRecentlyCreated(const std::string& palette, const DtEntityMapperKey&) const;
391 
393  virtual void removeRecentlyCreated(const std::string& palette, const DtEntityMapperKey&);
394 
396  virtual void removeAllRecentlyCreated(const std::string& palette);
397 
399  virtual void setAllowBackendShutdown(bool);
400  virtual bool allowBackendShutdown() const;
401 
403  boost::signals2::signal<void ()> signal_extendedApplicationOptionsChanged;
404 
406  boost::signals2::signal<void (bool)> signal_searchBarVisibilityChanged;
407 
409  boost::signals2::signal<void (double)> signal_simQueryUpdateTimeChanged;
410 
412  boost::signals2::signal<void (double)> signal_objectConsoleBufferSizeChanged;
413 
415  boost::signals2::signal<void (std::string)> signal_defaultIconListChanged;
416 
417  protected:
418 
419  virtual void slot_activated();
420 
421  protected:
422 
423  makVrv::DtDe& myDe;
424 
425  };
426 
427 }
makVrf::DtEntityMapperKey
Definition: entityMapperKey.h:23
makVrv::DtVirtualBaseClass
Virtual base class. Allows for RTTI and proper virtual destruction. Used by Creators, Factories, Providers, Assemblers and User Interfaces.
Definition: DtVirtualBaseClass.h:19
makVrf::DtVrfExtendedApplicationSettings::signal_extendedApplicationOptionsChanged
boost::signals2::signal< void()> signal_extendedApplicationOptionsChanged
Signal sent any time an option changes.
Definition: vrfExtendedApplicationSettings.h:403
makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreatedSet
std::map< std::string, std::set< std::string > > myRecentlyCreatedSet
Definition: vrfExtendedApplicationSettings.h:236
makVrf::DtVrfExtendedApplicationSettingsData::myNumberOfRecentlyCreated
int myNumberOfRecentlyCreated
Definition: vrfExtendedApplicationSettings.h:237
makVrf::DtVrfExtendedApplicationSettingsData
This class will be used to store the extended application states and will be referenced by the DtVrfE...
Definition: vrfExtendedApplicationSettings.h:31
makVrf::DtVrfExtendedApplicationSettingsData::myObjectConsoleBufferSize
int myObjectConsoleBufferSize
Definition: vrfExtendedApplicationSettings.h:226
size
voidpf void uLong size
Definition: ioapi.h:39
makVrf::DtVrfExtendedApplicationSettingsData::myDateAndTimeOfDayFormat
std::string myDateAndTimeOfDayFormat
Definition: vrfExtendedApplicationSettings.h:215
makVrf::DtVrfExtendedApplicationSettingsData::mySimQueryUpdateTime
double mySimQueryUpdateTime
Definition: vrfExtendedApplicationSettings.h:225
makVrf::DtVrfExtendedApplicationSettingsData::Flags
Flags
Definition: vrfExtendedApplicationSettings.h:35
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:253
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:406
makVrf::DtVrfExtendedApplicationSettingsData::myAllowChangingOfExtendedLabels
bool myAllowChangingOfExtendedLabels
Definition: vrfExtendedApplicationSettings.h:219
makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreated
std::map< std::string, std::vector< std::string > > myRecentlyCreated
Definition: vrfExtendedApplicationSettings.h:235
makVrf::DtVrfExtendedApplicationSettings::signal_objectConsoleBufferSizeChanged
boost::signals2::signal< void(double)> signal_objectConsoleBufferSizeChanged
Signal when object console buffer size changes.
Definition: vrfExtendedApplicationSettings.h:412
makVrf::DtVrfExtendedApplicationSettingsData::myQtDesignerLocation
std::string myQtDesignerLocation
Definition: vrfExtendedApplicationSettings.h:233
makVrf::DtVrfExtendedApplicationSettingsData::myFlags
int myFlags
Definition: vrfExtendedApplicationSettings.h:213
makVrf::DtVrfExtendedApplicationSettings::myDe
makVrv::DtDe & myDe
Definition: vrfExtendedApplicationSettings.h:423
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:245
makVrf::DtVrfExtendedApplicationSettingsData::myCloseRetryCount
int myCloseRetryCount
Definition: vrfExtendedApplicationSettings.h:246
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellWidth
double myMaximumNavigationAreaCellWidth
Definition: vrfExtendedApplicationSettings.h:228
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultIconList
std::string myDefaultIconList
Definition: vrfExtendedApplicationSettings.h:239
makVrf::DtVrfExtendedApplicationSettingsData::myUseLocalTimezone
bool myUseLocalTimezone
Definition: vrfExtendedApplicationSettings.h:218
makVrf::DtVrfExtendedApplicationSettingsData::myPaletteItemsVisibilityMap
PaletteItemsVisibilityMap myPaletteItemsVisibilityMap
Definition: vrfExtendedApplicationSettings.h:223
vrfExtendedApplicationSettings.h
Contains the makVrf::DtVrfExtendedApplicationSettings class declaration.
makVrf::DtVrfExtendedApplicationSettings::signal_simQueryUpdateTimeChanged
boost::signals2::signal< void(double)> signal_simQueryUpdateTimeChanged
Signal when sim query update time changes.
Definition: vrfExtendedApplicationSettings.h:409
makVrf::DtVrfExtendedApplicationSettingsData::myAllowBackendShutdown
bool myAllowBackendShutdown
Separate flag out to make it easier to edit in file.
Definition: vrfExtendedApplicationSettings.h:242
makVrv::DtDe
The DtDe is the core component of any VR-Vantage application. It owns a DtRenderer, DtDeCommunicator, as well as a DtDisplay and other things.
Definition: DtDe.h:70
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellLength
double myMaximumNavigationAreaCellLength
Definition: vrfExtendedApplicationSettings.h:229
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultLayoutSettingsFile
std::string myDefaultLayoutSettingsFile
Definition: vrfExtendedApplicationSettings.h:232
makVrf::DtVrfExtendedApplicationSettings::signal_defaultIconListChanged
boost::signals2::signal< void(std::string)> signal_defaultIconListChanged
Signal when the default icon list changed.
Definition: vrfExtendedApplicationSettings.h:415
makVrf::DtVrfExtendedApplicationSettingsData::myFormatsSet
std::string myFormatsSet
Definition: vrfExtendedApplicationSettings.h:217
makVrf::DtVrfExtendedApplicationSettingsData::myAsynchLoadBufferTime
double myAsynchLoadBufferTime
Definition: vrfExtendedApplicationSettings.h:230
makVrf::DtVrfExtendedApplicationSettingsData::myTimezone
std::string myTimezone
Definition: vrfExtendedApplicationSettings.h:216
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:222
makVrf::DtVrfExtendedApplicationSettingsData::dataVersion
virtual int dataVersion()
Override in subclass to version data.
Definition: vrfExtendedApplicationSettings.h:205
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)