initial sipification of the network analysis library

qgis · May 4, 2017 · 77d34dd · 77d34dd
1 parent 3b43543
commit 77d34dd
Show file tree

Hide file tree

Showing 14 changed files with 501 additions and 243 deletions.
diff --git a/python/analysis/network/qgsgraph.sip b/python/analysis/network/qgsgraph.sip
@@ -1,131 +1,164 @@
-/**
- * \ingroup analysis
- * \class QgsGraphEdge
- * \brief This class implements a graph edge
- */
+/************************************************************************
+ * 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
 {
-%TypeHeaderCode
-#include <qgsgraph.h>
+%Docstring
+.. versionadded:: 3.0
+ This class implements a graph edge
 %End
 
+%TypeHeaderCode
+#include "qgsgraph.h"
+%End
   public:
     QgsGraphEdge();
 
-    /**
-     * Returns edge cost calculated using specified strategy
-     * @param strategyIndex strategy index
-     */
     QVariant cost( int strategyIndex ) const;
+%Docstring
+ Returns edge cost calculated using specified strategy
+ \param strategyIndex strategy index
+ :rtype: QVariant
+%End
 
-    /**
-     * Returns array of available strategies
-     */
     QVector< QVariant > strategies() const;
+%Docstring
+ Returns array of available strategies
+ :rtype: list of QVariant
+%End
 
-    /**
-     * Returns index of the outgoing vertex
-     */
     int outVertex() const;
+%Docstring
+ Returns index of the outgoing vertex
+ :rtype: int
+%End
 
-    /**
-     * Returns index of the incoming vertex
-     */
     int inVertex() const;
+%Docstring
+ Returns index of the incoming vertex
+ :rtype: int
+%End
+
 };
 
 
 typedef QList< int > QgsGraphEdgeIds;
 
-/**
- * \ingroup analysis
- * \class QgsGraphVertex
- * \brief This class implements a graph vertex
- */
 class QgsGraphVertex
 {
-%TypeHeaderCode
-#include <qgsgraph.h>
+%Docstring
+ This class implements a graph vertex
 %End
 
+%TypeHeaderCode
+#include "qgsgraph.h"
+%End
   public:
-    /**
-     * Default constructor. It is needed for Qt's container, e.g. QVector
-     */
+
     QgsGraphVertex();
+%Docstring
+ Default constructor. It is needed for Qt's container, e.g. QVector
+%End
 
-    /**
-     * This constructor initializes QgsGraphVertex object and associates a vertex with a point
-     */
 
     QgsGraphVertex( const QgsPoint &point );
+%Docstring
+ This constructor initializes QgsGraphVertex object and associates a vertex with a point
+%End
 
-    /**
-     * Returns outgoing edges ids
-     */
     QgsGraphEdgeIds outEdges() const;
+%Docstring
+ Returns outgoing edges ids
+ :rtype: QgsGraphEdgeIds
+%End
 
-    /**
-     * Return incoming edges ids
-     */
     QgsGraphEdgeIds inEdges() const;
+%Docstring
+ Return incoming edges ids
+ :rtype: QgsGraphEdgeIds
+%End
 
-    /**
-     * Returns point associated with graph vertex
-     */
     QgsPoint point() const;
+%Docstring
+ Returns point associated with graph vertex
+ :rtype: QgsPoint
+%End
+
 };
 
-/**
- * \ingroup analysis
- * \class QgsGraph
- * \brief Mathematical graph representation
- */
 
 class QgsGraph
 {
-%TypeHeaderCode
-#include <qgsgraph.h>
+%Docstring
+ Mathematical graph representation
 %End
 
+%TypeHeaderCode
+#include "qgsgraph.h"
+%End
   public:
     QgsGraph();
 
-    // Graph constructing methods
 
-    /**
-     * Add a vertex to the graph
-     */
     int addVertex( const QgsPoint &pt );
+%Docstring
+ Add a vertex to the graph
+ :rtype: int
+%End
 
-    /**
-     * Add an edge to the graph
-     */
     int addEdge( int outVertexIdx, int inVertexIdx, const QVector< QVariant > &strategies );
+%Docstring
+ Add an edge to the graph
+ :rtype: int
+%End
 
-    /**
-     * Returns number of graph vertices
-     */
     int vertexCount() const;
+%Docstring
+ Returns number of graph vertices
+ :rtype: int
+%End
 
-    /**
-     * Returns vertex at given index
-     */
     const QgsGraphVertex &vertex( int idx ) const;
+%Docstring
+ Returns vertex at given index
+ :rtype: QgsGraphVertex
+%End
 
-    /**
-      * Returns number of graph edges
-      */
     int edgeCount() const;
+%Docstring
+ Returns number of graph edges
+ :rtype: int
+%End
 
-    /**
-     * Returns edge at given index
-     */
     const QgsGraphEdge &edge( int idx ) const;
+%Docstring
+ Returns edge at given index
+ :rtype: QgsGraphEdge
+%End
 
-    /**
-     * Find vertex by associated point
-     * \return vertex index
-     */
     int findVertex( const QgsPoint &pt ) const;
+%Docstring
+ Find vertex by associated point
+ :return: vertex index
+ :rtype: int
+%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   *
+ ************************************************************************/
diff --git a/python/analysis/network/qgsgraphbuilder.sip b/python/analysis/network/qgsgraphbuilder.sip
@@ -1,32 +1,53 @@
-/**
-* \ingroup analysis
-* \class QgsGraphBuilder
-* \brief This class making the QgsGraph object
-*/
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/analysis/network/qgsgraphbuilder.h                               *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
 
 class QgsGraphBuilder : QgsGraphBuilderInterface
 {
-%TypeHeaderCode
-#include <qgsgraphbuilder.h>
+%Docstring
+ This class used for making the QgsGraph object
 %End
 
+%TypeHeaderCode
+#include "qgsgraphbuilder.h"
+%End
   public:
-    /**
-     * Default constructor
-     */
+
     QgsGraphBuilder( const QgsCoordinateReferenceSystem &crs, bool otfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" );
+%Docstring
+ Default constructor
+%End
 
     ~QgsGraphBuilder();
 
-    /*
-     * MANDATORY BUILDER PROPERTY DECLARATION
-     */
     virtual void addVertex( int id, const QgsPoint &pt );
+%Docstring
+ MANDATORY BUILDER PROPERTY DECLARATION
+%End
 
     virtual void addEdge( int pt1id, const QgsPoint &pt1, int pt2id, const QgsPoint &pt2, const QVector< QVariant > &prop );
 
-    /**
-     * Returns generated QgsGraph
-     */
     QgsGraph *graph() /Factory/;
+%Docstring
+ Returns generated QgsGraph
+ :rtype: QgsGraph
+%End
+
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/analysis/network/qgsgraphbuilder.h                               *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/