makVrf::DtSharedVrfVrlApplicationSettings Class Reference

Class for holding extended settings that are communicated over the thread boundry. More...

Inheritance diagram for makVrf::DtSharedVrfVrlApplicationSettings:

Public Types
enum	EntityStates { AwaitingMessage = 0x00000001, AwaitingQuestion = 0x00000002 }

Public Member Functions
virtual	~DtSharedVrfVrlApplicationSettings ()
	DTOR.
virtual void	increaseDriversStarted ()
	Accessors for telling how many drivers have been started.
virtual void	decreaseDriversStarted ()
virtual int	driversStarted () const
	Returns the number of drivers started.
virtual void	setDisplayObjectConsoleWarningIcon (bool)
	Get/set whether or not to show the entity object console warning icon.
virtual bool	displayObjectConsoleWarningIcon () const
virtual void	setShowGumballs (bool)
	Get/set whether or not to show the aggregate gumballs.
virtual bool	showGumballs () const
virtual void	setShowHealth (bool)
	Get/set whether or not to show the aggregate health.
virtual bool	showHealth () const
virtual void	setDisplayBoundingBoxesWhenSelected (bool)
	Get/set whether or not entity bounding boxes are shown when an entity is selected.
virtual bool	displayBoundingBoxesWhenSelected () const
virtual void	setDisplayTaskVisualizationsWhenSelected (bool)
	Get/set whether or not entity task visualizations are shown when an entity is selected.
virtual bool	displayTaskVisualizationsWhenSelected () const
virtual void	setGumballsDirectory (const std::string &)
	Get/set the gumballs icons directory.
virtual const std::string &	gumballsDirectory () const
virtual void	clearAllAwaiting (makVrv::DtElementID)
	Clears all awaiting flags for given entity.
virtual void	setHasAwaitingMessages (makVrv::DtElementID, bool)
	Set whether or not an entity has messages waiting.
virtual bool	hasAwaitingMessages (makVrv::DtElementID) const
virtual void	setHasAwaitingQuestions (makVrv::DtElementID, bool)
	Set whether or not an entity has question waiting.
virtual bool	hasAwaitingQuestions (makVrv::DtElementID) const
virtual void	setObserversPublished (bool)
	Set whether or not observers are to be published.
virtual bool	observersPublished () const
virtual void	setApplicationInitialized (bool)
	Set when the application is fully initialized. Releases communication thread to start.
virtual bool	applicationInitialized () const
virtual void	setApplicationId (int siteId, int appId)
	Site/Application id accessors.
virtual void	getApplicationId (int &siteId, int &appId) const
virtual void	setStealthType (const DtEntityType &)
	Get/set stealth published type. Default 12, 0, 0, 0, 0, 0, 0, 0.
virtual DtEntityType	stealthType () const
virtual void	setShowTaskVisualizations (makVrv::DtElementID, bool)
	Set whether or not an entity has its task visualizations shown.
virtual bool	taskVisualizationsShown (makVrv::DtElementID) const
virtual void	setExtendedEntityFlags (int i)
	Get/set extended entity flags.
virtual int	extendedEntityFlags () const
virtual void	setColorVerticesByForce (bool)
	Get/set color vertices by force.
