VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtVrfExtendedApplicationSettings Class Reference

The DtVrfExtendedApplicationSettings class will use the DtVrfGuiApplicationSettings class to keep a flag of extended application state settings. More...

Inheritance diagram for makVrf::DtVrfExtendedApplicationSettings:
Inheritance graph
[legend]

Public Member Functions

 DtVrfExtendedApplicationSettings (makVrv::DtDe &)
virtual ~DtVrfExtendedApplicationSettings ()
virtual void setObserversPublished (bool)
 Set whether or not observers are to be published.
virtual bool observersPublished () const
virtual void setDoNotShowTellMeAboutFavorites (bool)
 Sets whether or not to show the tell me about favorites item.
virtual bool doNotShowTellMeAboutFavorites () const
virtual void setShowWeather (bool)
 Sets whether or not to show weather. This will simply show/hide the Weather overlay layer.
virtual bool showWeather () const
virtual void setShowCloudLayers (bool)
 Sets whether or not to show cloud layers. This will simply show/hide the Cloud Layers overlay layer.
virtual bool showCloudLayers () const
virtual void setWeatherAreaFilled (bool)
 Sets whether or not weather areas are unfilled.
virtual bool weatherAreaFilled () const
virtual void setShowNavigationAreas (bool)
 Sets whether or not to show all navigation areas that area currently used in the system.
virtual bool showNavigationAreas () const
virtual void setSaveScenarioToZipFile (bool)
 Whether or not to save the scenario to a zip file. Default is true.
virtual bool saveScenarioToZipFile () const
virtual void setAsynchLoadBufferTime (double d)
 Only in asynchronous IO mode – the buffer of time to use when closing a scenario and sending the load message for another to prevent potential message drop.
virtual double asynchLoadBufferTime () const
virtual void setShowProgressOnGenerationStart (bool b)
 Sets whether or not to show the navigation area generation progress dialog when generation starts.
virtual bool showProgressOnGenerationStart () const
virtual void setPaletteItemVisible (const std::string &item, bool)
 Sets whether or not palette panel items are shown/hidden.
virtual bool paletteItemVisible (const std::string &item, bool *keyExists=0) const
virtual void setDateAndTimeOfDayFormat (const std::string &)
 Sets the format for displaying the date/time of day as specified in Qt documentation.
virtual std::string dateAndTimeOfDayFormat () const
virtual void setTimezone (const std::string &)
 Timezone used for display.
virtual std::string timezone () const
virtual void setAllowChangingOfExtendedLabels (bool)
 Set to false to disallow the changing of the extended labels via the session options page. Default is true.
virtual bool allowChangingOfExtendedLabels () const
virtual void setShowFavoritesIcon (bool)
 Whether or not to show favorites icon on the entity palette (if supported). Default is false.
virtual bool showFavoritesIcon () const
virtual void setUseLocalTimezone (bool)
 Use local timezone for display. Default is false.
virtual bool useLocalTimezone () const
virtual void setHideSearchBars (bool)
 Hides search bars on filtered list views and list boxes. Will not hide on palettes.
virtual bool hideSearchBars () const
virtual void setSimQueryUpdateTime (double)
 For moving objects, what is the update time to look at for when to make the next data request for a location from the sim.
virtual double simQueryUpdateTime () const
virtual void setMaximumNavigationAreaCellSize (double length, double width)
 Maximum navigation area cell length/width. Default is 20km.
virtual void getMaximumNavigationAreaCellSize (double &length, double &width)
virtual void setDefaultLayoutSettingsFile (const std::string &)
 The default layout file to load when starting the application.
virtual std::string defaultLayoutSettingsFile () const
virtual void setQtDesignerLocation (const std::string &)
 The location of Qt designer. This is just the directory, not the actual application. designer will be appended to it.
virtual std::string qtDesignerLocation () const
virtual void setTemperatureUnits (DtVrfDisplayUnitsSettingsManager::TemperatureUnits units)
 Sets the units of temperature to use.
