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

This class will be used to store the extended application states and will be referenced by the DtVrfExtendedApplicationSettings class. More...

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

Public Member Functions

 DtVrfExtendedApplicationSettingsData (makVrv::DtDe *=0)
 DtVrfExtendedApplicationSettingsData (const DtVrfExtendedApplicationSettingsData &)
virtual ~DtVrfExtendedApplicationSettingsData ()
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 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 setShowWeather (bool)
 Sets whether or not to show weather. This will simply show/hide the Weather overlay layer.
virtual bool showWeather () const
virtual void setWeatherAreaFilled (bool)
 Sets whether or not weather areas are unfilled.
virtual bool weatherAreaFilled () 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 setSaveScenarioToZipFile (bool)
 Whether or not to save the scenario to a zip file. Default is true.
virtual bool saveScenarioToZipFile () 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 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)
void setShowProgressOnGenerationStart (bool b)
 Sets whether or not to show the navigation area generation progress dialog when generation starts.
bool showProgressOnGenerationStart () const
virtual void setUseLocalTimezone (bool)
 Use local timezone for display. Default is false.
virtual bool useLocalTimezone () const
virtual
DtVrfGuiApplicationSetting
clone () const
 Clone of this object.
virtual std::string classType () const
 Must implement to return unique name of class.
virtual void write (boost::archive::xml_oarchive &out, const unsigned int)
 Override to read/write settings.
virtual void read (boost::archive::xml_iarchive &in, const unsigned int)
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 setDefaultLayoutSettingsFile (const std::string &)
 The default layout file to load when starting the application.
virtual std::string defaultLayoutSettingsFile () 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 int dataVersion ()
 Override in subclass to version data.
- Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
 DtVrfGuiApplicationSetting (makVrv::DtDe *=0)
 DtVrfGuiApplicationSetting (const DtVrfGuiApplicationSetting &)
virtual ~DtVrfGuiApplicationSetting ()

Protected Types

enum  Flags {
  ObserversPublished = 0x00000001, DoNotShowMeTellMeAboutFavorites = 0x00000002, ShowWeather = 0x00000004, ShowNavigationAreas = 0x00000008,
  ShowNavigationProgress = 0x00000010, SaveScenarioToZipFile = 0x00000020, WeatherAreaUnfilled = 0x00000040, Defaults = ObserversPublished | ShowWeather | ShowNavigationProgress | SaveScenarioToZipFile
}
typedef std::map< std::string,
bool
PaletteItemsVisibilityMap
 No longer used as of VRF 4.5, but, kept around for reading previous files.

Protected Member Functions

virtual void setFlag (Flags, bool)
- Protected Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes

int myFlags
std::string myDateAndTimeOfDayFormat
std::string myTimezone
bool myUseLocalTimezone
bool myAllowChangingOfExtendedLabels
PaletteItemsVisibilityMap myPaletteItemsVisibilityMap
double mySimQueryUpdateTime
double myMaximumNavigationAreaCellWidth
double myMaximumNavigationAreaCellLength
double myAsynchLoadBufferTime
std::string myDefaultLayoutSettingsFile
DtVrfDisplayUnitsSettingsManager::TemperatureUnits myTemperatureUnits
int myTemperatureDecimals
- Protected Attributes inherited from makVrf::DtVrfGuiApplicationSetting
makVrv::DtDemyDe

Additional Inherited Members

- Static Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
template<typename T >
static std::string theClassType ()
template<typename T >
static DtVrfGuiApplicationSettingcreate (makVrv::DtDe &de)

Detailed Description

This class will be used to store the extended application states and will be referenced by the DtVrfExtendedApplicationSettings class.

Member Typedef Documentation

No longer used as of VRF 4.5, but, kept around for reading previous files.

Member Enumeration Documentation

Enumerator:
ObserversPublished 
DoNotShowMeTellMeAboutFavorites 
ShowWeather 
ShowNavigationAreas 
ShowNavigationProgress 
SaveScenarioToZipFile 
WeatherAreaUnfilled 
Defaults 

Constructor & Destructor Documentation

makVrf::DtVrfExtendedApplicationSettingsData::DtVrfExtendedApplicationSettingsData ( makVrv::DtDe = 0)
makVrf::DtVrfExtendedApplicationSettingsData::DtVrfExtendedApplicationSettingsData ( const DtVrfExtendedApplicationSettingsData )
virtual makVrf::DtVrfExtendedApplicationSettingsData::~DtVrfExtendedApplicationSettingsData ( )
virtual

