QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
QgsVectorJoinInfo Struct Reference

#include <qgsvectorlayer.h>

Public Member Functions

QStringListjoinFieldNamesSubset () const
 Get subset of fields to be used from joined layer. More...
 
bool operator== (const QgsVectorJoinInfo &other) const
 
void setJoinFieldNamesSubset (QStringList *fieldNamesSubset)
 Set subset of fields to be used from joined layer. More...
 

Public Attributes

QHash< QString, QgsAttributescachedAttributes
 Cache for joined attributes to provide fast lookup (size is 0 if no memory caching) More...
 
int joinFieldIndex
 Join field index in the source layer. More...
 
QString joinFieldName
 Join field in the source layer. More...
 
QString joinLayerId
 Source layer. More...
 
bool memoryCache
 True if the join is cached in virtual memory. More...
 
QString prefix
 An optional prefix. More...
 
int targetFieldIndex
 Join field index in the target layer. More...
 
QString targetFieldName
 Join field in the target layer. More...
 

Protected Attributes

QSharedPointer< QStringListjoinFieldsSubset
 Subset of fields to use from joined layer. More...
 

Detailed Description

Definition at line 312 of file qgsvectorlayer.h.

Member Function Documentation

QStringList* QgsVectorJoinInfo::joinFieldNamesSubset ( ) const
inline

Get subset of fields to be used from joined layer.

All fields will be used if null is returned.

Note
added in 2.6

Definition at line 352 of file qgsvectorlayer.h.

bool QgsVectorJoinInfo::operator== ( const QgsVectorJoinInfo other) const
inline

Definition at line 337 of file qgsvectorlayer.h.

void QgsVectorJoinInfo::setJoinFieldNamesSubset ( QStringList fieldNamesSubset)
inline

Set subset of fields to be used from joined layer.

Takes ownership of the passed pointer. Null pointer tells to use all fields.

Note
added in 2.6

Definition at line 349 of file qgsvectorlayer.h.

Member Data Documentation

QHash< QString, QgsAttributes> QgsVectorJoinInfo::cachedAttributes

Cache for joined attributes to provide fast lookup (size is 0 if no memory caching)

Note
not available in python bindings

Definition at line 325 of file qgsvectorlayer.h.

int QgsVectorJoinInfo::joinFieldIndex

Join field index in the source layer.

For backward compatibility with 1.x (x>=7)

Definition at line 330 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::joinFieldName

Join field in the source layer.

Definition at line 319 of file qgsvectorlayer.h.

QSharedPointer<QStringList> QgsVectorJoinInfo::joinFieldsSubset
protected

Subset of fields to use from joined layer.

null = use all fields

Definition at line 356 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::joinLayerId

Source layer.

Definition at line 317 of file qgsvectorlayer.h.

bool QgsVectorJoinInfo::memoryCache

True if the join is cached in virtual memory.

Definition at line 321 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::prefix

An optional prefix.

If it is a Null string "{layername}_" will be used

Note
Added in 2.8

Definition at line 335 of file qgsvectorlayer.h.

int QgsVectorJoinInfo::targetFieldIndex

Join field index in the target layer.

For backward compatibility with 1.x (x>=7)

Definition at line 328 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::targetFieldName

Join field in the target layer.

Definition at line 315 of file qgsvectorlayer.h.


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