QGIS API Documentation  3.6.0-Noosa (5873452)
Classes | Public Member Functions | List of all members
QgsServerSettings Class Reference

Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values. More...

#include <qgsserversettings.h>

Classes

struct  Setting
 

Public Member Functions

 QgsServerSettings ()
 Constructor. More...
 
QString cacheDirectory () const
 Returns the cache directory. More...
 
qint64 cacheSize () const
 Returns the cache size. More...
 
QString iniFile () const
 Returns the ini file loaded by QSetting. More...
 
void load ()
 Load settings according to current environment variables. More...
 
bool load (const QString &envVarName)
 Load setting for a specific environment variable name. More...
 
QString logFile () const
 Returns the log file. More...
 
Qgis::MessageLevel logLevel () const
 Returns the log level. More...
 
bool logStderr () const
 Returns whether logging to stderr is activated. More...
 
void logSummary () const
 Log a summary of settings currently loaded. More...
 
int maxCacheLayers () const
 Returns the maximum number of cached layers. More...
 
int maxThreads () const
 Returns the maximum number of threads to use. More...
 
bool parallelRendering () const
 Returns parallel rendering setting. More...
 
QString projectFile () const
 Returns the QGS project file to use. More...
 

Detailed Description

Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.

Since
QGIS 3.0

Definition at line 75 of file qgsserversettings.h.

Constructor & Destructor Documentation

◆ QgsServerSettings()

QgsServerSettings::QgsServerSettings ( )

Constructor.

Definition at line 24 of file qgsserversettings.cpp.

Member Function Documentation

◆ cacheDirectory()

QString QgsServerSettings::cacheDirectory ( ) const

Returns the cache directory.

Returns
the directory.

Definition at line 318 of file qgsserversettings.cpp.

◆ cacheSize()

qint64 QgsServerSettings::cacheSize ( ) const

Returns the cache size.

Returns
the cache size.

Definition at line 313 of file qgsserversettings.cpp.

◆ iniFile()

QString QgsServerSettings::iniFile ( ) const

Returns the ini file loaded by QSetting.

Returns
the path of the ini file or an empty string if none is loaded.

Definition at line 273 of file qgsserversettings.cpp.

◆ load() [1/2]

void QgsServerSettings::load ( )

Load settings according to current environment variables.

Definition at line 144 of file qgsserversettings.cpp.

◆ load() [2/2]

bool QgsServerSettings::load ( const QString &  envVarName)

Load setting for a specific environment variable name.

Returns
true if loading is successful, false in case of an invalid name.

Definition at line 160 of file qgsserversettings.cpp.

◆ logFile()

QString QgsServerSettings::logFile ( ) const

Returns the log file.

Returns
the path of the log file or an empty string if none is defined.

Definition at line 288 of file qgsserversettings.cpp.

◆ logLevel()

Qgis::MessageLevel QgsServerSettings::logLevel ( ) const

Returns the log level.

Returns
the log level.

Definition at line 298 of file qgsserversettings.cpp.

◆ logStderr()

bool QgsServerSettings::logStderr ( ) const

Returns whether logging to stderr is activated.

Returns
true if logging to stderr is activated, false otherwise.
Since
QGIS 3.4

Definition at line 293 of file qgsserversettings.cpp.

◆ logSummary()

void QgsServerSettings::logSummary ( ) const

Log a summary of settings currently loaded.

Definition at line 250 of file qgsserversettings.cpp.

◆ maxCacheLayers()

int QgsServerSettings::maxCacheLayers ( ) const

Returns the maximum number of cached layers.

Returns
the number of cached layers.

Definition at line 303 of file qgsserversettings.cpp.

◆ maxThreads()

int QgsServerSettings::maxThreads ( ) const

Returns the maximum number of threads to use.

Returns
the number of threads.

Definition at line 283 of file qgsserversettings.cpp.

◆ parallelRendering()

bool QgsServerSettings::parallelRendering ( ) const

Returns parallel rendering setting.

Returns
true if parallel rendering is activated, false otherwise.

Definition at line 278 of file qgsserversettings.cpp.

◆ projectFile()

QString QgsServerSettings::projectFile ( ) const

Returns the QGS project file to use.

Returns
the path of the QGS project or an empty string if none is defined.

Definition at line 308 of file qgsserversettings.cpp.


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