Member Function Documentation

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

Set whether or not observers are to be published.

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

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::doNotShowTellMeAboutFavorites ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::dateAndTimeOfDayFormat ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setTimezone ( const std::string &  )
virtual

Timezone used for display.

virtual std::string makVrf::DtVrfExtendedApplicationSettingsData::timezone ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setShowWeather ( bool  )
virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showWeather ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::weatherAreaFilled ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::asynchLoadBufferTime ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setSaveScenarioToZipFile ( bool  )
virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::saveScenarioToZipFile ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setShowNavigationAreas ( bool  )
virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showNavigationAreas ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::simQueryUpdateTime ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setMaximumNavigationAreaCellSize ( double  length,
double  width 
)
virtual

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

virtual void makVrf::DtVrfExtendedApplicationSettingsData::getMaximumNavigationAreaCellSize ( double length,
double width 
)
virtual
void makVrf::DtVrfExtendedApplicationSettingsData::setShowProgressOnGenerationStart ( bool  b)

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

bool makVrf::DtVrfExtendedApplicationSettingsData::showProgressOnGenerationStart ( ) const
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setUseLocalTimezone ( bool  )
virtual

Use local timezone for display. Default is false.

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::useLocalTimezone ( ) const
virtual
virtual DtVrfGuiApplicationSetting* makVrf::DtVrfExtendedApplicationSettingsData::clone ( ) const
virtual

Clone of this object.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual std::string makVrf::DtVrfExtendedApplicationSettingsData::classType ( ) const
virtual

Must implement to return unique name of class.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedApplicationSettingsData::write ( boost::archive::xml_oarchive &  out,
const unsigned  int 
)
virtual

Override to read/write settings.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedApplicationSettingsData::read ( boost::archive::xml_iarchive &  in,
const unsigned  int 
)
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::allowChangingOfExtendedLabels ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setDefaultLayoutSettingsFile ( const std::string &  )
virtual

The default layout file to load when starting the application.

Note that setting this here will not effect whether or not the layout manager signals a change. Use the layout manager to signal a change in the default layout

virtual std::string makVrf::DtVrfExtendedApplicationSettingsData::defaultLayoutSettingsFile ( ) const
virtual
virtual void makVrf::DtVrfExtendedApplicationSettingsData::setTemperatureUnits ( DtVrfDisplayUnitsSettingsManager::TemperatureUnits  units)
virtual

Sets the units of temperature to use.

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

Sets the decimals to display temperature units in.

virtual int makVrf::DtVrfExtendedApplicationSettingsData::temperatureDecimals ( ) const
virtual
virtual int makVrf::DtVrfExtendedApplicationSettingsData::dataVersion ( )
inlinevirtual

Override in subclass to version data.

Reimplemented from makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedApplicationSettingsData::setFlag ( Flags  ,
bool   
)
protectedvirtual

Member Data Documentation

int makVrf::DtVrfExtendedApplicationSettingsData::myFlags
protected
std::string makVrf::DtVrfExtendedApplicationSettingsData::myDateAndTimeOfDayFormat
protected
std::string makVrf::DtVrfExtendedApplicationSettingsData::myTimezone
protected
bool makVrf::DtVrfExtendedApplicationSettingsData::myUseLocalTimezone
protected
bool makVrf::DtVrfExtendedApplicationSettingsData::myAllowChangingOfExtendedLabels
protected
PaletteItemsVisibilityMap makVrf::DtVrfExtendedApplicationSettingsData::myPaletteItemsVisibilityMap
protected
double makVrf::DtVrfExtendedApplicationSettingsData::mySimQueryUpdateTime
protected
double makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellWidth
protected
double makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellLength
protected
double makVrf::DtVrfExtendedApplicationSettingsData::myAsynchLoadBufferTime
protected
std::string makVrf::DtVrfExtendedApplicationSettingsData::myDefaultLayoutSettingsFile
protected
DtVrfDisplayUnitsSettingsManager::TemperatureUnits makVrf::DtVrfExtendedApplicationSettingsData::myTemperatureUnits
protected
int makVrf::DtVrfExtendedApplicationSettingsData::myTemperatureDecimals
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)