QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgsfeature.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfeature.h - Spatial Feature Class
3  --------------------------------------
4 Date : 09-Sep-2003
5 Copyright : (C) 2003 by Gary E.Sherman
6 email : sherman at mrcc.com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSFEATURE_H
17 #define QGSFEATURE_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 
22 #include <QExplicitlySharedDataPointer>
23 #include <QList>
24 #include <QMap>
25 #include <QSet>
26 #include <QString>
27 #include <QVariant>
28 #include <QVector>
29 
30 #include "qgsattributes.h"
31 #include "qgsfields.h"
32 #include "qgsfeatureid.h"
33 #include <memory>
34 class QgsFeature;
35 class QgsFeaturePrivate;
36 class QgsField;
37 class QgsGeometry;
38 class QgsRectangle;
40 class QgsSymbol;
41 
42 /***************************************************************************
43  * This class is considered CRITICAL and any change MUST be accompanied with
44  * full unit tests in testqgsfeature.cpp.
45  * See details in QEP #17
46  ****************************************************************************/
47 
48 
55 class CORE_EXPORT QgsFeature
56 {
57 #ifdef SIP_RUN
58 #if (SIP_VERSION >= 0x040900 && SIP_VERSION < 0x040c01)
59 #define sipType_QVariant ((sipWrapperType *) sipTypeAsPyTypeObject (sipType_QVariant))
60 #endif
61 #endif
62  Q_GADGET
63 
64  Q_PROPERTY( QgsFeatureId id READ id WRITE setId )
65  Q_PROPERTY( QgsAttributes attributes READ attributes WRITE setAttributes )
66  Q_PROPERTY( QgsFields fields READ fields WRITE setFields )
67  Q_PROPERTY( QgsGeometry geometry READ geometry WRITE setGeometry )
68 
69  public:
70 
71 #ifdef SIP_RUN
72  SIP_PYOBJECT __iter__();
73  % MethodCode
74  QgsAttributes attributes = sipCpp->attributes();
75  PyObject *attrs = sipConvertFromType( &attributes, sipType_QgsAttributes, Py_None );
76  sipRes = PyObject_GetIter( attrs );
77  % End
78 
79  SIP_PYOBJECT __getitem__( int key );
80  % MethodCode
81  QgsAttributes attrs = sipCpp->attributes();
82  if ( a0 < 0 || a0 >= attrs.count() )
83  {
84  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
85  sipIsErr = 1;
86  }
87  else
88  {
89  QVariant *v = new QVariant( attrs.at( a0 ) );
90  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
91  }
92  % End
93 
94  SIP_PYOBJECT __getitem__( const QString &name );
95  % MethodCode
96  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
97  if ( fieldIdx == -1 )
98  {
99  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
100  sipIsErr = 1;
101  }
102  else
103  {
104  QVariant *v = new QVariant( sipCpp->attribute( fieldIdx ) );
105  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
106  }
107  % End
108 
109  void __setitem__( int key, QVariant value / GetWrapper / );
110  % MethodCode
111  bool rv;
112 
113  if ( a1Wrapper == Py_None )
114  {
115  rv = sipCpp->setAttribute( a0, QVariant( QVariant::Int ) );
116  }
117  else
118  {
119  rv = sipCpp->setAttribute( a0, *a1 );
120  }
121 
122  if ( !rv )
123  {
124  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
125  sipIsErr = 1;
126  }
127  % End
128 
129  void __setitem__( const QString &key, QVariant value / GetWrapper / );
130  % MethodCode
131  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
132  if ( fieldIdx == -1 )
133  {
134  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
135  sipIsErr = 1;
136  }
137  else
138  {
139  if ( a1Wrapper == Py_None )
140  {
141  sipCpp->setAttribute( *a0, QVariant( QVariant::Int ) );
142  }
143  else
144  {
145  sipCpp->setAttribute( fieldIdx, *a1 );
146  }
147  }
148  % End
149 
150  void __delitem__( int key );
151  % MethodCode
152  if ( a0 >= 0 && a0 < sipCpp->attributes().count() )
153  sipCpp->deleteAttribute( a0 );
154  else
155  {
156  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
157  sipIsErr = 1;
158  }
159  % End
160 
161  void __delitem__( const QString &name );
162  % MethodCode
163  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
164  if ( fieldIdx == -1 )
165  {
166  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
167  sipIsErr = 1;
168  }
169  else
170  sipCpp->deleteAttribute( fieldIdx );
171  % End
172 #endif
173 
178 #ifndef SIP_RUN
180 #else
181  QgsFeature( qint64 id = FID_NULL );
182 #endif
183 
189 #ifndef SIP_RUN
190  QgsFeature( const QgsFields &fields, QgsFeatureId id = FID_NULL );
191 #else
192  QgsFeature( const QgsFields &fields, qint64 id = FID_NULL );
193 #endif
194 
198  QgsFeature( const QgsFeature &rhs );
199 
203  QgsFeature &operator=( const QgsFeature &rhs ) SIP_SKIP;
204 
208  bool operator==( const QgsFeature &other ) const SIP_SKIP;
209 
213  bool operator!=( const QgsFeature &other ) const SIP_SKIP;
214 
215  virtual ~QgsFeature();
216 
221  QgsFeatureId id() const;
222 
231  void setId( QgsFeatureId id );
232 
249  QgsAttributes attributes() const;
250 
255  int attributeCount() const;
256 
273  void setAttributes( const QgsAttributes &attrs );
274 
275 #ifndef SIP_RUN
276 
287  bool setAttribute( int field, const QVariant &attr );
288 #else
289 
314  bool setAttribute( int field, const QVariant &attr / GetWrapper / );
315  % MethodCode
316  bool rv;
317 
318  if ( a1Wrapper == Py_None )
319  {
320  rv = sipCpp->setAttribute( a0, QVariant( QVariant::Int ) );
321  }
322  else
323  {
324  rv = sipCpp->setAttribute( a0, *a1 );
325  }
326 
327  if ( !rv )
328  {
329  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
330  sipIsErr = 1;
331  }
332 
333  sipRes = rv;
334  % End
335 #endif
336 
346  void initAttributes( int fieldCount );
347 
361  void resizeAttributes( int fieldCount );
362 
369  void padAttributes( int count );
370 
371 #ifndef SIP_RUN
372 
380  void deleteAttribute( int field );
381 #else
382 
407  void deleteAttribute( int field );
408  % MethodCode
409  if ( a0 >= 0 && a0 < sipCpp->attributes().count() )
410  sipCpp->deleteAttribute( a0 );
411  else
412  {
413  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
414  sipIsErr = 1;
415  }
416  % End
417 #endif
418 
427  bool isValid() const;
428 
436  void setValid( bool validity );
437 
443  bool hasGeometry() const;
444 
451  QgsGeometry geometry() const;
452 
462  void setGeometry( const QgsGeometry &geometry );
463 
494 #ifndef SIP_RUN
495  void setGeometry( std::unique_ptr< QgsAbstractGeometry > geometry );
496 #else
497  void setGeometry( QgsAbstractGeometry *geometry SIP_TRANSFER );
498  % MethodCode
499  sipCpp->setGeometry( std::unique_ptr< QgsAbstractGeometry>( a0 ) );
500  % End
501 #endif
502 
509  void clearGeometry();
510 
518  void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) );
519 
524  QgsFields fields() const;
525 
526 #ifndef SIP_RUN
527 
542  bool setAttribute( const QString &name, const QVariant &value );
543 #else
544 
573  void setAttribute( const QString &name, const QVariant &value / GetWrapper / );
574  % MethodCode
575  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
576  if ( fieldIdx == -1 )
577  {
578  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
579  sipIsErr = 1;
580  }
581  else
582  {
583  if ( a1Wrapper == Py_None )
584  {
585  sipCpp->setAttribute( *a0, QVariant( QVariant::Int ) );
586  }
587  else
588  {
589  sipCpp->setAttribute( fieldIdx, *a1 );
590  }
591  }
592  % End
593 #endif
594 
595 #ifndef SIP_RUN
596 
606  bool deleteAttribute( const QString &name );
607 #else
608 
638  bool deleteAttribute( const QString &name );
639  % MethodCode
640  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
641  if ( fieldIdx == -1 )
642  {
643  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
644  sipIsErr = 1;
645  sipRes = false;
646  }
647  else
648  {
649  sipCpp->deleteAttribute( fieldIdx );
650  sipRes = true;
651  }
652  % End
653 #endif
654 
655 #ifndef SIP_RUN
656 
666  QVariant attribute( const QString &name ) const;
667 #else
668 
694  SIP_PYOBJECT attribute( const QString &name ) const;
695  % MethodCode
696  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
697  if ( fieldIdx == -1 )
698  {
699  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
700  sipIsErr = 1;
701  }
702  else
703  {
704  QVariant *v = new QVariant( sipCpp->attribute( fieldIdx ) );
705  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
706  }
707  % End
708 #endif
709 
710 #ifndef SIP_RUN
711 
719  QVariant attribute( int fieldIdx ) const;
720 #else
721 
746  SIP_PYOBJECT attribute( int fieldIdx ) const;
747  % MethodCode
748  {
749  if ( a0 < 0 || a0 >= sipCpp->attributes().count() )
750  {
751  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
752  sipIsErr = 1;
753  }
754  else
755  {
756  QVariant *v = new QVariant( sipCpp->attribute( a0 ) );
757  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
758  }
759  }
760  % End
761 #endif
762 
768  const QgsSymbol *embeddedSymbol() const;
769 
777  void setEmbeddedSymbol( QgsSymbol *symbol SIP_TRANSFER );
778 
788  int fieldNameIndex( const QString &fieldName ) const;
789 
799  int approximateMemoryUsage() const;
800 
802  operator QVariant() const
803  {
804  return QVariant::fromValue( *this );
805  }
806 
807  private:
808 
809  QExplicitlySharedDataPointer<QgsFeaturePrivate> d;
810 
811 }; // class QgsFeature
812 
814 CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsFeature &feature ) SIP_SKIP;
816 CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsFeature &feature ) SIP_SKIP;
817 
818 // key = feature id, value = changed attributes
819 #ifndef SIP_RUN
820 typedef QMap<QgsFeatureId, QgsAttributeMap> QgsChangedAttributesMap;
821 #else
822 typedef QMap<qint64, QMap<int, QVariant> > QgsChangedAttributesMap;
823 #endif
824 
825 #include "qgsgeometry.h"
826 
827 // key = feature id, value = changed geometry
828 #ifndef SIP_RUN
829 typedef QMap<QgsFeatureId, QgsGeometry> QgsGeometryMap;
830 #else
831 typedef QMap<qint64, QgsGeometry> QgsGeometryMap;
832 #endif
833 
834 typedef QList<QgsFeature> QgsFeatureList;
835 
836 uint qHash( const QgsFeature &key, uint seed = 0 ) SIP_SKIP;
837 
840 
841 #endif
Abstract base class for all geometries.
A vector of attributes.
Definition: qgsattributes.h:58
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:51
Container of fields for a vector layer.
Definition: qgsfields.h:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:124
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:38
#define SIP_PYARGDEFAULT(value)
Definition: qgis_sip.h:141
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QMap< QgsFeatureId, QgsGeometry > QgsGeometryMap
Definition: qgsfeature.h:829
CORE_EXPORT QDataStream & operator>>(QDataStream &in, QgsFeature &feature)
Reads a feature from stream in into feature. QGIS version compatibility is not guaranteed.
Definition: qgsfeature.cpp:397
QMap< QgsFeatureId, QgsAttributeMap > QgsChangedAttributesMap
Definition: qgsfeature.h:820
CORE_EXPORT QDataStream & operator<<(QDataStream &out, const QgsFeature &feature)
Writes the feature to stream out. QGIS version compatibility is not guaranteed.
Definition: qgsfeature.cpp:380
uint qHash(const QgsFeature &key, uint seed=0)
Definition: qgsfeature.cpp:411
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834
#define FID_NULL
Definition: qgsfeatureid.h:29
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
const QgsField & field
Definition: qgsfield.h:463
Q_DECLARE_METATYPE(QgsMeshTimeSettings)