sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-05 00:09:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

add classification methods to API docs

Browse Source
This commit is contained in:
Denis Rouzaud 2019-09-02 09:48:46 +02:00
parent 0cb0f6ef7a
commit 734e99e1e0
5 changed files with 44 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/CMakeLists.txt
View File

@ -58,6 +58,7 @@ IF(WITH_APIDOC)
${CMAKE_SOURCE_DIR}/src/core/annotations
${CMAKE_SOURCE_DIR}/src/core/auth
${CMAKE_SOURCE_DIR}/src/core/callouts
${CMAKE_SOURCE_DIR}/src/core/classification
${CMAKE_SOURCE_DIR}/src/core/diagram
${CMAKE_SOURCE_DIR}/src/core/dxf
${CMAKE_SOURCE_DIR}/src/core/effects

34
python/core/auto_generated/classification/qgsclassificationmethod.sip.in
View File

@ -26,6 +26,8 @@ class QgsClassificationRange
{
%Docstring
QgsClassificationRange contains the information about a classification range
.. versionadded:: 3.10
%End
%TypeHeaderCode
@ -57,7 +59,9 @@ Returns the lower bound
class QgsClassificationMethod /Abstract/
{
%Docstring
QgsClassification is an abstract class for implementations of classification methods
QgsClassificationMethod is an abstract class for implementations of classification methods
.. seealso:: :py:class:`QgsClassificationMethodRegistry`
.. versionadded:: 3.10
%End
@ -95,7 +99,6 @@ Creates a classification method.
:param valuesRequired: if ``True``, this means that the method requires a set of values to determine the classes
:param symmetricModeAvailable: if ``True``, this allows using symmetric classification
:param codeCommplexity: as the exponent in the big O notation
\param
%End
virtual ~QgsClassificationMethod();
@ -111,7 +114,10 @@ Implementation can take advantage of copyBase method which copies the parameters
The readable and translate name of the method
%End
virtual QString id() const = 0; // as saved in the project, must be unique in registry
virtual QString id() const = 0;
%Docstring
The id of the method as saved in the project, must be unique in registry
%End
virtual QString labelForRange( const double &lowerValue, const double &upperValue, ClassPosition position = Inner ) const;
%Docstring
@ -203,18 +209,16 @@ Transforms a list of classes to a list of breaks
QList<QgsClassificationRange> classes( const QgsVectorLayer *layer, const QString &expression, int nclasses );
%Docstring
This will calculate the breaks for a given layer to define the classes.
The breaks do not contain the uppper and lower bounds (minimum and maximum values).
This will calculate the classes for a given layer to define the classes.
:param layer: The vector layer
:param fieldName: The name of the field on which the classes are calculated
:param expression: The name of the field on which the classes are calculated
:param nclasses: The number of classes to be returned
%End
QList<QgsClassificationRange> classes( const QList<double> &values, int nclasses );
%Docstring
This will calculate the breaks for a list of values.
The breaks do not contain the uppper and lower bounds (minimum and maximum values)
This will calculate the classes for a list of values.
:param values: The list of values
:param nclasses: The number of classes to be returned
@ -223,27 +227,33 @@ The breaks do not contain the uppper and lower bounds (minimum and maximum value
QList<QgsClassificationRange> classes( double minimum, double maximum, int nclasses );
%Docstring
This will calculate the classes for defined bounds without any values.
The breaks do not contain the uppper and lower bounds (minimum and maximum values)
.. warning::
If the method implementation requires values, this will return an empty list.
:param values: The list of values
:param minimum: The minimum value for the breaks
:param maximum: The maximum value for the breaks
:param nclasses: The number of classes to be returned
%End
QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
%Docstring
save
@param doc
@param context
@return
%End
static QgsClassificationMethod *create( const QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
static void makeBreaksSymmetric( QList<double> &breaks /In,Out/, double symmetryPoint, bool symmetryAstride );
static void makeBreaksSymmetric( QList<double> &breaks /In,Out/, double symmetryPoint, bool astride );
%Docstring
Remove the breaks that are above the existing opposite sign classes to keep colors symmetrically balanced around symmetryPoint
Does not put a break on the symmetryPoint. This is done before.
:param breaks: The breaks of an already-done classification
:param symmetryPoint: The point around which we want a symmetry
:param symmetryAstride: A bool indicating if the symmetry is made astride the symmetryPoint or not ( [-1,1] vs. [-1,0][0,1] )
:param astride: A bool indicating if the symmetry is made astride the symmetryPoint or not ( [-1,1] vs. [-1,0][0,1] )
%End
QString labelForRange( const QgsRendererRange &range, ClassPosition position = Inner ) const;

2
python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in
View File

@ -36,7 +36,7 @@ Returns false if a method with same id already exists.
QgsClassificationMethod *method( const QString &id ) /Factory/;
%Docstring
Return a new instance of the method for the given id
Returns a new instance of the method for the given id
%End
QMap<QString, QString> methodNames() const;

32
src/core/classification/qgsclassificationmethod.h
View File

@ -16,6 +16,7 @@
#ifndef QGSCLASSIFICATIONMETHOD_H
#define QGSCLASSIFICATIONMETHOD_H
#include "qgis_sip.h"
#include "qgis_core.h"
#include "qgsprocessingparameters.h"
@ -40,6 +41,7 @@ class QgsRendererRange;
/**
* \ingroup core
* QgsClassificationRange contains the information about a classification range
* \since QGIS 3.10
*/
class CORE_EXPORT QgsClassificationRange
{
@ -68,7 +70,8 @@ class CORE_EXPORT QgsClassificationRange
/**
* \ingroup core
* QgsClassification is an abstract class for implementations of classification methods
* QgsClassificationMethod is an abstract class for implementations of classification methods
* \see QgsClassificationMethodRegistry
* \since QGIS 3.10
*/
class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
@ -106,7 +109,6 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
* \param valuesRequired if TRUE, this means that the method requires a set of values to determine the classes
* \param symmetricModeAvailable if TRUE, this allows using symmetric classification
* \param codeCommplexity as the exponent in the big O notation
* \param
*/
explicit QgsClassificationMethod( bool valuesRequired, bool symmetricModeAvailable, int codeComplexity = 1 );
@ -121,8 +123,8 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
//! The readable and translate name of the method
virtual QString name() const = 0;
//! The id of the method
virtual QString id() const = 0; // as saved in the project, must be unique in registry
//! The id of the method as saved in the project, must be unique in registry
virtual QString id() const = 0;
/**
* Returns the label for a range
@ -195,17 +197,15 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
static QList<double> listToValues( const QList<QgsClassificationRange> classes );
/**
* This will calculate the breaks for a given layer to define the classes.
* The breaks do not contain the uppper and lower bounds (minimum and maximum values).
* This will calculate the classes for a given layer to define the classes.
* \param layer The vector layer
* \param fieldName The name of the field on which the classes are calculated
* \param expression The name of the field on which the classes are calculated
* \param nclasses The number of classes to be returned
*/
QList<QgsClassificationRange> classes( const QgsVectorLayer *layer, const QString &expression, int nclasses );
/**
* This will calculate the breaks for a list of values.
* The breaks do not contain the uppper and lower bounds (minimum and maximum values)
* This will calculate the classes for a list of values.
* \param values The list of values
* \param nclasses The number of classes to be returned
*/
@ -213,13 +213,19 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
/**
* This will calculate the classes for defined bounds without any values.
* The breaks do not contain the uppper and lower bounds (minimum and maximum values)
* \warning If the method implementation requires values, this will return an empty list.
* \param values The list of values
* \param minimum The minimum value for the breaks
* \param maximum The maximum value for the breaks
* \param nclasses The number of classes to be returned
*/
QList<QgsClassificationRange> classes( double minimum, double maximum, int nclasses );
/**
* @brief save
* @param doc
* @param context
* @return
*/
QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
static QgsClassificationMethod *create( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
@ -228,9 +234,9 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
* Does not put a break on the symmetryPoint. This is done before.
* \param breaks The breaks of an already-done classification
* \param symmetryPoint The point around which we want a symmetry
* \param symmetryAstride A bool indicating if the symmetry is made astride the symmetryPoint or not ( [-1,1] vs. [-1,0][0,1] )
* \param astride A bool indicating if the symmetry is made astride the symmetryPoint or not ( [-1,1] vs. [-1,0][0,1] )
*/
static void makeBreaksSymmetric( QList<double> &breaks SIP_INOUT, double symmetryPoint, bool symmetryAstride );
static void makeBreaksSymmetric( QList<double> &breaks SIP_INOUT, double symmetryPoint, bool astride );
/**
* Returns the label for a range

2
src/core/classification/qgsclassificationmethodregistry.h
View File

@ -44,7 +44,7 @@ class CORE_EXPORT QgsClassificationMethodRegistry
*/
bool addMethod( QgsClassificationMethod *method SIP_TRANSFER );
//! Return a new instance of the method for the given id
//! Returns a new instance of the method for the given id
QgsClassificationMethod *method( const QString &id ) SIP_FACTORY;
//! Returns a map <id, name> of all registered methods