iRoCS Toolbox  1.1.0
Static Public Member Functions
BaseEnvironment Class Reference

#include <BaseEnvironment.hh>

Collaboration diagram for BaseEnvironment:

Static Public Member Functions

static std::string HostName ()
 UserHomeDirectory returns the name of the host. More...
 
static std::string UserAppDataDirectory ()
 UserAppDataDirectory returns the path to the users application data directory. More...
 
static std::string UserHomeDirectory ()
 UserHomeDirectory returns the path to the users home directory. More...
 
static std::string UserTempDirectory ()
 TempDirectory returns the path to the users temporary files directory. More...
 

Detailed Description

Definition at line 47 of file BaseEnvironment.hh.

Member Function Documentation

◆ UserHomeDirectory()

static std::string BaseEnvironment::UserHomeDirectory ( )
static

UserHomeDirectory returns the path to the users home directory.

Returns
string the path to the user home directory

◆ UserTempDirectory()

static std::string BaseEnvironment::UserTempDirectory ( )
static

TempDirectory returns the path to the users temporary files directory.

This can be user-specific, or globally unique for the machine (depending on the OS).

Returns
string the path to the user temp directory

◆ UserAppDataDirectory()

static std::string BaseEnvironment::UserAppDataDirectory ( )
static

UserAppDataDirectory returns the path to the users application data directory.

This can be zero, if the operating system does not support the concept of application data directories (depending on the OS).

Returns
string the path to the application data directory

◆ HostName()

static std::string BaseEnvironment::HostName ( )
static

UserHomeDirectory returns the name of the host.

Returns
string the name of the host.

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