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. More...

virtual	~DtElementDefinitionSettings ()
	DTOR. More...

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. More...

const std::string &	name () const
	Get the settings name. More...

const std::string &	extension () const
	Get the extension for this settings type. More...

template<typename RecordType >
bool	readDefaultRecord (RecordType &r)
	Read a record from the default settings. More...

template<typename RecordType >
bool	readDefaultRecordAndName (RecordType &r, std::string &fName)
	Read a record and file name from the default settings. More...

template<typename RecordType >
bool	readBackupRecord (RecordType &r)
	Read a record from the backup settings. More...

template<typename RecordType >
bool	readFactoryDefaultRecord (RecordType &r)

template<typename RecordType >
bool	writeDefaultRecord (const RecordType &r)
	Write a record as the default settings. More...

template<typename RecordType >
bool	writeBackupRecord (const RecordType &r)
	Write a record as the default settings. More...

template<typename RecordType >
bool	readRecordsFrom (std::map< std::string, RecordType > &r, const std::string &importFileName)
	Reads records from a specific location. More...

template<typename RecordType >
bool	readRecordFrom (RecordType &r, const std::string &importFileName)
	Read a record from a specific location. More...

template<typename RecordType >
bool	readRecordFromBinary (RecordType &r, const std::string &importFileName)
	Read a record from a specific location. More...

template<typename RecordType >
bool	writeRecordTo (const RecordType &r, const std::string &exportFileName) const
	Write a record to a specific location. More...

template<typename RecordType >
bool	writeRecordToBinary (const RecordType &r, const std::string &exportFileName) const
	Write a record to a specific location. More...

void	setAutoSave (bool b)
	Save the record after each change in the GUI (as opposed to hitting the export button to save) More...

bool	autoSave () const

template<typename RecordType >
bool	readDefaultRecords (std::map< std::string, RecordType > &recordMap)
	Read a records from a default directory Map key is the filename that the record came from. More...

template<typename RecordType >
bool	readRecordFromFile (RecordType &record, const std::string &importFileName)
	Read a records from a file. More...

template<typename RecordType >
bool	readRecordsFromDir (std::map< std::string, RecordType > &recordMap, const std::string &importDirName)
	Read a records from a directory Map key is the filename that the record came from. More...

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtElementDefinitionSettings.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation