QgsServerWmsDimensionProperties Class Reference

Manages QGIS Server properties for Wms dimensions. More...

#include <qgsmaplayerserverproperties.h>

Inheritance diagram for QgsServerWmsDimensionProperties:

Classes
struct	WmsDimensionInfo
	Setting to define QGIS Server WMS Dimension. More...

Public Types
enum	PredefinedWmsDimensionName { TIME, DATE, ELEVATION }
	Predefined/Restricted WMS Dimension name. More...

Public Member Functions
virtual	~QgsServerWmsDimensionProperties ()=default
bool	addWmsDimension (const QgsServerWmsDimensionProperties::WmsDimensionInfo &wmsDimInfo)
	Adds a QGIS Server WMS Dimension. More...
virtual const QgsMapLayer *	layer () const =0
	Gets the parent layer. More...
bool	removeWmsDimension (const QString &wmsDimName)
	Removes a QGIS Server WMS Dimension. More...
void	setWmsDimensions (const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > &dimensions)
	Set WMS Dimensions. More...
const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo >	wmsDimensions () const
	Returns the QGIS Server WMS Dimension list. More...

Static Public Member Functions
static QMap< int, QString >	wmsDimensionDefaultDisplayLabels ()
	Returns WMS Dimension default display labels. More...

Protected Member Functions
void	copyTo (QgsServerWmsDimensionProperties *properties) const
	Copy properties to another instance. More...
void	readXml (const QDomNode &layer_node)
	Reads server properties from project file. More...
void	reset ()
	Reset properties to default. More...
void	writeXml (QDomNode &layer_node, QDomDocument &document) const
	Saves server properties to xml under the layer node. More...

Detailed Description

Manages QGIS Server properties for Wms dimensions.

Since

QGIS 3.22

Definition at line 135 of file qgsmaplayerserverproperties.h.

Member Enumeration Documentation

PredefinedWmsDimensionName

enum QgsServerWmsDimensionProperties::PredefinedWmsDimensionName

Predefined/Restricted WMS Dimension name.

Enumerator
TIME
DATE
ELEVATION

Definition at line 144 of file qgsmaplayerserverproperties.h.

Constructor & Destructor Documentation

~QgsServerWmsDimensionProperties()

virtual QgsServerWmsDimensionProperties::~QgsServerWmsDimensionProperties ( )

virtualdefault

Member Function Documentation

addWmsDimension()

bool QgsServerWmsDimensionProperties::addWmsDimension

(

const QgsServerWmsDimensionProperties::WmsDimensionInfo &

wmsDimInfo

)

Adds a QGIS Server WMS Dimension.

Parameters

wmsDimInfo

QGIS Server WMS Dimension object with, name, field, etc

Returns

true if QGIS Server WMS Dimension has been successfully added

Since

QGIS 3.10

Definition at line 100 of file qgsmaplayerserverproperties.cpp.

copyTo()

void QgsServerWmsDimensionProperties::copyTo ( QgsServerWmsDimensionProperties *  properties ) const

protected

Copy properties to another instance.

Parameters

properties

The properties to copy to

Definition at line 75 of file qgsmaplayerserverproperties.cpp.

layer()

virtual const QgsMapLayer* QgsServerWmsDimensionProperties::layer ( ) const

pure virtual

Gets the parent layer.

Implemented in QgsMapLayerServerProperties.

readXml()

void QgsServerWmsDimensionProperties::readXml ( const QDomNode &  layer_node )

protected

Reads server properties from project file.

Definition at line 131 of file qgsmaplayerserverproperties.cpp.

removeWmsDimension()

bool QgsServerWmsDimensionProperties::removeWmsDimension

(

const QString &

wmsDimName

)

Removes a QGIS Server WMS Dimension.

Returns

true if QGIS Server WMS Dimension was found and successfully removed

Since

QGIS 3.10

Definition at line 113 of file qgsmaplayerserverproperties.cpp.

reset()

void QgsServerWmsDimensionProperties::reset ( )

protected

Reset properties to default.

Definition at line 80 of file qgsmaplayerserverproperties.cpp.

setWmsDimensions()

void QgsServerWmsDimensionProperties::setWmsDimensions

(

const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > &

dimensions

)

Set WMS Dimensions.

Parameters

dimensions

the new dimensions that replace the current ones.

Definition at line 85 of file qgsmaplayerserverproperties.cpp.

wmsDimensionDefaultDisplayLabels()

QMap< int, QString > QgsServerWmsDimensionProperties::wmsDimensionDefaultDisplayLabels ( )

static

Returns WMS Dimension default display labels.

Since

QGIS 3.10

Definition at line 90 of file qgsmaplayerserverproperties.cpp.

wmsDimensions()

const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > QgsServerWmsDimensionProperties::wmsDimensions

(

)

const

Returns the QGIS Server WMS Dimension list.

Since

QGIS 3.10

Definition at line 126 of file qgsmaplayerserverproperties.cpp.

writeXml()

void QgsServerWmsDimensionProperties::writeXml ( QDomNode &  layer_node, QDomDocument &  document  ) const

protected

Saves server properties to xml under the layer node.

Definition at line 186 of file qgsmaplayerserverproperties.cpp.

---

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

• /build/qgis-3.26.3+32focal/src/core/qgsmaplayerserverproperties.h
• /build/qgis-3.26.3+32focal/src/core/qgsmaplayerserverproperties.cpp