makVrf::DtSharedObjectSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrf::DtSharedObjectSettings:

Public Types
typedef std::map< DtUUID, ObjectSetting >	ObjectSettingsMap

Public Member Functions
virtual	~DtSharedObjectSettings ()
	DTOR.
virtual void	removeSettings (const DtUUID &)
	Removes the settings associated with the specified marking text.
void	setSettings (const DtUUID &, ObjectSetting)
ObjectSetting	settingsFor (const DtUUID &) const
virtual bool	hasSetting (const DtUUID &) const
	Returns true if a setting exists for this object.
void	setFlagState (const DtUUID &, ObjectSetting, bool onOff)
bool	flagState (const DtUUID &, ObjectSetting) const
	Return true if enabled.
virtual void	write (boost::archive::xml_oarchive &ar, int version) const
virtual void	read (boost::archive::xml_iarchive &ar, int version)
const ObjectSettingsMap &	settingsMap () const
virtual void	settingsLoaded ()
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 Member Functions
	DtSharedObjectSettings (makVrv::DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
ObjectSettingsMap	mySettings

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

Detailed Description

The shared simulation settings.

Member Typedef Documentation

typedef std::map<DtUUID, ObjectSetting> makVrf::DtSharedObjectSettings::ObjectSettingsMap

Constructor & Destructor Documentation

virtual makVrf::DtSharedObjectSettings::~DtSharedObjectSettings ( )

virtual

DTOR.

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

protected

CTOR.

Member Function Documentation

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

static

Get an instance of the settings object.

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

virtual void makVrf::DtSharedObjectSettings::removeSettings ( const DtUUID &  )

virtual

Removes the settings associated with the specified marking text.

void makVrf::DtSharedObjectSettings::setSettings	(	const DtUUID &	,
		ObjectSetting
	)

ObjectSetting makVrf::DtSharedObjectSettings::settingsFor

(

const DtUUID &

)

const

virtual bool makVrf::DtSharedObjectSettings::hasSetting ( const DtUUID &  ) const

virtual

Returns true if a setting exists for this object.

void makVrf::DtSharedObjectSettings::setFlagState	(	const DtUUID &	,
		ObjectSetting	,
		bool	onOff
	)

bool makVrf::DtSharedObjectSettings::flagState	(	const DtUUID &	,
		ObjectSetting
	)		const

Return true if enabled.

virtual void makVrf::DtSharedObjectSettings::write ( boost::archive::xml_oarchive &  ar, int  version  ) const

virtual

virtual void makVrf::DtSharedObjectSettings::read ( boost::archive::xml_iarchive &  ar, int  version  )

virtual

const ObjectSettingsMap& makVrf::DtSharedObjectSettings::settingsMap

(

)

const

virtual void makVrf::DtSharedObjectSettings::settingsLoaded ( )

virtual

Friends And Related Function Documentation

friend class makVrv::DtReadSettingsLock< DtSharedObjectSettings >

friend

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

friend class makVrv::DtWriteSettingsLock< DtSharedObjectSettings >

friend

friend class makVrv::DtSharedSettingsManager

friend

Member Data Documentation

ObjectSettingsMap makVrf::DtSharedObjectSettings::mySettings

protected

---

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

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