qgsgraph.h

Go to the documentation of this file.

/***************************************************************************
  qgsgraph.h
  --------------------------------------
  Date                 : 2011-04-01
  Copyright            : (C) 2010 by Yakushev Sergey
  Email                : YakushevS <at> list.ru
****************************************************************************
*                                                                          *
*   This program is free software; you can redistribute it and/or modify   *
*   it under the terms of the GNU General Public License as published by   *
*   the Free Software Foundation; either version 2 of the License, or      *
*   (at your option) any later version.                                    *
*                                                                          *
***************************************************************************/
 
/*
 * This file describes the built-in QGIS classes for modeling a mathematical graph.
 * Vertices are identified by their geographic coordinates and have no additional
 * properties. Number of strategies for calculating edge cost is not limited.
 * Graph may have incidence edges.
 *
 * \file qgsgraph.h
 */
 
#ifndef QGSGRAPH_H
#define QGSGRAPH_H
 
#include <QList>
#include <QVector>
#include <QVariant>
 
#include "qgspointxy.h"
#include "qgis_analysis.h"
 
class QgsGraphVertex;
 
 
class ANALYSIS_EXPORT QgsGraphEdge
{
  public:
 
    QgsGraphEdge() = default;
 
    QVariant cost( int strategyIndex ) const;
 
    QVector< QVariant > strategies() const;
 
    int toVertex() const;
 
    int fromVertex() const;
 
  private:
 
    QVector< QVariant > mStrategies;
 
    int mToIdx = 0;
    int mFromIdx = 0;
 
    friend class QgsGraph;
};
 
 
typedef QList< int > QgsGraphEdgeIds;
 
class ANALYSIS_EXPORT QgsGraphVertex
{
  public:
 
    QgsGraphVertex() = default;
 
    QgsGraphVertex( const QgsPointXY &point );
 
    QgsGraphEdgeIds incomingEdges() const;
 
    QgsGraphEdgeIds outgoingEdges() const;
 
    QgsPointXY point() const;
 
  private:
    QgsPointXY mCoordinate;
    QgsGraphEdgeIds mIncomingEdges;
    QgsGraphEdgeIds mOutgoingEdges;
 
    friend class QgsGraph;
};
 
class ANALYSIS_EXPORT QgsGraph
{
  public:
 
    QgsGraph() = default;
 
    // Graph constructing methods
 
    int addVertex( const QgsPointXY &pt );
 
    int addEdge( int fromVertexIdx, int toVertexIdx, const QVector< QVariant > &strategies );
 
    int vertexCount() const;
 
#ifndef SIP_RUN
 
    const QgsGraphVertex &vertex( int idx ) const;
#else
 
    QgsGraphVertex vertex( int idx ) const;
    % MethodCode
    if ( sipCpp->hasVertex( a0 ) )
    {
      return sipConvertFromNewType( new QgsGraphVertex( sipCpp->vertex( a0 ) ), sipType_QgsGraphVertex, Py_None );
    }
    else
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    void removeVertex( int index );
#else
 
    void removeVertex( int index );
    % MethodCode
    if ( sipCpp->hasVertex( a0 ) )
    {
      sipCpp->removeVertex( a0 );
    }
    else
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    % End
#endif
 
    int edgeCount() const;
 
#ifndef SIP_RUN
 
    const QgsGraphEdge &edge( int idx ) const;
#else
 
    QgsGraphEdge edge( int idx ) const;
    % MethodCode
    if ( sipCpp->hasEdge( a0 ) )
    {
      return sipConvertFromNewType( new QgsGraphEdge( sipCpp->edge( a0 ) ), sipType_QgsGraphEdge, Py_None );
    }
    else
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    % End
#endif
 
 
#ifndef SIP_RUN
 
    void removeEdge( int index );
#else
 
    void removeEdge( int index );
    % MethodCode
    if ( sipCpp->hasEdge( a0 ) )
    {
      sipCpp->removeEdge( a0 );
    }
    else
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    % End
#endif
 
    int findVertex( const QgsPointXY &pt ) const;
 
#ifndef SIP_RUN
 
    int findOppositeEdge( int index ) const;
#else
 
    int findOppositeEdge( int index ) const;
    % MethodCode
    if ( sipCpp->hasEdge( a0 ) )
    {
      sipRes = sipCpp->findOppositeEdge( a0 );
    }
    else
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    % End
#endif
 
    bool hasEdge( int index ) const;
 
    bool hasVertex( int index ) const;
 
  protected:
 
#ifndef SIP_RUN
    QHash<int, QgsGraphVertex> mGraphVertices;
 
    QHash<int, QgsGraphEdge> mGraphEdges;
#endif
 
 
  private:
 
    int mNextVertexId = 0;
    int mNextEdgeId = 0;
};
 
#endif // QGSGRAPH_H