QGIS API Documentation  3.1.0-Master (cd495fb)
Public Member Functions | Friends | List of all members
QgsGraphEdge Class Reference

This class implements a graph edge. More...

#include <qgsgraph.h>

Public Member Functions

 QgsGraphEdge ()=default
 Constructor for QgsGraphEdge. More...
 
QVariant cost (int strategyIndex) const
 Returns edge cost calculated using specified strategy. More...
 
int fromVertex () const
 Returns the index of the vertex at the start of this edge. More...
 
QVector< QVariant > strategies () const
 Returns array of available strategies. More...
 
int toVertex () const
 Returns the index of the vertex at the end of this edge. More...
 

Friends

class QgsGraph
 

Detailed Description

This class implements a graph edge.

Since
QGIS 3.0

Definition at line 43 of file qgsgraph.h.

Constructor & Destructor Documentation

◆ QgsGraphEdge()

QgsGraphEdge::QgsGraphEdge ( )
default

Constructor for QgsGraphEdge.

Member Function Documentation

◆ cost()

QVariant QgsGraphEdge::cost ( int  strategyIndex) const

Returns edge cost calculated using specified strategy.

Parameters
strategyIndexstrategy index

Definition at line 78 of file qgsgraph.cpp.

◆ fromVertex()

int QgsGraphEdge::fromVertex ( ) const

Returns the index of the vertex at the start of this edge.

See also
toVertex()

Definition at line 88 of file qgsgraph.cpp.

◆ strategies()

QVector< QVariant > QgsGraphEdge::strategies ( ) const

Returns array of available strategies.

Definition at line 83 of file qgsgraph.cpp.

◆ toVertex()

int QgsGraphEdge::toVertex ( ) const

Returns the index of the vertex at the end of this edge.

See also
fromVertex()

Definition at line 93 of file qgsgraph.cpp.

Friends And Related Function Documentation

◆ QgsGraph

friend class QgsGraph
friend

Definition at line 82 of file qgsgraph.h.


The documentation for this class was generated from the following files: