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...
QString	overrideSystemLocale () const
	Overrides system locale. More...
bool	parallelRendering () const
	Returns parallel rendering setting. More...
QString	projectFile () const
	Returns the QGS project file to use. More...
bool	showGroupSeparator () const
	Show group (thousand) separator. 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 77 of file qgsserversettings.h.

Constructor & Destructor Documentation

QgsServerSettings::QgsServerSettings

(

)

Constructor.

Definition at line 26 of file qgsserversettings.cpp.

Member Function Documentation

QString QgsServerSettings::cacheDirectory

(

)

const

Returns the cache directory.

Returns

the directory.

Definition at line 343 of file qgsserversettings.cpp.

qint64 QgsServerSettings::cacheSize

(

)

const

Returns the cache size.

Returns

the cache size.

Definition at line 338 of file qgsserversettings.cpp.

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 298 of file qgsserversettings.cpp.

void QgsServerSettings::load

(

)

Load settings according to current environment variables.

Definition at line 169 of file qgsserversettings.cpp.

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 185 of file qgsserversettings.cpp.

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 313 of file qgsserversettings.cpp.

Qgis::MessageLevel QgsServerSettings::logLevel

(

)

const

Returns the log level.

Returns

the log level.

Definition at line 323 of file qgsserversettings.cpp.

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 318 of file qgsserversettings.cpp.

void QgsServerSettings::logSummary

(

)

const

Log a summary of settings currently loaded.

Definition at line 275 of file qgsserversettings.cpp.

int QgsServerSettings::maxCacheLayers

(

)

const

Returns the maximum number of cached layers.

Returns

the number of cached layers.

Definition at line 328 of file qgsserversettings.cpp.

int QgsServerSettings::maxThreads

(

)

const

Returns the maximum number of threads to use.

Returns

the number of threads.

Definition at line 308 of file qgsserversettings.cpp.

QString QgsServerSettings::overrideSystemLocale

(

)

const

Overrides system locale.

Returns

the optional override for system locale.

Since

QGIS 3.8

Definition at line 348 of file qgsserversettings.cpp.

bool QgsServerSettings::parallelRendering

(

)

const

Returns parallel rendering setting.

Returns

TRUE if parallel rendering is activated, FALSE otherwise.

Definition at line 303 of file qgsserversettings.cpp.

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 333 of file qgsserversettings.cpp.

bool QgsServerSettings::showGroupSeparator

(

)

const

Show group (thousand) separator.

Returns

if group separator must be shown, default to FALSE.

Since

QGIS 3.8

Definition at line 353 of file qgsserversettings.cpp.

---

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

• /build/qgis-3.4.15+24xenial/src/server/qgsserversettings.h
• /build/qgis-3.4.15+24xenial/src/server/qgsserversettings.cpp