VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass > Class Template Reference

The makVrv::DtRecordSettingsBackup is a templaced class that settings records will use in order to backup/restore data. More...

Inheritance diagram for makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >:
Inheritance graph
[legend]

Public Member Functions

 DtRecordSettingsBackup (DtDe &de, SettingsClass *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.
DtSettingsBackupcreate () const
 Returns a new empty class of type.
void write (boost::archive::xml_oarchive &ar)
 Override to write to given stream.
void read (boost::archive::xml_iarchive &ar)
 Override to read from given stream.
const ArchiveClass & 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.
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.
const std::string & backupFile () const
 Get the name of the backup file.
virtual bool backupExists () const
 Returns true if the file can be restored from a local backup.
virtual bool factoryExists () const
 Returns true if can be restored from factory.
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.
virtual void restoreSelected (const DtSettingsBackup *)
 Called with the object that needs to be restored from.
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 RestoreWhenRestoredrestoreWhenRestored () 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
- Public Member Functions inherited from makVrv::DtBackupInterface
 DtBackupInterface ()
 Default CTOR.
virtual ~DtBackupInterface ()
 Default DTOR.

Protected Attributes

ArchiveClass myRestoredRecord
SettingsClass * myParent
- Protected Attributes inherited from makVrv::DtRecordSettingsBackupInterface
DtDemyDe
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

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.

Detailed Description

template<typename SettingsClass, typename ArchiveClass>
class makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >

The makVrv::DtRecordSettingsBackup is a templaced class that settings records will use in order to backup/restore data.

Constructor & Destructor Documentation

template<typename SettingsClass, typename ArchiveClass>
makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::DtRecordSettingsBackup ( DtDe de,
SettingsClass *  parent,
const std::string &  classType,
const std::string &  descriptiveName 
)
inline
template<typename SettingsClass, typename ArchiveClass>
makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::DtRecordSettingsBackup ( const DtRecordSettingsBackup< SettingsClass, ArchiveClass > &  orig)
inline
template<typename SettingsClass, typename ArchiveClass>
virtual makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::~DtRecordSettingsBackup ( )
inlinevirtual

Member Function Documentation

template<typename SettingsClass, typename ArchiveClass>
void makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::restore ( const DtSettingsBackup from)
inlinevirtual

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

Implements makVrv::DtSettingsBackup.

template<typename SettingsClass, typename ArchiveClass>
DtSettingsBackup* makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::create ( ) const
inlinevirtual

Returns a new empty class of type.

Will be called from restore() method to restore data into

Implements makVrv::DtSettingsBackup.

template<typename SettingsClass, typename ArchiveClass>
void makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::write ( boost::archive::xml_oarchive &  ar)
inlinevirtual

Override to write to given stream.

Implementation need not be more than oa << *this

Implements makVrv::DtSettingsBackup.

template<typename SettingsClass, typename ArchiveClass>
void makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::read ( boost::archive::xml_iarchive &  ar)
inlinevirtual

Override to read from given stream.

Implementation need not be more than ia >> *this

Implements makVrv::DtSettingsBackup.

template<typename SettingsClass, typename ArchiveClass>
const ArchiveClass& makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::restoredRecord ( ) const
inline

Member Data Documentation

template<typename SettingsClass, typename ArchiveClass>
ArchiveClass makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::myRestoredRecord
protected
template<typename SettingsClass, typename ArchiveClass>
SettingsClass* makVrv::DtRecordSettingsBackup< SettingsClass, ArchiveClass >::myParent
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)