virtual
DtVrfDisplayUnitsSettingsManager::TemperatureUnits 
temperatureUnits () const
virtual void setTemperatureDecimals (int)
 Sets the decimals to display temperature units in.
virtual int temperatureDecimals () const
virtual void setCloseScenarioSendTimeoutRetry (double d)
 The amount of time to wait before sending close message again if no response from back-end (default 15 seconds)
virtual double closeScenarioSendTimeoutRetry () const
virtual void setCloseRetryCount (int)
 The number of times to attempt a close before giving up (default is 4)
virtual int closeRetryCount () const
virtual void setShowEchelonIdColumn (bool)
 Whether or not to show echelon id columns on echelon or embarkation widgets.
virtual bool showEchelonIdColumn () const
virtual bool filteredListsAreOrbatEnabled () const
 Whether or not filtered lists that show units and entities are ORBAT enabled.
virtual void setFilteredListsAreOrbatEnabled (bool)
virtual void setDefaultIconList (const std::string &)
 Sets the default icon list to show. If no icon list will show the visual model definition.
virtual const std::string & defaultIconList () const
virtual void setShowForceColor (bool)
 Whether or not to try and display the force color under the non-visual model definition icon.
virtual bool showForceColor () const
virtual void setNumberOfRecentlyCreatedItems (int)
 The number of items to keep on the recently created list. Default is 20.
virtual int numberOfRecentlyCreatedItems () const
virtual void addRecentlyCreated (const std::string &palette, const DtEntityMapperKey &)
 Adds this mapper key as a recently created key.
virtual bool isRecentlyCreated (const std::string &palette, const DtEntityMapperKey &) const
 Returns true if this item is recently created.
virtual void removeRecentlyCreated (const std::string &palette, const DtEntityMapperKey &)
 Removes as recently created.
virtual void removeAllRecentlyCreated (const std::string &palette)
 Removes all recently created.
virtual void setAllowBackendShutdown (bool)
 Whether or not to allow the back-end shutdown button to appear on the quit dialog (default is true)
virtual bool allowBackendShutdown () const
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static
DtVrfExtendedApplicationSettings
instance (makVrv::DtDe &de)
static void registerInstance (makVrv::DtDe &, DtVrfExtendedApplicationSettings *)

Public Attributes

boost::signal< void()> signal_extendedApplicationOptionsChanged
 Signal sent any time an option changes.
boost::signal< void(bool)> signal_searchBarVisibilityChanged
 Signal sent when the search bar hide/show changes. Flag is true if shown.
boost::signal< void(double)> signal_simQueryUpdateTimeChanged
 Signal when sim query update time changes.
boost::signal< void(std::string)> signal_defaultIconListChanged
 Signal when the default icon list changed.

Protected Member Functions

virtual void slot_activated ()

Protected Attributes

makVrv::DtDemyDe

Detailed Description

The DtVrfExtendedApplicationSettings class will use the DtVrfGuiApplicationSettings class to keep a flag of extended application state settings.

Constructor & Destructor Documentation

makVrf::DtVrfExtendedApplicationSettings::DtVrfExtendedApplicationSettings ( makVrv::DtDe )
virtual makVrf::DtVrfExtendedApplicationSettings::~DtVrfExtendedApplicationSettings ( )
virtual

Member Function Documentation

virtual void makVrf::DtVrfExtendedApplicationSettings::setObserversPublished ( bool  )
virtual

Set whether or not observers are to be published.

virtual bool makVrf::DtVrfExtendedApplicationSettings::observersPublished ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setDoNotShowTellMeAboutFavorites ( bool  )
virtual

Sets whether or not to show the tell me about favorites item.

virtual bool makVrf::DtVrfExtendedApplicationSettings::doNotShowTellMeAboutFavorites ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowWeather ( bool  )
virtual

Sets whether or not to show weather. This will simply show/hide the Weather overlay layer.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showWeather ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowCloudLayers ( bool  )
virtual

Sets whether or not to show cloud layers. This will simply show/hide the Cloud Layers overlay layer.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showCloudLayers ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setWeatherAreaFilled ( bool  )
virtual

