VR-Forces 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  ShowEchelonIdColumn = 0x00000080,
44  FilteredListsAreOrbatEnabled = 0x00000100,
45  ShowFavoritesIcon = 0x00000400,
46  ShowForceColor = 0x00000800,
47  HideSearchBars = 0x00002000,
48  Defaults = ShowWeather | ShowNavigationProgress | SaveScenarioToZipFile | FilteredListsAreOrbatEnabled | ShowForceColor | ShowFavoritesIcon
49  };
50 
51  public:
52 
53  DtVrfExtendedApplicationSettingsData( makVrv::DtDe* = 0 );
54  DtVrfExtendedApplicationSettingsData( const DtVrfExtendedApplicationSettingsData& );
55 
56  virtual ~DtVrfExtendedApplicationSettingsData();
57 
59  virtual void setObserversPublished(bool);
60  virtual bool observersPublished() const;
61 
63  virtual void setDoNotShowTellMeAboutFavorites(bool);
64  virtual bool doNotShowTellMeAboutFavorites() const;
65 
69  virtual void setDateAndTimeOfDayFormat(const std::string&);
70  virtual std::string dateAndTimeOfDayFormat() const;
71 
73  virtual void setTimezone(const std::string&);
74  virtual std::string timezone() const;
75 
77  virtual void setFormatsSet(const std::string&);
78  virtual std::string formatsSet() const;
79 
81  virtual void setHideSearchBars(bool);
82  virtual bool hideSearchBars() const;
83 
85  virtual void setShowWeather(bool);
86  virtual bool showWeather() const;
87 
90  virtual void setAsynchLoadBufferTime(double d);
91  virtual double asynchLoadBufferTime() const;
92 
94  virtual void setSaveScenarioToZipFile(bool);
95  virtual bool saveScenarioToZipFile() const;
96 
98  virtual void setShowFavoritesIcon(bool);
99  virtual bool showFavoritesIcon() const;
100 
102  virtual void setShowNavigationAreas(bool);
103  virtual bool showNavigationAreas() const;
104 
107  virtual void setSimQueryUpdateTime(double);
108  virtual double simQueryUpdateTime() const;
109 
111  virtual void setObjectConsoleBufferSize( int size );
112  virtual int objectConsoleBufferSize() const;
113 
115  virtual void setMaximumNavigationAreaCellSize(double length, double width);
116  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
117 
119  void setShowProgressOnGenerationStart(bool b);
120  bool showProgressOnGenerationStart() const;
121 
123  virtual void setUseLocalTimezone(bool);
124  virtual bool useLocalTimezone() const;
125 
127  virtual DtVrfGuiApplicationSetting* clone() const;
128 
130  virtual std::string classType() const;
131 
133  virtual void write(boost::archive::xml_oarchive& out, const unsigned int);
134  virtual void read(boost::archive::xml_iarchive& in, const unsigned int);
135 
137  virtual void setAllowChangingOfExtendedLabels(bool);
138  virtual bool allowChangingOfExtendedLabels() const;
139 
142  virtual void setDefaultLayoutSettingsFile(const std::string&);
143  virtual std::string defaultLayoutSettingsFile() const;
144 
146  virtual void setQtDesignerLocation(const std::string&);
147  virtual std::string qtDesignerLocation() const;
148 
150  virtual void setShowEchelonIdColumn(bool);
151  virtual bool showEchelonIdColumn() const;
152 
155  virtual bool filteredListsAreOrbatEnabled() const;
156  virtual void setFilteredListsAreOrbatEnabled(bool);
157 
159  virtual void setDefaultIconList(const std::string&);
160  virtual const std::string& defaultIconList() const;
161 
163  virtual void setShowForceColor(bool);
164  virtual bool showForceColor() const;
165 
167  virtual void setAllowBackendShutdown(bool);
168  virtual bool allowBackendShutdown() const;
169 
171  virtual void setCloseScenarioSendTimeoutRetry(double d);
172  virtual double closeScenarioSendTimeoutRetry() const;
173 
175  virtual void setCloseRetryCount(int);
176  virtual int closeRetryCount() const;
177 
178  virtual int dataVersion() { return 25; };
179 
180  protected:
181 
182  virtual void setFlag( Flags, bool );
183 
184  protected:
185 
186  int myFlags;
187 
188  std::string myDateAndTimeOfDayFormat;
189  std::string myTimezone;
190  std::string myFormatsSet;
191  bool myUseLocalTimezone;
192  bool myAllowChangingOfExtendedLabels;
193 
195  typedef std::map<std::string, bool> PaletteItemsVisibilityMap;
196  PaletteItemsVisibilityMap myPaletteItemsVisibilityMap;
197 
198  double mySimQueryUpdateTime;
199  int myObjectConsoleBufferSize;
200 
201  double myMaximumNavigationAreaCellWidth;
202  double myMaximumNavigationAreaCellLength;
203  double myAsynchLoadBufferTime;
204 
205  std::string myDefaultLayoutSettingsFile;
206  std::string myQtDesignerLocation;
207 
208  std::string myDefaultIconList;
209 
211  bool myAllowBackendShutdown;
212 
214  double myCloseScenarioSendTimeoutRetry;
215  int myCloseRetryCount;
216 
217  };
218 
219 
222  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettings : public makVrv::DtVirtualBaseClass
223  {
224  public:
225 
226  DtVrfExtendedApplicationSettings( makVrv::DtDe& );
227 
228  virtual ~DtVrfExtendedApplicationSettings();
229 
231  virtual void setObserversPublished(bool);
232  virtual bool observersPublished() const;
233 
235  virtual void setDoNotShowTellMeAboutFavorites(bool);
236  virtual bool doNotShowTellMeAboutFavorites() const;
237 
239  virtual void setShowWeather(bool);
240  virtual bool showWeather() const;
241 
243  virtual void setShowNavigationAreas(bool);
244  virtual bool showNavigationAreas() const;
245 
247  virtual void setSaveScenarioToZipFile(bool);
248  virtual bool saveScenarioToZipFile() const;
249 
252  virtual void setAsynchLoadBufferTime(double d);
253  virtual double asynchLoadBufferTime() const;
254 
256  virtual void setShowProgressOnGenerationStart(bool b);
257  virtual bool showProgressOnGenerationStart() const;
258 
260  virtual void setPaletteItemVisible(const std::string& item , bool);
261  virtual bool paletteItemVisible(const std::string& item, bool* keyExists = 0) const;
262 
266  virtual void setDateAndTimeOfDayFormat(const std::string&);
267  virtual std::string dateAndTimeOfDayFormat() const;
268 
270  virtual void setTimezone(const std::string&);
271  virtual std::string timezone() const;
272 
274  virtual void setFormatSets(const std::string&);
275  virtual std::string formatSets() const;
276 
278  virtual void setAllowChangingOfExtendedLabels(bool);
279  virtual bool allowChangingOfExtendedLabels() const;
280 
282  virtual void setShowFavoritesIcon(bool);
283  virtual bool showFavoritesIcon() const;
284 
286  virtual void setUseLocalTimezone(bool);
287  virtual bool useLocalTimezone() const;
288 
290  virtual void setHideSearchBars(bool);
291  virtual bool hideSearchBars() const;
292 
295  virtual void setSimQueryUpdateTime(double);
296  virtual double simQueryUpdateTime() const;
297 
299  virtual void setObjectConsoleBufferSize( int size );
300  virtual int objectConsoleBufferSize() const;
301 
303  virtual void setMaximumNavigationAreaCellSize(double length, double width);
304  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
305 
307  virtual void setDefaultLayoutSettingsFile(const std::string&);
308  virtual std::string defaultLayoutSettingsFile() const;
309 
311  virtual void setQtDesignerLocation(const std::string&);
312  virtual std::string qtDesignerLocation() const;
313 
314  static DtVrfExtendedApplicationSettings& instance( makVrv::DtDe& de );
315  static void registerInstance(makVrv::DtDe&, DtVrfExtendedApplicationSettings*);
316 
318  virtual void setCloseScenarioSendTimeoutRetry(double d);
319  virtual double closeScenarioSendTimeoutRetry() const;
320 
322  virtual void setCloseRetryCount(int);
323  virtual int closeRetryCount() const;
324 
326  virtual void setShowEchelonIdColumn(bool);
327  virtual bool showEchelonIdColumn() const;
328 
331  virtual bool filteredListsAreOrbatEnabled() const;
332  virtual void setFilteredListsAreOrbatEnabled(bool);
333 
335  virtual void setDefaultIconList(const std::string&);
336  virtual const std::string& defaultIconList() const;
337 
339  virtual void setShowForceColor(bool);
340  virtual bool showForceColor() const;
341 
343  virtual void setAllowBackendShutdown(bool);
344  virtual bool allowBackendShutdown() const;
345 
347  boost::signals2::signal<void ()> signal_extendedApplicationOptionsChanged;
348 
350  boost::signals2::signal<void (bool)> signal_searchBarVisibilityChanged;
351 
353  boost::signals2::signal<void (double)> signal_simQueryUpdateTimeChanged;
354 
356  boost::signals2::signal<void (double)> signal_objectConsoleBufferSizeChanged;
357 
359  boost::signals2::signal<void (std::string)> signal_defaultIconListChanged;
360 
361  protected:
362 
363  virtual void slot_activated();
364 
365  protected:
366 
367  makVrv::DtDe& myDe;
368 
369  };
370 
371 }
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:347
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:199
size
voidpf void uLong size
Definition: ioapi.h:39
makVrf::DtVrfExtendedApplicationSettingsData::myDateAndTimeOfDayFormat
std::string myDateAndTimeOfDayFormat
Definition: vrfExtendedApplicationSettings.h:188
makVrf::DtVrfExtendedApplicationSettingsData::mySimQueryUpdateTime
double mySimQueryUpdateTime
Definition: vrfExtendedApplicationSettings.h:198
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:222
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:350
makVrf::DtVrfExtendedApplicationSettingsData::myAllowChangingOfExtendedLabels
bool myAllowChangingOfExtendedLabels
Definition: vrfExtendedApplicationSettings.h:192
makVrf::DtVrfExtendedApplicationSettings::signal_objectConsoleBufferSizeChanged
boost::signals2::signal< void(double)> signal_objectConsoleBufferSizeChanged
Signal when object console buffer size changes.
Definition: vrfExtendedApplicationSettings.h:356
makVrf::DtVrfExtendedApplicationSettingsData::myQtDesignerLocation
std::string myQtDesignerLocation
Definition: vrfExtendedApplicationSettings.h:206
makVrf::DtVrfExtendedApplicationSettingsData::myFlags
int myFlags
Definition: vrfExtendedApplicationSettings.h:186
makVrf::DtVrfExtendedApplicationSettings::myDe
makVrv::DtDe & myDe
Definition: vrfExtendedApplicationSettings.h:367
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:214
makVrf::DtVrfExtendedApplicationSettingsData::myCloseRetryCount
int myCloseRetryCount
Definition: vrfExtendedApplicationSettings.h:215
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellWidth
double myMaximumNavigationAreaCellWidth
Definition: vrfExtendedApplicationSettings.h:201
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultIconList
std::string myDefaultIconList
Definition: vrfExtendedApplicationSettings.h:208
makVrf::DtVrfExtendedApplicationSettingsData::myUseLocalTimezone
bool myUseLocalTimezone
Definition: vrfExtendedApplicationSettings.h:191
makVrf::DtVrfExtendedApplicationSettingsData::myPaletteItemsVisibilityMap
PaletteItemsVisibilityMap myPaletteItemsVisibilityMap
Definition: vrfExtendedApplicationSettings.h:196
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:353
makVrv::vrvTacticalGraphicUtilities::length
DT_DLL_VRVCORE double length(const makVrv::DtCoordinateSystem &, const std::vector< DtVector > &vertices)
Returns the total distance of a segmented line defined by the provided vector of vertices. Coordinates are in local database coordinates. The coordinate system is used to convert between the local database coordinates and geocentric. All distance is in 2D – the Z value is ignored.
makVrf::DtVrfExtendedApplicationSettingsData::myAllowBackendShutdown
bool myAllowBackendShutdown
Separate flag out to make it easier to edit in file.
Definition: vrfExtendedApplicationSettings.h:211
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:72
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellLength
double myMaximumNavigationAreaCellLength
Definition: vrfExtendedApplicationSettings.h:202
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultLayoutSettingsFile
std::string myDefaultLayoutSettingsFile
Definition: vrfExtendedApplicationSettings.h:205
makVrf::DtVrfExtendedApplicationSettings::signal_defaultIconListChanged
boost::signals2::signal< void(std::string)> signal_defaultIconListChanged
Signal when the default icon list changed.
Definition: vrfExtendedApplicationSettings.h:359
makVrf::DtVrfExtendedApplicationSettingsData::myFormatsSet
std::string myFormatsSet
Definition: vrfExtendedApplicationSettings.h:190
makVrf::DtVrfExtendedApplicationSettingsData::myAsynchLoadBufferTime
double myAsynchLoadBufferTime
Definition: vrfExtendedApplicationSettings.h:203
makVrf::DtVrfExtendedApplicationSettingsData::myTimezone
std::string myTimezone
Definition: vrfExtendedApplicationSettings.h:189
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:195
makVrf::DtVrfExtendedApplicationSettingsData::dataVersion
virtual int dataVersion()
Override in subclass to version data.
Definition: vrfExtendedApplicationSettings.h:178
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)