QGIS API Documentation  3.21.0-Master (af9a72eda6)
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 
228  void setId( QgsFeatureId id );
229 
246  QgsAttributes attributes() const;
247 
252  int attributeCount() const;
253 
270  void setAttributes( const QgsAttributes &attrs );
271 
272 #ifndef SIP_RUN
273 
284  bool setAttribute( int field, const QVariant &attr );
285 #else
286 
311  bool setAttribute( int field, const QVariant &attr / GetWrapper / );
312  % MethodCode
313  bool rv;
314 
315  if ( a1Wrapper == Py_None )
316  {
317  rv = sipCpp->setAttribute( a0, QVariant( QVariant::Int ) );
318  }
319  else
320  {
321  rv = sipCpp->setAttribute( a0, *a1 );
322  }
323 
324  if ( !rv )
325  {
326  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
327  sipIsErr = 1;
328  }
329 
330  sipRes = rv;
331  % End
332 #endif
333 
343  void initAttributes( int fieldCount );
344 
358  void resizeAttributes( int fieldCount );
359 
366  void padAttributes( int count );
367 
368 #ifndef SIP_RUN
369 
377  void deleteAttribute( int field );
378 #else
379 
404  void deleteAttribute( int field );
405  % MethodCode
406  if ( a0 >= 0 && a0 < sipCpp->attributes().count() )
407  sipCpp->deleteAttribute( a0 );
408  else
409  {
410  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
411  sipIsErr = 1;
412  }
413  % End
414 #endif
415 
424  bool isValid() const;
425 
433  void setValid( bool validity );
434 
440  bool hasGeometry() const;
441 
448  QgsGeometry geometry() const;
449 
459  void setGeometry( const QgsGeometry &geometry );
460 
491 #ifndef SIP_RUN
492  void setGeometry( std::unique_ptr< QgsAbstractGeometry > geometry );
493 #else
494  void setGeometry( QgsAbstractGeometry *geometry SIP_TRANSFER );
495  % MethodCode
496  sipCpp->setGeometry( std::unique_ptr< QgsAbstractGeometry>( a0 ) );
497  % End
498 #endif
499 
506  void clearGeometry();
507 
515  void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) );
516 
521  QgsFields fields() const;
522 
523 #ifndef SIP_RUN
524 
539  bool setAttribute( const QString &name, const QVariant &value );
540 #else
541 
570  void setAttribute( const QString &name, const QVariant &value / GetWrapper / );
571  % MethodCode
572  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
573  if ( fieldIdx == -1 )
574  {
575  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
576  sipIsErr = 1;
577  }
578  else
579  {
580  if ( a1Wrapper == Py_None )
581  {
582  sipCpp->setAttribute( *a0, QVariant( QVariant::Int ) );
583  }
584  else
585  {
586  sipCpp->setAttribute( fieldIdx, *a1 );
587  }
588  }
589  % End
590 #endif
591 
592 #ifndef SIP_RUN
593 
603  bool deleteAttribute( const QString &name );
604 #else
605 
635  bool deleteAttribute( const QString &name );
636  % MethodCode
637  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
638  if ( fieldIdx == -1 )
639  {
640  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
641  sipIsErr = 1;
642  sipRes = false;
643  }
644  else
645  {
646  sipCpp->deleteAttribute( fieldIdx );
647  sipRes = true;
648  }
649  % End
650 #endif
651 
652 #ifndef SIP_RUN
653 
663  QVariant attribute( const QString &name ) const;
664 #else
665 
691  SIP_PYOBJECT attribute( const QString &name ) const;
692  % MethodCode
693  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
694  if ( fieldIdx == -1 )
695  {
696  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
697  sipIsErr = 1;
698  }
699  else
700  {
701  QVariant *v = new QVariant( sipCpp->attribute( fieldIdx ) );
702  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
703  }
704  % End
705 #endif
706 
707 #ifndef SIP_RUN
708 
716  QVariant attribute( int fieldIdx ) const;
717 #else
718 
743  SIP_PYOBJECT attribute( int fieldIdx ) const;
744  % MethodCode
745  {
746  if ( a0 < 0 || a0 >= sipCpp->attributes().count() )
747  {
748  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
749  sipIsErr = 1;
750  }
751  else
752  {
753  QVariant *v = new QVariant( sipCpp->attribute( a0 ) );
754  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
755  }
756  }
757  % End
758 #endif
759 
765  const QgsSymbol *embeddedSymbol() const;
766 
774  void setEmbeddedSymbol( QgsSymbol *symbol SIP_TRANSFER );
775 
785  int fieldNameIndex( const QString &fieldName ) const;
786 
796  int approximateMemoryUsage() const;
797 
799  operator QVariant() const
800  {
801  return QVariant::fromValue( *this );
802  }
803 
804  private:
805 
806  QExplicitlySharedDataPointer<QgsFeaturePrivate> d;
807 
808 }; // class QgsFeature
809 
811 CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsFeature &feature ) SIP_SKIP;
813 CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsFeature &feature ) SIP_SKIP;
814 
815 // key = feature id, value = changed attributes
816 #ifndef SIP_RUN
817 typedef QMap<QgsFeatureId, QgsAttributeMap> QgsChangedAttributesMap;
818 #else
819 typedef QMap<qint64, QMap<int, QVariant> > QgsChangedAttributesMap;
820 #endif
821 
822 #include "qgsgeometry.h"
823 
824 // key = feature id, value = changed geometry
825 #ifndef SIP_RUN
826 typedef QMap<QgsFeatureId, QgsGeometry> QgsGeometryMap;
827 #else
828 typedef QMap<qint64, QgsGeometry> QgsGeometryMap;
829 #endif
830 
831 typedef QList<QgsFeature> QgsFeatureList;
832 
833 uint qHash( const QgsFeature &key, uint seed = 0 ) SIP_SKIP;
834 
837 
838 #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:826
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:817
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:831
#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)