Sets whether or not weather areas are unfilled.

If they are unfilled then the label of the weather area will also b shown under the weather icon

virtual bool makVrf::DtVrfExtendedApplicationSettings::weatherAreaFilled ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowNavigationAreas ( bool  )
virtual

Sets whether or not to show all navigation areas that area currently used in the system.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showNavigationAreas ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setSaveScenarioToZipFile ( bool  )
virtual

Whether or not to save the scenario to a zip file. Default is true.

virtual bool makVrf::DtVrfExtendedApplicationSettings::saveScenarioToZipFile ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setAsynchLoadBufferTime ( double  d)
virtual

Only in asynchronous IO mode – the buffer of time to use when closing a scenario and sending the load message for another to prevent potential message drop.

Default is 1 second.

virtual double makVrf::DtVrfExtendedApplicationSettings::asynchLoadBufferTime ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowProgressOnGenerationStart ( bool  b)
virtual

Sets whether or not to show the navigation area generation progress dialog when generation starts.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showProgressOnGenerationStart ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setPaletteItemVisible ( const std::string &  item,
bool   
)
virtual

Sets whether or not palette panel items are shown/hidden.

virtual bool makVrf::DtVrfExtendedApplicationSettings::paletteItemVisible ( const std::string &  item,
bool keyExists = 0 
) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setDateAndTimeOfDayFormat ( const std::string &  )
virtual

Sets the format for displaying the date/time of day as specified in Qt documentation.

Default is: MM/dd/yyyy hh:mm

virtual std::string makVrf::DtVrfExtendedApplicationSettings::dateAndTimeOfDayFormat ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setTimezone ( const std::string &  )
virtual

Timezone used for display.

virtual std::string makVrf::DtVrfExtendedApplicationSettings::timezone ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setAllowChangingOfExtendedLabels ( bool  )
virtual

Set to false to disallow the changing of the extended labels via the session options page. Default is true.

virtual bool makVrf::DtVrfExtendedApplicationSettings::allowChangingOfExtendedLabels ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowFavoritesIcon ( bool  )
virtual

Whether or not to show favorites icon on the entity palette (if supported). Default is false.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showFavoritesIcon ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setUseLocalTimezone ( bool  )
virtual

Use local timezone for display. Default is false.

virtual bool makVrf::DtVrfExtendedApplicationSettings::useLocalTimezone ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setHideSearchBars ( bool  )
virtual

Hides search bars on filtered list views and list boxes. Will not hide on palettes.

virtual bool makVrf::DtVrfExtendedApplicationSettings::hideSearchBars ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setSimQueryUpdateTime ( double  )
virtual

For moving objects, what is the update time to look at for when to make the next data request for a location from the sim.

Default is 1 second

virtual double makVrf::DtVrfExtendedApplicationSettings::simQueryUpdateTime ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setMaximumNavigationAreaCellSize ( double  length,
double  width 
)
virtual

Maximum navigation area cell length/width. Default is 20km.

virtual void makVrf::DtVrfExtendedApplicationSettings::getMaximumNavigationAreaCellSize ( double length,
double width 
)
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setDefaultLayoutSettingsFile ( const std::string &  )
virtual

The default layout file to load when starting the application.

virtual std::string makVrf::DtVrfExtendedApplicationSettings::defaultLayoutSettingsFile ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setQtDesignerLocation ( const std::string &  )
virtual

The location of Qt designer. This is just the directory, not the actual application. designer will be appended to it.

virtual std::string makVrf::DtVrfExtendedApplicationSettings::qtDesignerLocation ( ) const
virtual
static DtVrfExtendedApplicationSettings& makVrf::DtVrfExtendedApplicationSettings::instance ( makVrv::DtDe de)
static
static void makVrf::DtVrfExtendedApplicationSettings::registerInstance ( makVrv::DtDe ,
DtVrfExtendedApplicationSettings  
)
static
virtual void makVrf::DtVrfExtendedApplicationSettings::setTemperatureUnits ( DtVrfDisplayUnitsSettingsManager::TemperatureUnits  units)
virtual

