File: qgsgraphbuilderinterface.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (105 lines) | stat: -rw-r--r-- 3,256 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/network/qgsgraphbuilderinterface.h                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





%ModuleHeaderCode
#include <qgsgraphbuilder.h>
%End

class QgsGraphBuilderInterface
{
%Docstring(signature="appended")
Determine interface for creating a graph. Contains the settings of the
graph. :py:class:`QgsGraphBuilder` and :py:class:`QgsGraphDirector` both
use a "builder" design pattern
%End

%TypeHeaderCode
#include "qgsgraphbuilderinterface.h"
%End
%ConvertToSubClassCode
    if ( dynamic_cast<QgsGraphBuilder *>( sipCpp ) != NULL )
      sipType = sipType_QgsGraphBuilder;
    else
      sipType = NULL;
%End
  public:
    QgsGraphBuilderInterface( const QgsCoordinateReferenceSystem &crs, bool ctfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" );
%Docstring
Default constructor

:param crs: Coordinate reference system for new graph vertex
:param ctfEnabled: enable coordinate transform from source graph CRS to
                   CRS graph
:param topologyTolerance: sqrt distance between source point as one
                          graph vertex
:param ellipsoidID: ellipsoid for edge measurement
%End

    virtual ~QgsGraphBuilderInterface();

    QgsCoordinateReferenceSystem destinationCrs() const;
%Docstring
Returns destinaltion CRS
%End

    bool coordinateTransformationEnabled() const;
%Docstring
Returns coordinate transformation enabled
%End

    double topologyTolerance() const;
%Docstring
Returns topology tolerance
%End

    QgsDistanceArea *distanceArea();
%Docstring
Returns measurement tool
%End

    virtual void addVertex( int id, const QgsPointXY &pt );
%Docstring
Add vertex to the graph

:param id: vertex identifier
:param pt: vertex coordinates

.. note::

   id and pt are redundant. You can use pt or id to identify the vertex
%End

    virtual void addEdge( int pt1id, const QgsPointXY &pt1, int pt2id, const QgsPointXY &pt2, const QVector<QVariant> &strategies );
%Docstring
Add edge to the graph

:param pt1id: first vertex identificator
:param pt1: first vertex coordinates
:param pt2id: second vertex identificator
:param pt2: second vertex coordinates
:param strategies: optimization strategies

.. note::

   pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators.
%End

};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/network/qgsgraphbuilderinterface.h                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/