Skip to content
Permalink
Browse files

Tag geometry check classes as technology preview

  • Loading branch information
m-kuhn committed Oct 15, 2018
1 parent 3aebf0f commit 36e83f31c03697f0c160d514a67970b373174f17
@@ -15,6 +15,12 @@ class QgsFeaturePool : QgsFeatureSink /Abstract/
{
%Docstring
A feature pool is based on a vector layer and caches features.

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

%TypeHeaderCode
@@ -13,20 +13,16 @@
class QgsGeometryCheck
{
%Docstring
*************************************************************************
qgsgeometrycheck.h
---------------------
begin : September 2014
copyright : (C) 2014 by Sandro Mani / Sourcepole AG
email : smani at sourcepole dot ch
**************************************************************************

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. *

**************************************************************************
This class manages all known geometry check factories.

QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
:py:func:`QgsAnalysis.geometryCheckRegistry()`

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

%TypeHeaderCode
@@ -11,18 +11,16 @@




class QgsGeometryCheckError
{
%Docstring
*************************************************************************
This represents an error reported by a geometry check.

.. note::

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. *
This class is a technology preview and unstable API.

**************************************************************************
.. versionadded:: 3.4
%End

%TypeHeaderCode
@@ -10,17 +10,18 @@




class QgsGeometryCheckerUtils
{
%Docstring
*************************************************************************

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. *
Contains utilities required for geometry checks.

.. note::

This class is a technology preview and unstable API.

**************************************************************************
.. versionadded:: 3.4
%End

%TypeHeaderCode
@@ -12,14 +12,6 @@



class QgsGeometryCheckFactory /Abstract/
{

%TypeHeaderCode
#include "qgsgeometrycheckfactory.h"
%End
public:

virtual ~QgsGeometryCheckFactory();

virtual QgsGeometryCheck *createGeometryCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration ) const = 0 /Factory/;
@@ -19,6 +19,10 @@ This class manages all known geometry check factories.
QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
:py:func:`QgsAnalysis.geometryCheckRegistry()`

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

@@ -17,6 +17,10 @@ class QgsSingleGeometryCheckError

An error from a QgsSingleGeometryCheck.

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

@@ -78,6 +82,10 @@ class QgsGeometryCheckErrorSingle : QgsGeometryCheckError
Wraps a QgsSingleGeometryError into a standard :py:class:`QgsGeometryCheckError`.
The single error can be obtained via singleError.

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

@@ -31,6 +31,9 @@ class QgsVectorLayer;
/**
* \ingroup analysis
* A feature pool is based on a vector layer and caches features.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsFeaturePool : public QgsFeatureSink SIP_ABSTRACT
{
@@ -31,6 +31,16 @@
class QgsGeometryCheckError;
class QgsFeaturePool;

/**
* \ingroup analysis
* This class manages all known geometry check factories.
*
* QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
* QgsAnalysis::geometryCheckRegistry().
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsGeometryCheck
{
Q_GADGET
@@ -24,6 +24,7 @@
/**
* Base configuration for geometry checks.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
struct ANALYSIS_EXPORT QgsGeometryCheckContext
@@ -25,7 +25,13 @@

class QgsPointXY;


/**
* \ingroup analysis
* This represents an error reported by a geometry check.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsGeometryCheckError
{
public:
@@ -28,6 +28,15 @@ class QgsGeometryEngine;
class QgsFeaturePool;
class QgsFeedback;

/**
* \ingroup analysis
*
* Contains utilities required for geometry checks.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/

class ANALYSIS_EXPORT QgsGeometryCheckerUtils
{
public:
@@ -34,8 +34,12 @@ struct QgsGeometryCheckContext;

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryCheckFactory SIP_ABSTRACT
*
* A factory for geometry checks.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/class ANALYSIS_EXPORT QgsGeometryCheckFactory SIP_ABSTRACT
{
public:

@@ -35,6 +35,7 @@ struct QgsGeometryCheckContext;
* QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
* QgsAnalysis::geometryCheckRegistry().
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsGeometryCheckRegistry
@@ -33,6 +33,7 @@ class QgsSingleGeometryCheck;
*
* An error from a QgsSingleGeometryCheck.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsSingleGeometryCheckError
@@ -104,6 +105,7 @@ class ANALYSIS_EXPORT QgsSingleGeometryCheckError
* Wraps a QgsSingleGeometryError into a standard QgsGeometryCheckError.
* The single error can be obtained via singleError.
*
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT QgsGeometryCheckErrorSingle : public QgsGeometryCheckError

0 comments on commit 36e83f3

Please sign in to comment.
You can’t perform that action at this time.