QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | List of all members
QgsAttributes Class Reference

A vector of attributes. More...

#include <qgsattributes.h>

Inheritance diagram for QgsAttributes:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributes ()=default
 Constructor for QgsAttributes. More...
 
 QgsAttributes (const QVector< QVariant > &v)
 Copies another vector of attributes. More...
 
 QgsAttributes (int size)
 Create a new vector of attributes with the given size. More...
 
 QgsAttributes (int size, const QVariant &v)
 Constructs a vector with an initial size of size elements. More...
 
bool isUnsetValue (int index) const
 Returns true if the attribute at the specified index is an unset value. More...
 
bool operator!= (const QgsAttributes &v) const
 
bool operator== (const QgsAttributes &v) const
 Compares two vectors of attributes. More...
 
CORE_EXPORT QgsAttributeMap toMap () const
 Returns a QgsAttributeMap of the attribute values. More...
 

Detailed Description

A vector of attributes.

Mostly equal to QVector<QVariant>.

Note
QgsAttributes is implemented as a Python list of Python objects.

Definition at line 58 of file qgsattributes.h.

Constructor & Destructor Documentation

◆ QgsAttributes() [1/4]

QgsAttributes::QgsAttributes ( )
default

Constructor for QgsAttributes.

◆ QgsAttributes() [2/4]

QgsAttributes::QgsAttributes ( int  size)
inline

Create a new vector of attributes with the given size.

Parameters
sizeNumber of attributes

Definition at line 70 of file qgsattributes.h.

◆ QgsAttributes() [3/4]

QgsAttributes::QgsAttributes ( int  size,
const QVariant &  v 
)
inline

Constructs a vector with an initial size of size elements.

Each element is initialized with value.

Parameters
sizeNumber of elements
vInitial value

Definition at line 79 of file qgsattributes.h.

◆ QgsAttributes() [4/4]

QgsAttributes::QgsAttributes ( const QVector< QVariant > &  v)
inline

Copies another vector of attributes.

Parameters
vAttributes to copy

Definition at line 87 of file qgsattributes.h.

Member Function Documentation

◆ isUnsetValue()

bool QgsAttributes::isUnsetValue ( int  index) const
inline

Returns true if the attribute at the specified index is an unset value.

See also
QgsUnsetAttributeValue

Definition at line 129 of file qgsattributes.h.

◆ operator!=()

bool QgsAttributes::operator!= ( const QgsAttributes v) const
inline

Definition at line 137 of file qgsattributes.h.

◆ operator==()

bool QgsAttributes::operator== ( const QgsAttributes v) const
inline

Compares two vectors of attributes.

They are considered equal if all their members contain the same value and NULL flag. This was introduced because the default Qt implementation of QVariant comparison does not handle NULL values for certain types (like int).

Parameters
vThe attributes to compare
Returns
true if v is equal

Definition at line 100 of file qgsattributes.h.

◆ toMap()

QgsAttributeMap QgsAttributes::toMap ( ) const

Returns a QgsAttributeMap of the attribute values.

Null values are excluded from the map.

Note
not available in Python bindings

Definition at line 21 of file qgsattributes.cpp.


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