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

Inheritance diagram for makVrv::DtDePathConfiguration:

[legend]

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	userEntityElementDefinitionPath () const
	Get the user directory which has element definitions This can be the same directory as other userData definitions The user directory can be referenced in other directories using The macro string "$(USER_ENTITY_ELEMENT_DEFINITION_DIR)".
virtual std::string	factoryPath () const
virtual std::string	factoryRootPath () const
virtual std::string	dataPath () const
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
virtual std::string	videoStreamPath () const
virtual std::string	cachePath () const
virtual std::string	terrainPath () const
virtual std::string	scenePath () const

virtual void	setAppPath (const std::string &path)
	Setters.
virtual void	setBackupsPath (const std::string &path)
virtual void	setUserPath (const std::string &path)
virtual void	setUserEntityElementDefinitionPath (const std::string &path)
virtual void	setFactoryPath (const std::string &path)
virtual void	setFactoryRootPath (const std::string &path)
virtual void	setDataPath (const std::string &path)
virtual void	setSchemaPath (const std::string &path)
virtual void	setModelDefinitionPath (const std::string &path)
virtual void	setSettingsPath (const std::string &path)
virtual void	setDriverPath (const std::string &path)
virtual void	setVideoStreamPath (const std::string &path)
virtual void	setCachePath (const std::string &path)
virtual void	setTerrainPath (const std::string &path)
virtual void	setScenePath (const std::string &path)
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR.
	DtConfiguration (const DtConfiguration &)
	Copy CTOR.
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP.
virtual	~DtConfiguration ()
	DTOR.
virtual const std::string &	name () const
	Get the configuration name.
virtual void	setName (const std::string &name)
	Set the configuration name.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const ParameterMap &	optionalParameters () const
	Get the optional parameters.

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.
virtual void	replaceEnvironmentVariables (std::string &searchText) const
virtual void	replaceEnvironmentVariables (DtUnicode &searchText) const
Protected Member Functions inherited from makVrv::DtConfiguration
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.

Protected Attributes
std::string	myAppPath
	Members.
std::string	myBackupsPath
std::string	myUserPath
std::string	myUserEntityElementDefinitionPath
std::string	myFactoryPath
std::string	myFactoryRootPath
std::string	myDataPath
std::string	mySchemaPath
std::string	myModelDefinitionPath
std::string	mySettingsPath
std::string	myDriverPath
std::string	myVideoStreamPath
std::string	myCachePath
std::string	myTerrainPath
std::string	myScenePath
std::map< std::string, std::string >	myEnvironmentVariables
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

Additional Inherited Members
Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string, std::string >	ParameterMap

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::userEntityElementDefinitionPath ( ) const

virtual

Get the user directory which has element definitions This can be the same directory as other userData definitions The user directory can be referenced in other directories using The macro string "$(USER_ENTITY_ELEMENT_DEFINITION_DIR)".

virtual std::string makVrv::DtDePathConfiguration::factoryPath ( ) const

virtual

virtual std::string makVrv::DtDePathConfiguration::factoryRootPath ( ) const

virtual

virtual std::string makVrv::DtDePathConfiguration::dataPath ( ) const

virtual

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

virtual std::string makVrv::DtDePathConfiguration::videoStreamPath ( ) const

virtual

virtual std::string makVrv::DtDePathConfiguration::cachePath ( ) const

virtual

virtual std::string makVrv::DtDePathConfiguration::terrainPath ( ) const

virtual

virtual std::string makVrv::DtDePathConfiguration::scenePath ( ) const

virtual

virtual void makVrv::DtDePathConfiguration::setAppPath ( const std::string & path )

virtual

Setters.

virtual void makVrv::DtDePathConfiguration::setBackupsPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setUserPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setUserEntityElementDefinitionPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setFactoryPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setFactoryRootPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setDataPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setSchemaPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setModelDefinitionPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setSettingsPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setDriverPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setVideoStreamPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setCachePath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setTerrainPath ( const std::string & path )

virtual

virtual void makVrv::DtDePathConfiguration::setScenePath ( const std::string & path )

virtual

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

protectedvirtual

Replace all instances of stringToFind with stringToReplace in searchText.

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

protectedvirtual

Replace all instances of stringToFind with stringToReplace in searchText.

virtual void makVrv::DtDePathConfiguration::replaceEnvironmentVariables ( std::string & searchText ) const

protectedvirtual

virtual void makVrv::DtDePathConfiguration::replaceEnvironmentVariables ( DtUnicode & searchText ) const

protectedvirtual

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::myUserEntityElementDefinitionPath

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::myVideoStreamPath

protected

std::string makVrv::DtDePathConfiguration::myCachePath

protected

std::string makVrv::DtDePathConfiguration::myTerrainPath

protected

std::string makVrv::DtDePathConfiguration::myScenePath

protected

std::map<std::string, std::string> makVrv::DtDePathConfiguration::myEnvironmentVariables

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvUtil/DtDePathConfiguration.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation