QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsVirtualLayerDefinition::SourceLayer Class Reference

A SourceLayer is either a reference to a live layer in the registry or all the parameters needed to load it (provider key, source, etc.) More...

#include <qgsvirtuallayerdefinition.h>

Public Member Functions

 SourceLayer (const QString &name, const QString &ref)
 Constructor variant to build a live layer reference. More...
 
 SourceLayer (const QString &name, const QString &source, const QString &provider, const QString &encoding)
 Constructor variant to build a layer with a provider and a source. More...
 
QString encoding () const
 Optional encoding for the provider. More...
 
bool isReferenced () const
 Is it a live layer or not ? More...
 
QString name () const
 Name of the layer. More...
 
QString provider () const
 Provider key. More...
 
QString reference () const
 The reference (id) of the live layer. More...
 
QString source () const
 The source url used by the provider to build the layer. More...
 

Detailed Description

A SourceLayer is either a reference to a live layer in the registry or all the parameters needed to load it (provider key, source, etc.)

Definition at line 36 of file qgsvirtuallayerdefinition.h.

Constructor & Destructor Documentation

◆ SourceLayer() [1/2]

QgsVirtualLayerDefinition::SourceLayer::SourceLayer ( const QString name,
const QString ref 
)
inline

Constructor variant to build a live layer reference.

Definition at line 40 of file qgsvirtuallayerdefinition.h.

◆ SourceLayer() [2/2]

QgsVirtualLayerDefinition::SourceLayer::SourceLayer ( const QString name,
const QString source,
const QString provider,
const QString encoding 
)
inline

Constructor variant to build a layer with a provider and a source.

Definition at line 45 of file qgsvirtuallayerdefinition.h.

Member Function Documentation

◆ encoding()

QString QgsVirtualLayerDefinition::SourceLayer::encoding ( ) const
inline

Optional encoding for the provider.

Definition at line 68 of file qgsvirtuallayerdefinition.h.

◆ isReferenced()

bool QgsVirtualLayerDefinition::SourceLayer::isReferenced ( ) const
inline

Is it a live layer or not ?

Definition at line 53 of file qgsvirtuallayerdefinition.h.

◆ name()

QString QgsVirtualLayerDefinition::SourceLayer::name ( ) const
inline

Name of the layer.

Definition at line 59 of file qgsvirtuallayerdefinition.h.

◆ provider()

QString QgsVirtualLayerDefinition::SourceLayer::provider ( ) const
inline

Provider key.

Definition at line 62 of file qgsvirtuallayerdefinition.h.

◆ reference()

QString QgsVirtualLayerDefinition::SourceLayer::reference ( ) const
inline

The reference (id) of the live layer.

Definition at line 56 of file qgsvirtuallayerdefinition.h.

◆ source()

QString QgsVirtualLayerDefinition::SourceLayer::source ( ) const
inline

The source url used by the provider to build the layer.

Definition at line 65 of file qgsvirtuallayerdefinition.h.


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