QGIS API Documentation  3.19.0-Master (c022ae99b5)
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 
222  QgsFeatureId id() const;
223 
229  void setId( QgsFeatureId id );
230 
238  QgsAttributes attributes() const;
239 
244  int attributeCount() const;
245 
257  void setAttributes( const QgsAttributes &attrs );
258 
269 #ifndef SIP_RUN
270  bool setAttribute( int field, const QVariant &attr );
271 #else
272  bool setAttribute( int field, const QVariant &attr / GetWrapper / );
273  % MethodCode
274  bool rv;
275 
276  if ( a1Wrapper == Py_None )
277  {
278  rv = sipCpp->setAttribute( a0, QVariant( QVariant::Int ) );
279  }
280  else
281  {
282  rv = sipCpp->setAttribute( a0, *a1 );
283  }
284 
285  if ( !rv )
286  {
287  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
288  sipIsErr = 1;
289  }
290 
291  sipRes = rv;
292  % End
293 #endif
294 
301  void initAttributes( int fieldCount );
302 
316  void resizeAttributes( int fieldCount );
317 
324  void padAttributes( int count );
325 
333  void deleteAttribute( int field );
334 #ifdef SIP_RUN
335  % MethodCode
336  if ( a0 >= 0 && a0 < sipCpp->attributes().count() )
337  sipCpp->deleteAttribute( a0 );
338  else
339  {
340  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
341  sipIsErr = 1;
342  }
343  % End
344 #endif
345 
352  bool isValid() const;
353 
359  void setValid( bool validity );
360 
366  bool hasGeometry() const;
367 
374  QgsGeometry geometry() const;
375 
382  void setGeometry( const QgsGeometry &geometry );
383 
411 #ifndef SIP_RUN
412  void setGeometry( std::unique_ptr< QgsAbstractGeometry > geometry );
413 #else
414  void setGeometry( QgsAbstractGeometry *geometry SIP_TRANSFER );
415  % MethodCode
416  sipCpp->setGeometry( std::unique_ptr< QgsAbstractGeometry>( a0 ) );
417  % End
418 #endif
419 
426  void clearGeometry();
427 
437  void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) );
438 
443  QgsFields fields() const;
444 
456 #ifndef SIP_RUN
457  bool setAttribute( const QString &name, const QVariant &value );
458 #else
459  void setAttribute( const QString &name, const QVariant &value / GetWrapper / );
460  % MethodCode
461  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
462  if ( fieldIdx == -1 )
463  {
464  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
465  sipIsErr = 1;
466  }
467  else
468  {
469  if ( a1Wrapper == Py_None )
470  {
471  sipCpp->setAttribute( *a0, QVariant( QVariant::Int ) );
472  }
473  else
474  {
475  sipCpp->setAttribute( fieldIdx, *a1 );
476  }
477  }
478  % End
479 #endif
480 
490  bool deleteAttribute( const QString &name );
491 #ifdef SIP_RUN
492  % MethodCode
493  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
494  if ( fieldIdx == -1 )
495  {
496  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
497  sipIsErr = 1;
498  sipRes = false;
499  }
500  else
501  {
502  sipCpp->deleteAttribute( fieldIdx );
503  sipRes = true;
504  }
505  % End
506 #endif
507 
517 #ifndef SIP_RUN
518  QVariant attribute( const QString &name ) const;
519 #else
520  SIP_PYOBJECT attribute( const QString &name ) const;
521  % MethodCode
522  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
523  if ( fieldIdx == -1 )
524  {
525  PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
526  sipIsErr = 1;
527  }
528  else
529  {
530  QVariant *v = new QVariant( sipCpp->attribute( fieldIdx ) );
531  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
532  }
533  % End
534 #endif
535 
545 #ifndef SIP_RUN
546  QVariant attribute( int fieldIdx ) const;
547 #else
548  SIP_PYOBJECT attribute( int fieldIdx ) const;
549  % MethodCode
550  {
551  if ( a0 < 0 || a0 >= sipCpp->attributes().count() )
552  {
553  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
554  sipIsErr = 1;
555  }
556  else
557  {
558  QVariant *v = new QVariant( sipCpp->attribute( a0 ) );
559  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
560  }
561  }
562  % End
563 #endif
564 
570  const QgsSymbol *embeddedSymbol() const;
571 
579  void setEmbeddedSymbol( QgsSymbol *symbol SIP_TRANSFER );
580 
588  int fieldNameIndex( const QString &fieldName ) const;
589 
599  int approximateMemoryUsage() const;
600 
602  operator QVariant() const
603  {
604  return QVariant::fromValue( *this );
605  }
606 
607  private:
608 
609  QExplicitlySharedDataPointer<QgsFeaturePrivate> d;
610 
611 }; // class QgsFeature
612 
614 CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsFeature &feature ) SIP_SKIP;
616 CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsFeature &feature ) SIP_SKIP;
617 
618 // key = feature id, value = changed attributes
619 #ifndef SIP_RUN
620 typedef QMap<QgsFeatureId, QgsAttributeMap> QgsChangedAttributesMap;
621 #else
622 typedef QMap<qint64, QMap<int, QVariant> > QgsChangedAttributesMap;
623 #endif
624 
625 #include "qgsgeometry.h"
626 
627 // key = feature id, value = changed geometry
628 #ifndef SIP_RUN
629 typedef QMap<QgsFeatureId, QgsGeometry> QgsGeometryMap;
630 #else
631 typedef QMap<qint64, QgsGeometry> QgsGeometryMap;
632 #endif
633 
634 typedef QList<QgsFeature> QgsFeatureList;
635 
636 uint qHash( const QgsFeature &key, uint seed = 0 ) SIP_SKIP;
637 
640 
641 #endif
Abstract base class for all geometries.
A vector of attributes.
Definition: qgsattributes.h:58
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
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:66
#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:629
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:620
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:634
#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)