QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | Public Attributes | List of all members
QgsVectorLayerFeatureIterator::FetchJoinInfo Struct Reference

Join information prepared for fast attribute id mapping in QgsVectorLayerJoinBuffer::updateFeatureAttributes(). More...

#include <qgsvectorlayerfeatureiterator.h>

Public Member Functions

void addJoinedAttributesCached (QgsFeature &f, const QVariant &joinValue) const
 
void addJoinedAttributesDirect (QgsFeature &f, const QVariant &joinValue) const
 

Public Attributes

QgsAttributeList attributes
 Attributes to fetch. More...
 
QMap< int, int > attributesSourceToDestLayerMap
 Mapping from original attribute index to the joined layer index. More...
 
int indexOffset
 At what position the joined fields start. More...
 
int joinField
 Index of field (of the joined layer) must have equal value. More...
 
const QgsVectorLayerJoinInfojoinInfo
 Canonical source of information about the join. More...
 
QgsFields joinLayerFields
 Fields from joined layer. More...
 
std::shared_ptr< QgsVectorLayerFeatureSourcejoinSource
 Feature source for join. More...
 
int targetField
 Index of field (of this layer) that drives the join. More...
 

Detailed Description

Join information prepared for fast attribute id mapping in QgsVectorLayerJoinBuffer::updateFeatureAttributes().

Created in the select() method of QgsVectorLayerJoinBuffer for the joins that contain fetched attributes

Definition at line 147 of file qgsvectorlayerfeatureiterator.h.

Member Function Documentation

◆ addJoinedAttributesCached()

void QgsVectorLayerFeatureIterator::FetchJoinInfo::addJoinedAttributesCached ( QgsFeature f,
const QVariant &  joinValue 
) const

Definition at line 1037 of file qgsvectorlayerfeatureiterator.cpp.

◆ addJoinedAttributesDirect()

void QgsVectorLayerFeatureIterator::FetchJoinInfo::addJoinedAttributesDirect ( QgsFeature f,
const QVariant &  joinValue 
) const

Definition at line 1055 of file qgsvectorlayerfeatureiterator.cpp.

Member Data Documentation

◆ attributes

QgsAttributeList QgsVectorLayerFeatureIterator::FetchJoinInfo::attributes

Attributes to fetch.

Definition at line 150 of file qgsvectorlayerfeatureiterator.h.

◆ attributesSourceToDestLayerMap

QMap<int, int> QgsVectorLayerFeatureIterator::FetchJoinInfo::attributesSourceToDestLayerMap

Mapping from original attribute index to the joined layer index.

Definition at line 151 of file qgsvectorlayerfeatureiterator.h.

◆ indexOffset

int QgsVectorLayerFeatureIterator::FetchJoinInfo::indexOffset

At what position the joined fields start.

Definition at line 152 of file qgsvectorlayerfeatureiterator.h.

◆ joinField

int QgsVectorLayerFeatureIterator::FetchJoinInfo::joinField

Index of field (of the joined layer) must have equal value.

Definition at line 174 of file qgsvectorlayerfeatureiterator.h.

◆ joinInfo

const QgsVectorLayerJoinInfo* QgsVectorLayerFeatureIterator::FetchJoinInfo::joinInfo

Canonical source of information about the join.

Definition at line 149 of file qgsvectorlayerfeatureiterator.h.

◆ joinLayerFields

QgsFields QgsVectorLayerFeatureIterator::FetchJoinInfo::joinLayerFields

Fields from joined layer.

Note
Not available in Python bindings
Since
QGIS 3.20

Definition at line 170 of file qgsvectorlayerfeatureiterator.h.

◆ joinSource

std::shared_ptr< QgsVectorLayerFeatureSource > QgsVectorLayerFeatureIterator::FetchJoinInfo::joinSource

Feature source for join.

Note
Not available in Python bindings
Since
QGIS 3.20

Definition at line 162 of file qgsvectorlayerfeatureiterator.h.

◆ targetField

int QgsVectorLayerFeatureIterator::FetchJoinInfo::targetField

Index of field (of this layer) that drives the join.

Definition at line 173 of file qgsvectorlayerfeatureiterator.h.


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