Class DirProvider

Inheritance Relationships

Base Type

Class Documentation

class DirProvider : public eCAL::Util::IDirProvider

Public Functions

virtual std::string eCALEnvVar(const std::string &var_) const override

Get the value of the specified environment variable.

Parameters:

var_ – The name of the environment variable.

Returns:

The value of the environment variable.

virtual std::string eCALLocalUserDir() const override

The path to the local user settings directory if it exists.

   E.g. AppData/Local/eCAL [win], ~/.ecal [unix]

Returns:

The path to the local user settings directory. Returns empty string if the path does not exist.

virtual std::string eCALDataSystemDir(const Util::IDirManager &dir_manager_) const override

The default path to the eCAL data system directory if it exists.

   E.g. ProgramData/eCAL [win], /etc/ecal [unix]

Returns:

The path to the eCAL data system directory. Returns empty string if the path does not exist.

virtual std::string uniqueTmpDir(const eCAL::Util::IDirManager &dir_manager_) const override

Returns a unique temporary folder.

   The folder will be created and returned.

Returns:

The unique temporary folder directory.

virtual std::string eCALLibraryDir(const eCAL::Util::IDirManager &dir_manager_) const override

Returns the path to the eCAL library directory.

Returns:

The path to the eCAL library directory. Returns empty string if the path does not exist.