trUtil::EnvVariables Class Reference

Disable warning for stl classes Needs to have dll-interface to be used by clients of class. More...

#include <EnvVariables.h>

Static Public Attributes
static const std::string	TR_ROOT = std::string("TR_ROOT")
	Environmental Variable that points to the Root folder of the engine. More...
static const std::string	TR_LIB = std::string("TR_LIB")
	Environmental Variable that points to the Library folders of the engine. More...
static const std::string	TR_BIN = std::string("TR_BIN")
	Environmental Variable that points to the Binary folders of the engine. More...
static const std::string	TR_INC = std::string("TR_INC")
	Environmental Variable that points to the Include folders of the engine. More...
static const std::string	TR_DATA = std::string("TR_DATA")
	Environmental Variable that points to the Data folder of the engine The Data folder should have general art and system content If this variable is not present the engine will search for the Data Folder in TR_ROOT. More...
static const std::string	TR_USER_DATA = std::string("TR_USER_DATA")
	Environmental Variable that points to the User Data folder of the engine The Data folder should have the log files and general art and user content If this variable is not present the engine will search for the User Data Folder in Users Home and MyDocuments directories. More...
static const std::string	TR_PATH = std::string("TR_PATH")
	Environmental Variable that should be upended to the PATH variable, to give the engine access to its resources. More...
static const std::string	TR_LOG_PATH = std::string("TR_LOG_PATH")
	Environmental Variable holds the path of the custom Log folder. More...

Protected Member Functions
	EnvVariables ()
	Default constructor. More...

Detailed Description

Disable warning for stl classes Needs to have dll-interface to be used by clients of class.

An environment variables.

Author

Maxim Serebrennik

Definition at line 49 of file EnvVariables.h.

Constructor & Destructor Documentation

EnvVariables()

trUtil::EnvVariables::EnvVariables ( )

inlineprotected

Default constructor.

Definition at line 96 of file EnvVariables.h.

References TR_DISABLE_WARNING_END.

Member Data Documentation

TR_BIN

const std::string trUtil::EnvVariables::TR_BIN = std::string("TR_BIN")

static

Environmental Variable that points to the Binary folders of the engine.

Definition at line 60 of file EnvVariables.h.

TR_DATA

const std::string trUtil::EnvVariables::TR_DATA = std::string("TR_DATA")

static

Environmental Variable that points to the Data folder of the engine The Data folder should have general art and system content If this variable is not present the engine will search for the Data Folder in TR_ROOT.

Definition at line 70 of file EnvVariables.h.

Referenced by trUtil::PathUtils::GetDataPath().

TR_INC

const std::string trUtil::EnvVariables::TR_INC = std::string("TR_INC")

static

Environmental Variable that points to the Include folders of the engine.

Definition at line 63 of file EnvVariables.h.

TR_LIB

const std::string trUtil::EnvVariables::TR_LIB = std::string("TR_LIB")

static

Environmental Variable that points to the Library folders of the engine.

Definition at line 57 of file EnvVariables.h.

TR_LOG_PATH

const std::string trUtil::EnvVariables::TR_LOG_PATH = std::string("TR_LOG_PATH")

static

Environmental Variable holds the path of the custom Log folder.

Definition at line 87 of file EnvVariables.h.

Referenced by trUtil::PathUtils::GetLogPath().

TR_PATH

const std::string trUtil::EnvVariables::TR_PATH = std::string("TR_PATH")

static

Environmental Variable that should be upended to the PATH variable, to give the engine access to its resources.

Definition at line 84 of file EnvVariables.h.

TR_ROOT

const std::string trUtil::EnvVariables::TR_ROOT = std::string("TR_ROOT")

static

Environmental Variable that points to the Root folder of the engine.

Definition at line 54 of file EnvVariables.h.

Referenced by trUtil::PathUtils::GetRootPath().

TR_USER_DATA

const std::string trUtil::EnvVariables::TR_USER_DATA = std::string("TR_USER_DATA")

static

Environmental Variable that points to the User Data folder of the engine The Data folder should have the log files and general art and user content If this variable is not present the engine will search for the User Data Folder in Users Home and MyDocuments directories.

Definition at line 78 of file EnvVariables.h.

Referenced by trUtil::PathUtils::GetUserDataPath().

---

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

• EnvVariables.h
• EnvVariables.cpp