makVrv::DtDePathConfiguration Class Reference

The DtDePathConfiguration contains paths to various files, and can resolve the path macros , , and within paths. More...

Inheritance diagram for makVrv::DtDePathConfiguration:

List of all members.

Public Member Functions
	DtDePathConfiguration (const std::string &name="")
	CTOR.
	DtDePathConfiguration (const DtDePathConfiguration &)
	Copy CTOR.
DtDePathConfiguration &	operator= (const DtDePathConfiguration &)
	Assignment OP.
virtual	~DtDePathConfiguration ()
	DTOR.
virtual std::string	resolvePath (const std::string &directory) const
	Resolve a directory by replacing , , variables with the appropriate values.
virtual DtUnicode	resolvePath (const DtUnicode &directory) const
	Resolve a directory by replacing , , variables with the appropriate values.
virtual std::string	markupPath (const std::string &directory) const
	Mark up a directory by replacing directories with , , variables.
virtual DtUnicode	markupPath (const DtUnicode &directory) const
	Mark up a directory by replacing directories with , , variables.
virtual std::string	appPath () const
	Accessors to resolved paths.
virtual std::string	backupsPath () const
	Get the directory to the backup path.
virtual std::string	userPath () const
	Get the user directory.
virtual std::string	factoryPath () const
	Accessors to resolved paths.
virtual std::string	factoryRootPath () const
	Accessors to resolved paths.
virtual std::string	dataPath () const
	Accessors to resolved paths.
virtual std::string	schemaPath () const
	Get the schema directory that model definitions are loaded from at start up.
virtual std::string	modelDefinitionPath () const
	Set the Model directory that model definitions are loaded from at start up.
virtual std::string	settingsPath () const
	Set the config directory that config files are loaded from at start up.
virtual std::string	driverPath () const
	Accessors to resolved paths.
virtual std::string	cachePath () const
	Accessors to resolved paths.
virtual std::string	terrainPath () const
	Accessors to resolved paths.
virtual std::string	scenePath () const
	Accessors to resolved paths.
virtual void	setAppPath (const std::string &path)
	Setters.
virtual void	setBackupsPath (const std::string &path)
	Setters.
virtual void	setUserPath (const std::string &path)
	Setters.
virtual void	setFactoryPath (const std::string &path)
	Setters.
virtual void	setFactoryRootPath (const std::string &path)
	Setters.
virtual void	setDataPath (const std::string &path)
	Setters.
virtual void	setSchemaPath (const std::string &path)
	Setters.
virtual void	setModelDefinitionPath (const std::string &path)
	Setters.
virtual void	setSettingsPath (const std::string &path)
	Setters.
virtual void	setDriverPath (const std::string &path)
	Setters.
virtual void	setCachePath (const std::string &path)
	Setters.
virtual void	setTerrainPath (const std::string &path)
	Setters.
virtual void	setScenePath (const std::string &path)
	Setters.
Protected Member Functions
virtual void	replaceAll (std::string &searchText, const std::string &stringToFind, const std::string &stringToReplace) const
	Replace all instances of stringToFind with stringToReplace in searchText.
virtual void	replaceAll (DtUnicode &searchText, const DtUnicode &stringToFind, const DtUnicode &stringToReplace) const
	Replace all instances of stringToFind with stringToReplace in searchText.
Protected Attributes
std::string	myAppPath
	Members.
std::string	myBackupsPath
std::string	myUserPath
std::string	myFactoryPath
std::string	myFactoryRootPath
std::string	myDataPath
std::string	mySchemaPath
std::string	myModelDefinitionPath
std::string	mySettingsPath
std::string	myDriverPath
std::string	myCachePath
std::string	myTerrainPath
std::string	myScenePath

---

Detailed Description

The DtDePathConfiguration contains paths to various files, and can resolve the path macros , , and within paths.

---

Constructor & Destructor Documentation

makVrv::DtDePathConfiguration::DtDePathConfiguration

(

const std::string &

name = ""

)

CTOR.

makVrv::DtDePathConfiguration::DtDePathConfiguration

(

const DtDePathConfiguration &

)

Copy CTOR.

virtual makVrv::DtDePathConfiguration::~DtDePathConfiguration

