QGIS API Documentation  2.99.0-Master (b058df7)
Public Member Functions | List of all members
QgsRelation::FieldPair Class Reference

Defines a relation between matching fields of the two involved tables of a relation. More...

#include <qgsrelation.h>

Inheritance diagram for QgsRelation::FieldPair:
Inheritance graph
[legend]

Public Member Functions

 FieldPair ()=default
 Default constructor: NULL strings. More...
 
 FieldPair (const QString &referencingField, const QString &referencedField)
 Constructor which takes two fields. More...
 
bool operator== (const FieldPair &other) const
 
QString referencedField () const
 Get the name of the referenced (parent) field. More...
 
QString referencingField () const
 Get the name of the referencing (child) field. More...
 

Detailed Description

Defines a relation between matching fields of the two involved tables of a relation.

Often, a relation is only defined by just one FieldPair with the name of the foreign key column of the referencing (child) table as first element and the name of the primary key column of the referenced (parent) table as the second element.

Note
not available in Python bindings

Definition at line 72 of file qgsrelation.h.

Constructor & Destructor Documentation

◆ FieldPair() [1/2]

QgsRelation::FieldPair::FieldPair ( )
default

Default constructor: NULL strings.

◆ FieldPair() [2/2]

QgsRelation::FieldPair::FieldPair ( const QString &  referencingField,
const QString &  referencedField 
)
inline

Constructor which takes two fields.

Definition at line 79 of file qgsrelation.h.

Member Function Documentation

◆ operator==()

bool QgsRelation::FieldPair::operator== ( const FieldPair other) const
inline

Definition at line 87 of file qgsrelation.h.

◆ referencedField()

QString QgsRelation::FieldPair::referencedField ( ) const
inline

Get the name of the referenced (parent) field.

Definition at line 85 of file qgsrelation.h.

◆ referencingField()

QString QgsRelation::FieldPair::referencingField ( ) const
inline

Get the name of the referencing (child) field.

Definition at line 83 of file qgsrelation.h.


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