VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtElementDefinitionSettings Class Reference

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

Inheritance diagram for makVrv::DtElementDefinitionSettings:
Inheritance graph
[legend]

Public Member Functions

 DtElementDefinitionSettings (DtDe &de, const std::string &name, const std::string &ext)
 
virtual ~DtElementDefinitionSettings ()
 
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 entityElementDefinitionDirPath () const
 
virtual std::string tacticalGraphicsElementDefinitionDirPath () const
 
virtual std::string unitElementDefinitionDirPath () 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 ()
 
const std::string & name () const
 
const std::string & extension () const
 
template<typename RecordType >
bool readDefaultRecord (RecordType &r)
 
template<typename RecordType >
bool readDefaultRecordAndName (RecordType &r, std::string &fName)
 
template<typename RecordType >
bool readBackupRecord (RecordType &r)
 
template<typename RecordType >
bool readFactoryDefaultRecord (RecordType &r) const
 
template<typename RecordType >
bool writeDefaultRecord (const RecordType &r)
 
template<typename RecordType >
bool writeBackupRecord (const RecordType &r)
 
template<typename RecordType >
bool readRecordsFrom (std::map< std::string, RecordType > &r, const std::string &importFileName)
 
template<typename RecordType >
bool readRecordFrom (RecordType &r, const std::string &importFileName) const
 
template<typename RecordType >
bool readRecordFromBinary (RecordType &r, const std::string &importFileName)
 
template<typename RecordType >
bool writeRecordTo (const RecordType &r, const std::string &exportFileName) const
 
template<typename RecordType >
bool writeRecordToBinary (const RecordType &r, const std::string &exportFileName) const
 
void setAutoSave (bool b)
 
bool autoSave () const
 
template<typename RecordType >
bool readDefaultRecords (std::map< std::string, RecordType > &recordMap)
 
template<typename RecordType >
bool readRecordFromFile (RecordType &record, const std::string &importFileName)
 
template<typename RecordType >
bool readRecordsFromDir (std::map< std::string, RecordType > &recordMap, const std::string &importDirName)
 
bool defaultFileExists () const
 
bool defaultBinaryFileExists () const
 
bool factoryFileExists () const
 
bool backupFileExists () const
 
bool defaultDirExists () const
 
bool factoryDirExists () const
 
bool backupDirExists () const
 
bool mergedFilesExist () const
 
virtual const std::vector
< std::string > & 
mergedFiles () const
 
virtual void addMergedFile (std::string fileName)
 
bool entityElementDefinitionDirExists () const
 
bool tacticalGraphicsElementDefinitionDirExists () const
 
bool unitElementDefinitionDirExists () const
 

Protected Attributes

std::string myDefinitionName
 
std::string mySubfolderName
 
- Protected Attributes inherited from makVrv::DtDeSettings
DtDemyDe
 
std::string myName
 
std::string myExtension
 
bool myAutoSave
 
std::vector< std::string > myMergedFiles
 

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
 

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

For new folder hierarchy.

Reimplemented from makVrv::DtDeSettings.

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

For new folder hierarchy.

Reimplemented from makVrv::DtDeSettings.

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

For new folder hierarchy.

Reimplemented from makVrv::DtDeSettings.

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

For new folder hierarchy.

Reimplemented from makVrv::DtDeSettings.

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

For new folder hierarchy.

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

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

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

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

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:

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)