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 Member Functions | Protected Attributes
makVrv::DtDePathConfiguration Class Reference
vrvUtil

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

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

Public Member Functions

 DtDePathConfiguration (const std::string &name="")
 
 DtDePathConfiguration (const DtDePathConfiguration &)
 
DtDePathConfiguration & operator= (const DtDePathConfiguration &)
 
virtual ~DtDePathConfiguration ()
 
virtual std::string resolvePath (const std::string &directory) const
 
virtual DtUnicode resolvePath (const DtUnicode &directory) const
 
virtual std::string markupPath (const std::string &directory) const
 
virtual DtUnicode markupPath (const DtUnicode &directory) const
 
virtual std::string appPath () const
 
virtual std::string backupsPath () const
 
virtual std::string userPath () const
 
virtual std::string sharedDataPath () const
 
virtual std::string sharedDataRoot () const
 
virtual std::string sharedDataStem () const
 
virtual std::string entityElementDefinitionPath () const
 
virtual std::string tacticalGraphicsElementDefinitionPath () const
 
virtual std::string unitElementDefinitionPath () const
 
virtual std::string factoryPath () const
 
virtual std::string factoryRootPath () const
 
virtual std::string dataPath () const
 
virtual std::string iconsPath () const
 
virtual std::string schemaPath () const
 
virtual std::string definitionsPath () const
 
virtual std::string modelDefinitionsPath () const
 
virtual std::string settingsPath () const
 
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)
 
virtual void setBackupsPath (const std::string &path)
 
virtual void setUserPath (const std::string &path)
 
virtual void setEntityElementDefinitionPath (const std::string &path)
 
virtual void setTacticalGraphicsElementDefinitionPath (const std::string &path)
 
virtual void setUnitElementDefinitionPath (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 setIconsPath (const std::string &path)
 
virtual void setSchemaPath (const std::string &path)
 
virtual void setDefinitionsPath (const std::string &path)
 
virtual void setModelDefinitionsPath (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)
 
virtual void setSharedDataRoot (const std::string &path)
 
virtual void setSharedDataStem (const std::string &path)
 
virtual void setSharedDataPath (const std::string &path)
 
- Public Member Functions inherited from makVrv::DtConfiguration
 DtConfiguration (const std::string &name="")
 
 DtConfiguration (const DtConfiguration &)
 
DtConfiguration & operator= (const DtConfiguration &)
 
virtual ~DtConfiguration ()
 
virtual const std::string & name () const
 
virtual void setName (const std::string &name)
 
virtual const std::string * findOptionalParameter (const std::string &name) const
 
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 
virtual void setOptionalParameters (const ParameterMap &)
 
virtual void removeOptionalParameter (const std::string &name)
 
const ParameterMap & optionalParameters () const
 

Protected Member Functions

virtual void replaceAll (std::string &searchText, const std::string &stringToFind, const std::string &stringToReplace) const
 
virtual void replaceAll (DtUnicode &searchText, const DtUnicode &stringToFind, const DtUnicode &stringToReplace) const
 
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)
 

Protected Attributes

std::string myAppPath
 
std::string myBackupsPath
 
std::string myUserPath
 
std::string myFactoryPath
 
std::string myFactoryRootPath
 
std::string myDataPath
 
std::string myIconsPath
 
std::string mySchemaPath
 
std::string myDefinitionsPath
 
std::string myModelDefinitionsPath
 
std::string mySettingsPath
 
std::string myDriverPath
 
std::string myVideoStreamPath
 
std::string myCachePath
 
std::string myTerrainPath
 
std::string myScenePath
 
std::string mySharedDataRoot
 
std::string mySharedDataStem
 
std::string mySharedDataPath
 
std::string myEntityElementDefinitionPath
 
std::string myTacticalGraphicsElementDefinitionPath
 
std::string myUnitElementDefinitionPath
 
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
 

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

Get the shared data directory. The shared directory can be referenced in other directories using The macro string "$(SHARED_DATA_DIR)". It will have the form <shared data="" root>="">/<dataVersion>/<shared data="" stem>="">. The data version is compiled into the application.

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

Get the root portion of the shared data path. This is C: by default. It can be changed with the MAK_SHARED_DATA_ROOT environment variable or with the 'sharedDataRoot' command line argument; or by calling this class' setSharedDataRoot() method.

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

Get the stem portion of the shared data path. This is 'latest' by default, and can be changed with the 'sharedDataStem' command line argument, or through the API by calling this class' setSharedDataStem() method.

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

Retrieve the alternate entity element definition path (if specified by –entityDefsDir)

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

Retrieve the alternate tactical graphics element definition path (if specified by –tacticalGraphicsDefsDir)

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

Retrieve the alternate unit element definition path (if specified by –unitDefsDir)

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::iconsPath ( ) 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::definitionsPath ( ) const
virtual

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

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

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

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

Get 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::videoStreamPath ( ) 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::setEntityElementDefinitionPath ( const std::string &  path)
virtual

Setters.

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

Setters.

virtual void makVrv::DtDePathConfiguration::setUnitElementDefinitionPath ( 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::setIconsPath ( const std::string &  path)
virtual

Setters.

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

Setters.

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

Setters.

virtual void makVrv::DtDePathConfiguration::setModelDefinitionsPath ( 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::setVideoStreamPath ( 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::setSharedDataRoot ( const std::string &  path)
virtual

Setters.

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

Setters.

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

Setters.

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::myFactoryPath
protected
std::string makVrv::DtDePathConfiguration::myFactoryRootPath
protected
std::string makVrv::DtDePathConfiguration::myDataPath
protected
std::string makVrv::DtDePathConfiguration::myIconsPath
protected
std::string makVrv::DtDePathConfiguration::mySchemaPath
protected
std::string makVrv::DtDePathConfiguration::myDefinitionsPath
protected
std::string makVrv::DtDePathConfiguration::myModelDefinitionsPath
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::string makVrv::DtDePathConfiguration::mySharedDataRoot
protected
std::string makVrv::DtDePathConfiguration::mySharedDataStem
protected
std::string makVrv::DtDePathConfiguration::mySharedDataPath
protected
std::string makVrv::DtDePathConfiguration::myEntityElementDefinitionPath
protected
std::string makVrv::DtDePathConfiguration::myTacticalGraphicsElementDefinitionPath
protected
std::string makVrv::DtDePathConfiguration::myUnitElementDefinitionPath
protected
std::map<std::string, std::string> makVrv::DtDePathConfiguration::myEnvironmentVariables
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)