makVrv::DtShadowSettingsCollectionBackup Class Reference

Inheritance diagram for makVrv::DtShadowSettingsCollectionBackup:

Public Member Functions
	DtShadowSettingsCollectionBackup (DtDe &de, DtShadowSettingsManager *parent, const std::string &name, const std::string &displayName)
virtual	~DtShadowSettingsCollectionBackup ()
virtual void	restoreSelected (const DtSettingsBackup *)
	Called with the object that needs to be restored from.
virtual int	currentSelectedShadowSettings () const
virtual void	setCurrentSelectedShadowSettings (int quality)
Public Member Functions inherited from makVrv::DtRecordSettingsBackup< DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >, makArchives::DtShadowSettingsCollectionRecord >
	DtRecordSettingsBackup (DtDe &de, DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord > *parent, const std::string &classType, const std::string &descriptiveName)
	DtRecordSettingsBackup (const DtRecordSettingsBackup &orig)
virtual	~DtRecordSettingsBackup ()
void	restore (const DtSettingsBackup *from)
	Called with the object that needs to be restored from.
DtSettingsBackup *	create () const
	Returns a new empty class of type.
void	write (boost::archive::xml_oarchive &ar)
	Override to write to given stream.
void	writeDir (std::vector< std::ostringstream * > &outStreamVec, std::vector< std::string > &fileNames)
	Support for writing settings to files in a directory.
void	readRecords (boost::archive::xml_iarchive &ar, makArchives::DtShadowSettingsCollectionRecord &recordsResult)
void	readIncremental (boost::archive::xml_iarchive &ar)
	Support for reading files from a directory by looping over files and incrementally adding their contents.
void	read (boost::archive::xml_iarchive &ar)
	Override to read from given stream.
const makArchives::DtShadowSettingsCollectionRecord &	restoredRecord () const
Public Member Functions inherited from makVrv::DtRecordSettingsBackupInterface
	DtRecordSettingsBackupInterface (DtDe &de, const std::string &classType, const std::string &descriptiveName)
	DtRecordSettingsBackupInterface (const DtRecordSettingsBackupInterface &orig)
virtual	~DtRecordSettingsBackupInterface ()
std::string	backupClassType () const
	Override to return the class name of this object.
std::string	backupName () const
	Returns a more readable backup name (for dialogs).
virtual void	backup ()
	Backs up settings to backup file.
virtual void	backupByDir ()
	Backs up settings to backup directory.
void	setCanBackup (bool b)
bool	canBackup () const
Public Member Functions inherited from makVrv::DtSettingsBackup
	DtSettingsBackup ()
	CTOR.
virtual	~DtSettingsBackup ()
	DTOR.
virtual bool	createAndWriteToBackupFile (const std::ostringstream &str, const std::string &path)
	Creates a backup file on the specified path and writes to that backup file given the string stream which contains the stored buffer.
virtual bool	createAndWriteToBackupFiles (const std::vector< std::ostringstream * > str, const std::string &path, const std::vector< std::string > &fileNames)
const std::string &	backupFile () const
	Get the name of the backup file.
virtual bool	backupFileExists () const
	Returns true if the file can be restored from a local backup.
virtual bool	backupDirExists () const
	Returns true if the file can be restored from a local backup directory.
virtual bool	factoryFileExists () const
	Returns true if can be restored from factory.
virtual bool	factoryDirExists () const
	Returns true if can be restored from factory directory.
virtual void	deleteBackup ()
	If backup file exists, deletes it.
virtual void	restore (bool fromFactory=false)
	Restore all.
virtual void	getRestorableNames (NameList &names)
	Get the names of states restore will affect.
virtual void	restore (bool fromFactory, bool selectedOnly)
	Restore the state, either from the backup (default) or from the factory.
void	setManagerDestroyed (bool b)
	If true, will not signal destroyed.
virtual void	addRestoreWhenRestored (DtSettingsBackup *, const RestoreFlags &f=RestoreAll)
	Sets to restore the specified object when this object is restored.
const RestoreWhenRestored &	restoreWhenRestored () const
virtual void	cancelRestoreWhenRestored (DtSettingsBackup *, const RestoreFlags &f=RestoreAll)
	Cancels that the specified object should be restored when this one is restored.
void	setBackupsPath (const std::string &s)
const std::string &	backupsPath () const
void	setFactoryFile (const std::string &s)
const std::string &	factoryFile () const
void	setFactoryDir (const std::string &dir)
const std::string &	factoryDir () const
void	setBackupDir (const std::string &dir)
const std::string &	backupDir () const
Public Member Functions inherited from makVrv::DtBackupInterface
	DtBackupInterface ()
	Default CTOR.
virtual	~DtBackupInterface ()
	Default DTOR.

Protected Attributes
int	myCurrentSelectedShadowSettings
Protected Attributes inherited from makVrv::DtRecordSettingsBackup< DtBaseSettingsManager< makArchives::DtShadowSettingsCollectionRecord >, makArchives::DtShadowSettingsCollectionRecord >
makArchives::DtShadowSettingsCollectionRecord	myRestoredRecord
DtBaseSettingsManager < makArchives::DtShadowSettingsCollectionRecord > *	myParent
Protected Attributes inherited from makVrv::DtRecordSettingsBackupInterface
DtDe &	myDe
std::string	myClassType
std::string	myDescriptiveName
bool	myCanBackup
Protected Attributes inherited from makVrv::DtSettingsBackup
bool	myManagerDestroyed
RestoreWhenRestored	myRestoreWhenRestored
std::string	myBackupFile
std::string	myFactoryFile
std::string	myBackupsPath
std::string	myBackupDir
std::string	myFactoryDir

Additional Inherited Members
Public Types inherited from makVrv::DtSettingsBackup
enum	RestoreFlags { RestoreFromFactory = 0x00000001, RestoreFromLocal = 0x00000002, KeepRestoreFromLocal = 0x80000000, RestoreAll = RestoreFromFactory | RestoreFromLocal }
typedef std::map < DtSettingsBackup *, int >	RestoreWhenRestored
Public Attributes inherited from makVrv::DtSettingsBackup
boost::signal< void(const DtSettingsBackup *)>	signal_destructing
	Called when destructing.
boost::signal< void(const DtSettingsBackup *)>	signal_backupCleared
boost::signal< void(const DtSettingsBackup *)>	signal_backedUp
boost::signal< void(const DtSettingsBackup *)>	signal_restored
Protected Member Functions inherited from makVrv::DtSettingsBackup
virtual bool	restore (bool fromFactory, std::vector< DtSettingsBackup * > &hasBeenRestored, bool selectedOnly)
	Restores from startup (false) or factory (true) file.

Constructor & Destructor Documentation

makVrv::DtShadowSettingsCollectionBackup::DtShadowSettingsCollectionBackup	(	DtDe &	de,
		DtShadowSettingsManager *	parent,
		const std::string &	name,
		const std::string &	displayName
	)

virtual makVrv::DtShadowSettingsCollectionBackup::~DtShadowSettingsCollectionBackup ( )

virtual

Member Function Documentation

virtual void makVrv::DtShadowSettingsCollectionBackup::restoreSelected ( const DtSettingsBackup *  )

virtual

Called with the object that needs to be restored from.

The object passed in should be considered temporary. Any member that holds onto this will become invalid after the restore method is complete

Reimplemented from makVrv::DtSettingsBackup.

virtual int makVrv::DtShadowSettingsCollectionBackup::currentSelectedShadowSettings ( ) const

virtual

virtual void makVrv::DtShadowSettingsCollectionBackup::setCurrentSelectedShadowSettings ( int  quality )

virtual

Member Data Documentation

int makVrv::DtShadowSettingsCollectionBackup::myCurrentSelectedShadowSettings

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtShadowSettingsManager.h