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	setPaletteItemVisible (const std::string &item, bool)
	Sets whether or not palette panel items are shown/hidden.
virtual bool	paletteItemVisible (const std::string &item) 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	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	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 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, DtShowWeather = 0x00000004, Defaults = ObserversPublished | DtShowWeather }
typedef std::map< std::string, bool >	PaletteItemsVisibilityMap

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
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

Member Enumeration Documentation

enum makVrf::DtVrfExtendedApplicationSettingsData::Flags

protected

Enumerator:

ObserversPublished
DoNotShowMeTellMeAboutFavorites
DtShowWeather
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::setPaletteItemVisible ( const std::string &  item, bool    )

virtual

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

virtual bool makVrf::DtVrfExtendedApplicationSettingsData::paletteItemVisible ( const std::string &  item ) 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::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

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::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 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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfGuiCore/vrfExtendedApplicationSettings.h