iberbox  2.1.2
iberbox::IberboxSettings Class Reference

The IberboxSettings class. More...

Collaboration diagram for iberbox::IberboxSettings:

Public Member Functions

std::string getUserAgent ()
 Gets the current user agent. More...
 
std::string getWorkingDirectory ()
 Gets the working directory path. More...
 
 IberboxSettings ()
 IberboxSettings default constructor. More...
 
 IberboxSettings (const std::string &workingDirectory)
 IberboxSettings alternative constructor. More...
 
void setUserAgent (const std::string &userAgent)
 Sets the user agent. More...
 
void setWorkingDirectory (const std::string &path)
 Sets the working directory. More...
 
virtual ~IberboxSettings ()
 IberboxSettings default destructor. More...
 

Detailed Description

The IberboxSettings class.

Constructor & Destructor Documentation

◆ IberboxSettings() [1/2]

iberbox::IberboxSettings::IberboxSettings ( )

IberboxSettings default constructor.

Using this constructor, the working directory will NOT be set unless setWorkingDirectory is explicitly used.

◆ IberboxSettings() [2/2]

iberbox::IberboxSettings::IberboxSettings ( const std::string &  workingDirectory)

IberboxSettings alternative constructor.

As well as initializing the class, this constructor will set the working directory with the parameter.

Parameters
workingDirectoryThe working directory

◆ ~IberboxSettings()

virtual iberbox::IberboxSettings::~IberboxSettings ( )
virtual

IberboxSettings default destructor.

Member Function Documentation

◆ getUserAgent()

std::string iberbox::IberboxSettings::getUserAgent ( )

Gets the current user agent.

Returns
The current user agent.

◆ getWorkingDirectory()

std::string iberbox::IberboxSettings::getWorkingDirectory ( )

Gets the working directory path.

Returns
The current working directory path.

◆ setUserAgent()

void iberbox::IberboxSettings::setUserAgent ( const std::string &  userAgent)

Sets the user agent.

Parameters
userAgentThe new user agent.

◆ setWorkingDirectory()

void iberbox::IberboxSettings::setWorkingDirectory ( const std::string &  path)

Sets the working directory.

Parameters
pathThe path to the new working directory.

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