File: qgsgraph.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (174 lines) | stat: -rw-r--r-- 3,686 bytes parent folder | download
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/network/qgsgraph.h                                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsGraphEdge
{
%Docstring(signature="appended")
This class implements a graph edge

.. versionadded:: 3.0
%End

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

    QgsGraphEdge();
%Docstring
Constructor for QgsGraphEdge.
%End

    QVariant cost( int strategyIndex ) const;
%Docstring
Returns edge cost calculated using specified strategy

:param strategyIndex: strategy index
%End

    QVector< QVariant > strategies() const;
%Docstring
Returns array of available strategies
%End

    int toVertex() const;
%Docstring
Returns the index of the vertex at the end of this edge.

.. seealso:: :py:func:`fromVertex`
%End

    int fromVertex() const;
%Docstring
Returns the index of the vertex at the start of this edge.

.. seealso:: :py:func:`toVertex`
%End

};


typedef QList< int > QgsGraphEdgeIds;

class QgsGraphVertex
{
%Docstring(signature="appended")
This class implements a graph vertex

.. versionadded:: 3.0
%End

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

    QgsGraphVertex();
%Docstring
Default constructor. It is needed for Qt's container, e.g. QVector
%End


    QgsGraphVertex( const QgsPointXY &point );
%Docstring
This constructor initializes QgsGraphVertex object and associates a vertex with a point
%End

    QgsGraphEdgeIds incomingEdges() const;
%Docstring
Returns the incoming edge ids, i.e. edges which end at this node.

.. seealso:: :py:func:`outgoingEdges`
%End

    QgsGraphEdgeIds outgoingEdges() const;
%Docstring
Returns outgoing edge ids, i.e. edges which start at this node.

.. seealso:: :py:func:`incomingEdges`
%End

    QgsPointXY point() const;
%Docstring
Returns point associated with graph vertex.
%End

};


class QgsGraph
{
%Docstring(signature="appended")
Mathematical graph representation

.. versionadded:: 3.0
%End

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

    QgsGraph();
%Docstring
Constructor for QgsGraph.
%End


    int addVertex( const QgsPointXY &pt );
%Docstring
Add a vertex to the graph
%End

    int addEdge( int fromVertexIdx, int toVertexIdx, const QVector< QVariant > &strategies );
%Docstring
Add an edge to the graph, going from the ``fromVertexIdx``
to ``toVertexIdx``.
%End

    int vertexCount() const;
%Docstring
Returns number of graph vertices
%End

    const QgsGraphVertex &vertex( int idx ) const;
%Docstring
Returns vertex at given index
%End

    int edgeCount() const;
%Docstring
Returns number of graph edges
%End

    const QgsGraphEdge &edge( int idx ) const;
%Docstring
Returns edge at given index
%End

    int findVertex( const QgsPointXY &pt ) const;
%Docstring
Find vertex by associated point

:return: vertex index
%End

};

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