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:

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	setHideSearchBars (bool)
	Hides search bars on filtered list views and list boxes. Will not hide on palettes.
virtual bool	hideSearchBars () 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	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	setShowFavoritesIcon (bool)
	Whether or not to show favorites icon on the entity palette (if supported). Default is false.
virtual bool	showFavoritesIcon () 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 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 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	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	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	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
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 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, ShowEchelonIdColumn = 0x00000080,   FilteredListsAreOrbatEnabled = 0x00000100, ShowFavoritesIcon = 0x00000400, ShowForceColor = 0x00000800, ShowCloudLayers = 0x00001000,   HideSearchBars = 0x00002000, Defaults = ObserversPublished | ShowWeather | ShowCloudLayers | ShowNavigationProgress | SaveScenarioToZipFile | FilteredListsAreOrbatEnabled | ShowForceColor }
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
std::string	myQtDesignerLocation
DtVrfDisplayUnitsSettingsManager::TemperatureUnits	myTemperatureUnits
int	myTemperatureDecimals
std::map< std::string, std::vector< std::string > >	myRecentlyCreated
std::map< std::string, std::set< std::string > >	myRecentlyCreatedSet
int	myNumberOfRecentlyCreated
std::string	myDefaultIconList
bool	myAllowBackendShutdown
	Separate flag out to make it easier to edit in file.
double	myCloseScenarioSendTimeoutRetry
	The amount of time to wait before sending close message again if no response from back-end (default 15 seconds)
int	myCloseRetryCount
Protected Attributes inherited from makVrf::DtVrfGuiApplicationSetting
makVrv::DtDe *	myDe

Additional Inherited Members
Static Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
template<typename T >
static std::string	theClassType ()
template<typename T >
static DtVrfGuiApplicationSetting *	create (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

typedef std::map<std::string, bool> makVrf::DtVrfExtendedApplicationSettingsData::PaletteItemsVisibilityMap

protected

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

Member Enumeration Documentation

enum makVrf::DtVrfExtendedApplicationSettingsData::Flags

protected

Enumerator:

ObserversPublished
DoNotShowMeTellMeAboutFavorites
ShowWeather
ShowNavigationAreas
ShowNavigationProgress
SaveScenarioToZipFile
WeatherAreaUnfilled
ShowEchelonIdColumn
FilteredListsAreOrbatEnabled
ShowFavoritesIcon
ShowForceColor
ShowCloudLayers
HideSearchBars
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::setHideSearchBars ( bool  )

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::hideSearchBars ( ) 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::setShowCloudLayers ( bool  )

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showCloudLayers ( ) 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::setShowFavoritesIcon ( bool  )

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showFavoritesIcon ( ) 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 void makVrf::DtVrfExtendedApplicationSettingsData::setNumberOfRecentlyCreatedItems ( int  )

virtual

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

virtual int makVrf::DtVrfExtendedApplicationSettingsData::numberOfRecentlyCreatedItems ( ) const

virtual

virtual void makVrf::DtVrfExtendedApplicationSettingsData::addRecentlyCreated ( const std::string &  palette, const DtEntityMapperKey &    )

virtual

Adds this mapper key as a recently created key.

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

virtual

Returns true if this item is recently created.

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

virtual

Removes as recently created.

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

virtual

Removes all recently created.

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

Implements makVrf::DtVrfGuiApplicationSetting.

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::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::DtVrfExtendedApplicationSettingsData::qtDesignerLocation ( ) 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 void makVrf::DtVrfExtendedApplicationSettingsData::setShowEchelonIdColumn ( bool  )

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showEchelonIdColumn ( ) const

virtual

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::setFilteredListsAreOrbatEnabled ( bool  )

virtual

virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::defaultIconList ( ) const

virtual

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

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::showForceColor ( ) const

virtual

virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::allowBackendShutdown ( ) const

virtual

virtual void makVrf::DtVrfExtendedApplicationSettingsData::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::DtVrfExtendedApplicationSettingsData::closeScenarioSendTimeoutRetry ( ) const

virtual

virtual void makVrf::DtVrfExtendedApplicationSettingsData::setCloseRetryCount ( int  )

virtual

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

virtual int makVrf::DtVrfExtendedApplicationSettingsData::closeRetryCount ( ) 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

std::string makVrf::DtVrfExtendedApplicationSettingsData::myQtDesignerLocation

protected

DtVrfDisplayUnitsSettingsManager::TemperatureUnits makVrf::DtVrfExtendedApplicationSettingsData::myTemperatureUnits

protected

int makVrf::DtVrfExtendedApplicationSettingsData::myTemperatureDecimals

protected

std::map<std::string, std::vector<std::string> > makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreated

protected

std::map<std::string, std::set<std::string> > makVrf::DtVrfExtendedApplicationSettingsData::myRecentlyCreatedSet

protected

int makVrf::DtVrfExtendedApplicationSettingsData::myNumberOfRecentlyCreated

protected

std::string makVrf::DtVrfExtendedApplicationSettingsData::myDefaultIconList

protected

bool makVrf::DtVrfExtendedApplicationSettingsData::myAllowBackendShutdown

protected

Separate flag out to make it easier to edit in file.

double makVrf::DtVrfExtendedApplicationSettingsData::myCloseScenarioSendTimeoutRetry

protected

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

int makVrf::DtVrfExtendedApplicationSettingsData::myCloseRetryCount

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/vrfExtendedApplicationSettings.h