(

)

[virtual]

DTOR.

---

Member Function Documentation

DtDePathConfiguration& makVrv::DtDePathConfiguration::operator=

(

const DtDePathConfiguration &

)

Assignment OP.

virtual std::string makVrv::DtDePathConfiguration::resolvePath

(

const std::string &

directory

)

const [virtual]

Resolve a directory by replacing , , variables with the appropriate values.

virtual DtUnicode makVrv::DtDePathConfiguration::resolvePath

(

const DtUnicode &

directory

)

const [virtual]

Resolve a directory by replacing , , variables with the appropriate values.

virtual std::string makVrv::DtDePathConfiguration::markupPath

(

const std::string &

directory

)

const [virtual]

Mark up a directory by replacing directories with , , variables.

virtual DtUnicode makVrv::DtDePathConfiguration::markupPath

(

const DtUnicode &

directory

)

const [virtual]

Mark up a directory by replacing directories with , , variables.

virtual std::string makVrv::DtDePathConfiguration::appPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::backupsPath

(

)

const [virtual]

Get the directory to the backup path.

The backup path is where all record backups are placed

virtual std::string makVrv::DtDePathConfiguration::userPath

(

)

const [virtual]

Get the user directory.

The user directory can be referenced in other directories using The macro string "$(USER_DIR)".

virtual std::string makVrv::DtDePathConfiguration::factoryPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::factoryRootPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::dataPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::schemaPath

(

)

const [virtual]

Get the schema directory that model definitions are loaded from at start up.

This will replace any macros strings with their actual values.

virtual std::string makVrv::DtDePathConfiguration::modelDefinitionPath

(

)

const [virtual]

Set the Model directory that model definitions are loaded from at start up.

virtual std::string makVrv::DtDePathConfiguration::settingsPath

(

)

const [virtual]

Set the config directory that config files are loaded from at start up.

virtual std::string makVrv::DtDePathConfiguration::driverPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::cachePath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::terrainPath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual std::string makVrv::DtDePathConfiguration::scenePath

(

)

const [virtual]

Accessors to resolved paths.

Get the application directory. The application directory can be referenced in other directories using The macro string "$(APP_DIR)".

virtual void makVrv::DtDePathConfiguration::setAppPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setBackupsPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setUserPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setFactoryPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setFactoryRootPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setDataPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setSchemaPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setModelDefinitionPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setSettingsPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setDriverPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setCachePath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setTerrainPath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::setScenePath

(

const std::string &

path

)

[virtual]

Setters.

virtual void makVrv::DtDePathConfiguration::replaceAll	(	std::string &	searchText,
		const std::string &	stringToFind,
		const std::string &	stringToReplace
	)		const [protected, virtual]

Replace all instances of stringToFind with stringToReplace in searchText.

virtual void makVrv::DtDePathConfiguration::replaceAll	(	DtUnicode &	searchText,
		const DtUnicode &	stringToFind,
		const DtUnicode &	stringToReplace
	)		const [protected, virtual]

Replace all instances of stringToFind with stringToReplace in searchText.

---

Member Data Documentation

std::string makVrv::DtDePathConfiguration::myAppPath [protected]

Members.

std::string makVrv::DtDePathConfiguration::myBackupsPath [protected]

std::string makVrv::DtDePathConfiguration::myUserPath [protected]

std::string makVrv::DtDePathConfiguration::myFactoryPath [protected]

std::string makVrv::DtDePathConfiguration::myFactoryRootPath [protected]

std::string makVrv::DtDePathConfiguration::myDataPath [protected]

std::string makVrv::DtDePathConfiguration::mySchemaPath [protected]

std::string makVrv::DtDePathConfiguration::myModelDefinitionPath [protected]

std::string makVrv::DtDePathConfiguration::mySettingsPath [protected]

std::string makVrv::DtDePathConfiguration::myDriverPath [protected]

std::string makVrv::DtDePathConfiguration::myCachePath [protected]

std::string makVrv::DtDePathConfiguration::myTerrainPath [protected]

std::string makVrv::DtDePathConfiguration::myScenePath [protected]

---

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

• include/vrvUtil/DtDePathConfiguration.h