makVrv::DtElementDefinitionSettings Class Reference

Settings class for reading and writing settings to/from files. More...

Inheritance diagram for makVrv::DtElementDefinitionSettings:

Public Member Functions
	DtElementDefinitionSettings (DtDe &de, const std::string &name, const std::string &ext)
	CTOR After creation this should be registered with the DtDeSettingsManager.
virtual	~DtElementDefinitionSettings ()
	DTOR.
virtual std::string	defaultFilePath () const
virtual std::string	defaultBinaryFilePath () const
virtual std::string	factoryFilePath () const
virtual std::string	backupFilePath () const
virtual std::string	defaultDirPath () const
virtual std::string	factoryDirPath () const
virtual std::string	backupDirPath () const
virtual std::string	userEntityElementDefinitionDirPath () const
virtual void	setDefinitionName (const std::string &dirName)
virtual std::string	definitionName () const
virtual void	setSubfolderName (const std::string &subDirName)
virtual std::string	subfolderName () const
Public Member Functions inherited from makVrv::DtDeSettings
virtual	~DtDeSettings ()
	DTOR.
const std::string &	name () const
	Get the settings name.
const std::string &	extension () const
	Get the extension for this settings type.
template<typename RecordType >
bool	readDefaultRecord (RecordType &r)
	Read a record from the default settings.
template<typename RecordType >
bool	readBackupRecord (RecordType &r)
	Read a record from the backup settings.
template<typename RecordType >
bool	readFactoryDefaultRecord (RecordType &r)
template<typename RecordType >
bool	writeDefaultRecord (const RecordType &r)
	Write a record as the default settings.
template<typename RecordType >
bool	writeBackupRecord (const RecordType &r)
	Write a record as the default settings.
template<typename RecordType >
bool	readRecordFrom (RecordType &r, const std::string &importFileName)
	Read a record from a specific location.
template<typename RecordType >
bool	readRecordFromBinary (RecordType &r, const std::string &importFileName)
	Read a record from a specific location.
template<typename RecordType >
bool	writeRecordTo (const RecordType &r, const std::string &exportFileName) const
	Write a record to a specific location.
template<typename RecordType >
bool	writeRecordToBinary (const RecordType &r, const std::string &exportFileName) const
	Write a record to a specific location.
void	setAutoSave (bool b)
	Save the record after each change in the GUI (as opposed to hitting the export button to save)
bool	autoSave () const
template<typename RecordType >
bool	readDefaultRecords (std::vector< RecordType > &recVec)
	Read a records from a default directory.
template<typename RecordType >
bool	readRecordsFromDir (std::vector< RecordType > &recVec, const std::string &importDirName)
	Read a records from a directory.
bool	defaultFileExists () const
bool	defaultBinaryFileExists () const
bool	factoryFileExists () const
bool	backupFileExists () const
bool	defaultDirExists () const
bool	factoryDirExists () const
bool	backupDirExists () const
bool	userEntityElementDefinitionDirExists () const

Protected Attributes
std::string	myDefinitionName
std::string	mySubfolderName
Protected Attributes inherited from makVrv::DtDeSettings
DtDe &	myDe
std::string	myName
std::string	myExtension
bool	myAutoSave

Additional Inherited Members
Static Public Member Functions inherited from makVrv::DtDeSettings
static std::string	binaryFileExtension (void)
Protected Member Functions inherited from makVrv::DtDeSettings
	DtDeSettings (DtDe &de, const std::string &name, const std::string &ext)
Static Protected Attributes inherited from makVrv::DtDeSettings
static const std::string	myBinaryFileExtension

Detailed Description

Settings class for reading and writing settings to/from files.

Constructor & Destructor Documentation

makVrv::DtElementDefinitionSettings::DtElementDefinitionSettings	(	DtDe &	de,
		const std::string &	name,
		const std::string &	ext
	)

CTOR After creation this should be registered with the DtDeSettingsManager.

virtual makVrv::DtElementDefinitionSettings::~DtElementDefinitionSettings ( )

virtual

DTOR.

Member Function Documentation

virtual std::string makVrv::DtElementDefinitionSettings::defaultFilePath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::defaultBinaryFilePath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::factoryFilePath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::backupFilePath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::defaultDirPath ( ) const

virtual

For new folder hierarchy

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::factoryDirPath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::backupDirPath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual std::string makVrv::DtElementDefinitionSettings::userEntityElementDefinitionDirPath ( ) const

virtual

Reimplemented from makVrv::DtDeSettings.

virtual void makVrv::DtElementDefinitionSettings::setDefinitionName ( const std::string &  dirName )

virtual

To support element settings in a folder This is will be the name of the file (not including extension) to write

virtual std::string makVrv::DtElementDefinitionSettings::definitionName ( ) const

virtual

virtual void makVrv::DtElementDefinitionSettings::setSubfolderName ( const std::string &  subDirName )

virtual

VRF Style layout includes subfolders, default subfolder for element definitions is "ElementDefinitions"

virtual std::string makVrv::DtElementDefinitionSettings::subfolderName ( ) const

virtual

Member Data Documentation

std::string makVrv::DtElementDefinitionSettings::myDefinitionName

protected

std::string makVrv::DtElementDefinitionSettings::mySubfolderName

protected

---

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

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