QGIS API Documentation  3.5.0-Master (bc98f86)
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.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 
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->toAscii() );
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->toAscii() );
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->toAscii() );
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 = 0 );
182 #endif
183 
189 #ifndef SIP_RUN
190  QgsFeature( const QgsFields &fields, QgsFeatureId id = QgsFeatureId() );
191 #else
192  QgsFeature( const QgsFields &fields, qint64 id = 0 );
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 
247  void setAttributes( const QgsAttributes &attrs );
248 
259 #ifndef SIP_RUN
260  bool setAttribute( int field, const QVariant &attr );
261 #else
262  bool setAttribute( int field, const QVariant &attr / GetWrapper / );
263  % MethodCode
264  bool rv;
265 
266  if ( a1Wrapper == Py_None )
267  {
268  rv = sipCpp->setAttribute( a0, QVariant( QVariant::Int ) );
269  }
270  else
271  {
272  rv = sipCpp->setAttribute( a0, *a1 );
273  }
274 
275  if ( !rv )
276  {
277  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
278  sipIsErr = 1;
279  }
280 
281  sipRes = rv;
282  % End
283 #endif
284 
289  void initAttributes( int fieldCount );
290 
298  void deleteAttribute( int field );
299 #ifdef SIP_RUN
300  % MethodCode
301  if ( a0 >= 0 && a0 < sipCpp->attributes().count() )
302  sipCpp->deleteAttribute( a0 );
303  else
304  {
305  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
306  sipIsErr = 1;
307  }
308  % End
309 #endif
310 
317  bool isValid() const;
318 
324  void setValid( bool validity );
325 
331  bool hasGeometry() const;
332 
339  QgsGeometry geometry() const;
340 
347  void setGeometry( const QgsGeometry &geometry );
348 
375 #ifndef SIP_RUN
376  void setGeometry( std::unique_ptr< QgsAbstractGeometry > geometry );
377 #else
378  void setGeometry( QgsAbstractGeometry *geometry SIP_TRANSFER );
379  % MethodCode
380  sipCpp->setGeometry( std::unique_ptr< QgsAbstractGeometry>( a0 ) );
381  % End
382 #endif
383 
390  void clearGeometry();
391 
401  void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) );
402 
407  QgsFields fields() const;
408 
420 #ifndef SIP_RUN
421  bool setAttribute( const QString &name, const QVariant &value );
422 #else
423  void setAttribute( const QString &name, const QVariant &value / GetWrapper / );
424  % MethodCode
425  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
426  if ( fieldIdx == -1 )
427  {
428  PyErr_SetString( PyExc_KeyError, a0->toAscii() );
429  sipIsErr = 1;
430  }
431  else
432  {
433  if ( a1Wrapper == Py_None )
434  {
435  sipCpp->setAttribute( *a0, QVariant( QVariant::Int ) );
436  }
437  else
438  {
439  sipCpp->setAttribute( fieldIdx, *a1 );
440  }
441  }
442  % End
443 #endif
444 
454  bool deleteAttribute( const QString &name );
455 #ifdef SIP_RUN
456  % MethodCode
457  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
458  if ( fieldIdx == -1 )
459  {
460  PyErr_SetString( PyExc_KeyError, a0->toAscii() );
461  sipIsErr = 1;
462  sipRes = false;
463  }
464  else
465  {
466  sipCpp->deleteAttribute( fieldIdx );
467  sipRes = true;
468  }
469  % End
470 #endif
471 
481 #ifndef SIP_RUN
482  QVariant attribute( const QString &name ) const;
483 #else
484  SIP_PYOBJECT attribute( const QString &name ) const;
485  % MethodCode
486  int fieldIdx = sipCpp->fieldNameIndex( *a0 );
487  if ( fieldIdx == -1 )
488  {
489  PyErr_SetString( PyExc_KeyError, a0->toAscii() );
490  sipIsErr = 1;
491  }
492  else
493  {
494  QVariant *v = new QVariant( sipCpp->attribute( fieldIdx ) );
495  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
496  }
497  % End
498 #endif
499 
509 #ifndef SIP_RUN
510  QVariant attribute( int fieldIdx ) const;
511 #else
512  SIP_PYOBJECT attribute( int fieldIdx ) const;
513  % MethodCode
514  {
515  if ( a0 < 0 || a0 >= sipCpp->attributes().count() )
516  {
517  PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
518  sipIsErr = 1;
519  }
520  else
521  {
522  QVariant *v = new QVariant( sipCpp->attribute( a0 ) );
523  sipRes = sipConvertFromNewType( v, sipType_QVariant, Py_None );
524  }
525  }
526  % End
527 #endif
528 
536  int fieldNameIndex( const QString &fieldName ) const;
537 
539  operator QVariant() const
540  {
541  return QVariant::fromValue( *this );
542  }
543 
544  private:
545 
546  QExplicitlySharedDataPointer<QgsFeaturePrivate> d;
547 
548 }; // class QgsFeature
549 
551 CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsFeature &feature ) SIP_SKIP;
553 CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsFeature &feature ) SIP_SKIP;
554 
555 // key = feature id, value = changed attributes
556 #ifndef SIP_RUN
557 typedef QMap<QgsFeatureId, QgsAttributeMap> QgsChangedAttributesMap;
558 #else
559 typedef QMap<qint64, QMap<int, QVariant> > QgsChangedAttributesMap;
560 #endif
561 
562 #include "qgsgeometry.h"
563 
564 // key = feature id, value = changed geometry
565 #ifndef SIP_RUN
566 typedef QMap<QgsFeatureId, QgsGeometry> QgsGeometryMap;
567 #else
568 typedef QMap<qint64, QgsGeometry> QgsGeometryMap;
569 #endif
570 
571 typedef QList<QgsFeature> QgsFeatureList;
572 
573 uint qHash( const QgsFeature &key, uint seed = 0 ) SIP_SKIP;
574 
576 Q_DECLARE_METATYPE( QgsFeatureList )
577 
578 #endif
QMap< QgsFeatureId, QgsGeometry > QgsGeometryMap
Definition: qgsfeature.h:566
A rectangle specified with double values.
Definition: qgsrectangle.h:40
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25
Container of fields for a vector layer.
Definition: qgsfields.h:42
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:106
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Q_DECLARE_METATYPE(QModelIndex)
#define SIP_SKIP
Definition: qgis_sip.h:119
void seed(uint32_t value)
#define SIP_TRANSFER
Definition: qgis_sip.h:36
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:48
Abstract base class for all geometries.
QMap< QgsFeatureId, QgsAttributeMap > QgsChangedAttributesMap
Definition: qgsfeature.h:557
uint qHash(const QgsFeature &key, uint seed=0)
Definition: qgsfeature.cpp:319
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:305
CORE_EXPORT QDataStream & operator<<(QDataStream &out, const QgsFeature &feature)
Writes the feature to stream out. QGIS version compatibility is not guaranteed.
Definition: qgsfeature.cpp:288
A vector of attributes.
Definition: qgsattributes.h:57
#define SIP_PYARGDEFAULT(value)
Definition: qgis_sip.h:134