Sets the units of temperature to use.

virtual DtVrfDisplayUnitsSettingsManager::TemperatureUnits makVrf::DtVrfExtendedApplicationSettings::temperatureUnits ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setTemperatureDecimals ( int  )
virtual

Sets the decimals to display temperature units in.

virtual int makVrf::DtVrfExtendedApplicationSettings::temperatureDecimals ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setCloseScenarioSendTimeoutRetry ( double  d)
virtual

The amount of time to wait before sending close message again if no response from back-end (default 15 seconds)

virtual double makVrf::DtVrfExtendedApplicationSettings::closeScenarioSendTimeoutRetry ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setCloseRetryCount ( int  )
virtual

The number of times to attempt a close before giving up (default is 4)

virtual int makVrf::DtVrfExtendedApplicationSettings::closeRetryCount ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowEchelonIdColumn ( bool  )
virtual

Whether or not to show echelon id columns on echelon or embarkation widgets.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showEchelonIdColumn ( ) const
virtual
virtual bool makVrf::DtVrfExtendedApplicationSettings::filteredListsAreOrbatEnabled ( ) const
virtual

Whether or not filtered lists that show units and entities are ORBAT enabled.

This is not true for all lists, but typically will include task, set, command lists. Default is on

virtual void makVrf::DtVrfExtendedApplicationSettings::setFilteredListsAreOrbatEnabled ( bool  )
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setDefaultIconList ( const std::string &  )
virtual

Sets the default icon list to show. If no icon list will show the visual model definition.

virtual const std::string& makVrf::DtVrfExtendedApplicationSettings::defaultIconList ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setShowForceColor ( bool  )
virtual

Whether or not to try and display the force color under the non-visual model definition icon.

virtual bool makVrf::DtVrfExtendedApplicationSettings::showForceColor ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::setNumberOfRecentlyCreatedItems ( int  )
virtual

The number of items to keep on the recently created list. Default is 20.

virtual int makVrf::DtVrfExtendedApplicationSettings::numberOfRecentlyCreatedItems ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::addRecentlyCreated ( const std::string &  palette,
const DtEntityMapperKey  
)
virtual

Adds this mapper key as a recently created key.

virtual bool makVrf::DtVrfExtendedApplicationSettings::isRecentlyCreated ( const std::string &  palette,
const DtEntityMapperKey  
) const
virtual

Returns true if this item is recently created.

virtual void makVrf::DtVrfExtendedApplicationSettings::removeRecentlyCreated ( const std::string &  palette,
const DtEntityMapperKey  
)
virtual

Removes as recently created.

virtual void makVrf::DtVrfExtendedApplicationSettings::removeAllRecentlyCreated ( const std::string &  palette)
virtual

Removes all recently created.

virtual void makVrf::DtVrfExtendedApplicationSettings::setAllowBackendShutdown ( bool  )
virtual

Whether or not to allow the back-end shutdown button to appear on the quit dialog (default is true)

virtual bool makVrf::DtVrfExtendedApplicationSettings::allowBackendShutdown ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettings::slot_activated ( )
protectedvirtual

Member Data Documentation

boost::signal<void ()> makVrf::DtVrfExtendedApplicationSettings::signal_extendedApplicationOptionsChanged

Signal sent any time an option changes.

boost::signal<void (bool)> makVrf::DtVrfExtendedApplicationSettings::signal_searchBarVisibilityChanged

Signal sent when the search bar hide/show changes. Flag is true if shown.

boost::signal<void (double)> makVrf::DtVrfExtendedApplicationSettings::signal_simQueryUpdateTimeChanged

Signal when sim query update time changes.

boost::signal<void (std::string)> makVrf::DtVrfExtendedApplicationSettings::signal_defaultIconListChanged

Signal when the default icon list changed.

makVrv::DtDe& makVrf::DtVrfExtendedApplicationSettings::myDe
protected

The documentation for this class was generated from the following file:

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)