virtual bool	colorVerticesByForce () const
virtual void	setWaitingToSendBackendQuitMessage (bool)
	{@ Accessor/mutator for whether or not the system is waiting to send the back-end quit message before shutting down
virtual bool	waitingToSendBackendQuitMessage () const
virtual void	setApplicationIsQuitting (bool)
	{@ Accessor/mutator for whether or not the application is quitting
virtual bool	applicationIsQuitting () const
virtual void	setImageFileForCategory (const std::string &, const std::string &)
	{@ Image files for categories that will be shown in health
virtual std::string	imageFileForCategory (const std::string &) const
virtual void	setPrimaryEquipmentHealthCount (int)
virtual int	primaryEquipmentHealthCount () const
virtual void	setMaxSingleEntityHealthForPrimaryEquipDisplay (int)
virtual int	maxSingleEntityHealthForPrimaryEquipDisplay () const
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	Get an instance of the settings object.

Protected Types
typedef std::map < makVrv::DtElementID, EntityStates >	StateFlagMap
typedef std::set < makVrv::DtElementID >	ElementIdSet

Protected Member Functions
virtual void	setStateFlag (makVrv::DtElementID, EntityStates, bool)
	Sets the particular state flag on/off for the entity.
virtual bool	stateFlag (makVrv::DtElementID, EntityStates) const
	Return true if the particular state flag is enabled.
	DtSharedVrfVrlApplicationSettings (makVrv::DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
int	myDriversStarted
DtVrfExtendedEntitySettingsData	myExtendedEntitySettingsData
DtVrfExtendedApplicationSettingsData	myExtendedApplicationSettingsData
std::string	myGumballsDirectory
StateFlagMap	myEntityStates
std::map< std::string, std::string >	myImageFileForCategory
bool	myApplicationInitialized
bool	myColorVerticesByForce
int	mySiteId
int	myApplicationId
DtEntityType	myStealthType
ElementIdSet	myShownTaskVisualizations
int	myPrimaryEquipmentHealthCount
int	myMaxSingleEntityHealthForPrimaryEquipDisplay
bool	myWaitingToSendBackendQuitMessage
bool	myApplicationIsQuitting

Friends
class	makVrv::DtReadSettingsLock< DtSharedVrfVrlApplicationSettings >
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.
class	makVrv::DtWriteSettingsLock< DtSharedVrfVrlApplicationSettings >
class	makVrv::DtSharedSettingsManager

Detailed Description

Class for holding extended settings that are communicated over the thread boundry.

Member Typedef Documentation

typedef std::map<makVrv::DtElementID, EntityStates> makVrf::DtSharedVrfVrlApplicationSettings::StateFlagMap

protected

typedef std::set<makVrv::DtElementID> makVrf::DtSharedVrfVrlApplicationSettings::ElementIdSet

protected

Member Enumeration Documentation

enum makVrf::DtSharedVrfVrlApplicationSettings::EntityStates

Enumerator:

AwaitingMessage
AwaitingQuestion

Constructor & Destructor Documentation

virtual makVrf::DtSharedVrfVrlApplicationSettings::~DtSharedVrfVrlApplicationSettings ( )

virtual

DTOR.

makVrf::DtSharedVrfVrlApplicationSettings::DtSharedVrfVrlApplicationSettings ( makVrv::DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

static std::string makVrf::DtSharedVrfVrlApplicationSettings::className ( )

static

Get an instance of the settings object.

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

virtual void makVrf::DtSharedVrfVrlApplicationSettings::increaseDriversStarted ( )

virtual

Accessors for telling how many drivers have been started.

virtual void makVrf::DtSharedVrfVrlApplicationSettings::decreaseDriversStarted ( )

virtual

virtual int makVrf::DtSharedVrfVrlApplicationSettings::driversStarted ( ) const

virtual

Returns the number of drivers started.

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setDisplayObjectConsoleWarningIcon ( bool  )

virtual

Get/set whether or not to show the entity object console warning icon.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::displayObjectConsoleWarningIcon ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setShowGumballs ( bool  )

virtual

Get/set whether or not to show the aggregate gumballs.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::showGumballs ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setShowHealth ( bool  )

virtual

Get/set whether or not to show the aggregate health.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::showHealth ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setDisplayBoundingBoxesWhenSelected ( bool  )

virtual

Get/set whether or not entity bounding boxes are shown when an entity is selected.

Default is true

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::displayBoundingBoxesWhenSelected ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setDisplayTaskVisualizationsWhenSelected ( bool  )

virtual

Get/set whether or not entity task visualizations are shown when an entity is selected.

Default is true

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::displayTaskVisualizationsWhenSelected ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setGumballsDirectory ( const std::string &  )

virtual

Get/set the gumballs icons directory.

virtual const std::string& makVrf::DtSharedVrfVrlApplicationSettings::gumballsDirectory ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::clearAllAwaiting ( makVrv::DtElementID  )

virtual

Clears all awaiting flags for given entity.

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setHasAwaitingMessages ( makVrv::DtElementID  , bool    )

virtual

Set whether or not an entity has messages waiting.

If this is the first time, send a signal, but, also keep track. If turned off, also send out a message if there are messages waiting

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::hasAwaitingMessages ( makVrv::DtElementID  ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setHasAwaitingQuestions ( makVrv::DtElementID  , bool    )

virtual

Set whether or not an entity has question waiting.

If this is the first time, send a signal, but, also keep track. If turned off, also send out a message if there are messages waiting

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::hasAwaitingQuestions ( makVrv::DtElementID  ) const

virtual

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

virtual

Set whether or not observers are to be published.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::observersPublished ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setApplicationInitialized ( bool  )

virtual

Set when the application is fully initialized. Releases communication thread to start.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::applicationInitialized ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setApplicationId ( int  siteId, int  appId  )

virtual

Site/Application id accessors.

virtual void makVrf::DtSharedVrfVrlApplicationSettings::getApplicationId ( int &  siteId, int &  appId  ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setStealthType ( const DtEntityType &  )

virtual

Get/set stealth published type. Default 12, 0, 0, 0, 0, 0, 0, 0.

virtual DtEntityType makVrf::DtSharedVrfVrlApplicationSettings::stealthType ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setShowTaskVisualizations ( makVrv::DtElementID  , bool    )

virtual

Set whether or not an entity has its task visualizations shown.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::taskVisualizationsShown ( makVrv::DtElementID  ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setExtendedEntityFlags ( int  i )

virtual

Get/set extended entity flags.

virtual int makVrf::DtSharedVrfVrlApplicationSettings::extendedEntityFlags ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setColorVerticesByForce ( bool  )

virtual

Get/set color vertices by force.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::colorVerticesByForce ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setWaitingToSendBackendQuitMessage ( bool  )

virtual

{@ Accessor/mutator for whether or not the system is waiting to send the back-end quit message before shutting down

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::waitingToSendBackendQuitMessage ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setApplicationIsQuitting ( bool  )

virtual

{@ Accessor/mutator for whether or not the application is quitting

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::applicationIsQuitting ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setImageFileForCategory ( const std::string &  , const std::string &    )

virtual

{@ Image files for categories that will be shown in health

virtual std::string makVrf::DtSharedVrfVrlApplicationSettings::imageFileForCategory ( const std::string &  ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setPrimaryEquipmentHealthCount ( int  )

virtual

Accessor for the number of primary health items to show as icons. Default is 5

virtual int makVrf::DtSharedVrfVrlApplicationSettings::primaryEquipmentHealthCount ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setMaxSingleEntityHealthForPrimaryEquipDisplay ( int  )

virtual

Accessor for what the maximum base health is for primary equipment to display, else health bar will display. Default is 2500

virtual int makVrf::DtSharedVrfVrlApplicationSettings::maxSingleEntityHealthForPrimaryEquipDisplay ( ) const

virtual

virtual void makVrf::DtSharedVrfVrlApplicationSettings::setStateFlag ( makVrv::DtElementID  , EntityStates  , bool    )

protectedvirtual

Sets the particular state flag on/off for the entity.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::stateFlag ( makVrv::DtElementID  , EntityStates    ) const

protectedvirtual

Return true if the particular state flag is enabled.

Friends And Related Function Documentation

friend class makVrv::DtReadSettingsLock< DtSharedVrfVrlApplicationSettings >

friend

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

friend class makVrv::DtWriteSettingsLock< DtSharedVrfVrlApplicationSettings >

friend

friend class makVrv::DtSharedSettingsManager

friend

Member Data Documentation

int makVrf::DtSharedVrfVrlApplicationSettings::myDriversStarted

protected

DtVrfExtendedEntitySettingsData makVrf::DtSharedVrfVrlApplicationSettings::myExtendedEntitySettingsData

protected

DtVrfExtendedApplicationSettingsData makVrf::DtSharedVrfVrlApplicationSettings::myExtendedApplicationSettingsData

protected

std::string makVrf::DtSharedVrfVrlApplicationSettings::myGumballsDirectory

protected

StateFlagMap makVrf::DtSharedVrfVrlApplicationSettings::myEntityStates

protected

std::map<std::string, std::string> makVrf::DtSharedVrfVrlApplicationSettings::myImageFileForCategory

protected

bool makVrf::DtSharedVrfVrlApplicationSettings::myApplicationInitialized

protected

bool makVrf::DtSharedVrfVrlApplicationSettings::myColorVerticesByForce

protected

int makVrf::DtSharedVrfVrlApplicationSettings::mySiteId

protected

int makVrf::DtSharedVrfVrlApplicationSettings::myApplicationId

protected

DtEntityType makVrf::DtSharedVrfVrlApplicationSettings::myStealthType

protected

ElementIdSet makVrf::DtSharedVrfVrlApplicationSettings::myShownTaskVisualizations

protected

int makVrf::DtSharedVrfVrlApplicationSettings::myPrimaryEquipmentHealthCount

protected

int makVrf::DtSharedVrfVrlApplicationSettings::myMaxSingleEntityHealthForPrimaryEquipDisplay

protected

bool makVrf::DtSharedVrfVrlApplicationSettings::myWaitingToSendBackendQuitMessage

protected

bool makVrf::DtSharedVrfVrlApplicationSettings::myApplicationIsQuitting

protected

---

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

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