makVrf::DtSharedVrfVrlApplicationSettings Class Reference

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

Inheritance diagram for makVrf::DtSharedVrfVrlApplicationSettings:

List of all members.

Public Types
enum	EntityStates { AwaitingMessage = 0x00000001 }
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	setDisplayBoundingBoxesWhenSelected (bool)
	Get/set whether or not entity bounding boxes are shown when an entity is selected.
virtual bool	displayBoundingBoxesWhenSelected () const
virtual void	setHasAwaitingMessages (makVrv::DtElementID, bool)
	Set whether or not an entity has messages waiting.
virtual bool	hasAwaitingMessages (makVrv::DtElementID) const
virtual void	setObserversPublished (bool)
	Set whether or not observers are to be published.
virtual bool	observersPublished () const
Static Public Member Functions
static std::string	className ()
	Get an instance of the settings object.
Protected Types
typedef std::map < makVrv::DtElementID, EntityStates >	StateFlagMap
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
StateFlagMap	myEntityStates
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]

---

Member Enumeration Documentation

enum makVrf::DtSharedVrfVrlApplicationSettings::EntityStates

Enumerator:

AwaitingMessage

---

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

(

bool

)

[virtual]

Set whether or not observers are to be published.

virtual bool makVrf::DtSharedVrfVrlApplicationSettings::observersPublished

(

)

const [virtual]

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

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

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

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]

StateFlagMap makVrf::DtSharedVrfVrlApplicationSettings::myEntityStates [protected]

---

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

• include/vrfGuiCore/DtSharedVrfVrlApplicationSettings.h