qgsfeaturesink.h

Go to the documentation of this file.

/***************************************************************************
                         qgsfeaturesink.h
                         ----------------
    begin                : April 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSFEATURESINK_H
#define QGSFEATURESINK_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsfeature.h"
#include "qgsfeatureiterator.h"

class CORE_EXPORT QgsFeatureSink
{
  public:

    enum SinkFlag SIP_ENUM_BASETYPE( IntFlag )
    {

      RegeneratePrimaryKey = 1 << 1,
    };
    Q_DECLARE_FLAGS( SinkFlags, SinkFlag )
 
    
    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {

      FastInsert = 1 << 1,

      RollBackOnErrors = 1 << 2,
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    virtual ~QgsFeatureSink() = default;

    virtual void finalize();

    virtual bool addFeature( QgsFeature &feature, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() );

    virtual bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() ) = 0;

    virtual bool addFeatures( QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() );

    virtual bool flushBuffer() { return true; }

    virtual QString lastError() const { return QString(); }
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFeatureSink::Flags )
 
Q_DECLARE_METATYPE( QgsFeatureSink * )
 
#endif // QGSFEATURESINK_H