QGIS API Documentation  2.17.0-Master (6f7b933)
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 constructor: NULL strings. More...
 
 FieldPair (const QString &referencingField, const QString &referencedField)
 Constructor which takes two fields. More...
 
QString referencedField () const
 Get the name of the referenced (parent) field. More...
 
QString referencingField () const
 Get the name of the referencing (child) field. More...
 
- Public Member Functions inherited from QPair< QString, QString >
 QPair ()
 
 QPair (const T1 &value1, const T2 &value2)
 
QPair< T1, T2 > & operator= (const QPair< T1, T2 > &other)
 

Additional Inherited Members

- Public Attributes inherited from QPair< QString, QString >
typedef first_type
 
typedef second_type
 

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 42 of file qgsrelation.h.

Constructor & Destructor Documentation

QgsRelation::FieldPair::FieldPair ( )
inline

Default constructor: NULL strings.

Definition at line 46 of file qgsrelation.h.

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

Constructor which takes two fields.

Definition at line 50 of file qgsrelation.h.

Member Function Documentation

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

Get the name of the referenced (parent) field.

Definition at line 56 of file qgsrelation.h.

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

Get the name of the referencing (child) field.

Definition at line 54 of file qgsrelation.h.


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