QGIS/python/analysis/auto_generated/network/qgsgraphbuilder.sip.in
Nyall Dawson 602ef6c691 Don't start class briefs with "This class contains settings..."
It's unncessarily verbose, use just "Contains settings..." instead.
2025-03-30 20:48:07 +10:00

67 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/network/qgsgraphbuilder.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsGraphBuilder : QgsGraphBuilderInterface /NoDefaultCtors/
{
%Docstring(signature="appended")
Used for making the :py:class:`QgsGraph` object.
%End
%TypeHeaderCode
#include "qgsgraphbuilder.h"
%End
public:
QgsGraphBuilder( const QgsCoordinateReferenceSystem &crs, bool otfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" );
%Docstring
Default constructor
%End
~QgsGraphBuilder();
virtual void addVertex( int id, const QgsPointXY &pt );
%Docstring
MANDATORY BUILDER PROPERTY DECLARATION
%End
virtual void addEdge( int pt1id, const QgsPointXY &pt1, int pt2id, const QgsPointXY &pt2, const QVector<QVariant> &prop );
QgsGraph graph() const;
%Docstring
Returns the generated :py:class:`QgsGraph`.
The builder is left in its current state.
.. seealso:: :py:func:`takeGraph`
%End
QgsGraph *takeGraph() /Factory/;
%Docstring
Takes the generated graph from the builder, resetting the builder back to its initial
state ready for additional graph construction.
.. versionadded:: 3.22
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/network/qgsgraphbuilder.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/