QgsGraphBuilderInterface Class Reference

Determine interface for creating a graph. More...

#include <qgsgraphbuilderinterface.h>

Inheritance diagram for QgsGraphBuilderInterface:

Public Member Functions
	QgsGraphBuilderInterface (const QgsCoordinateReferenceSystem &crs, bool ctfEnabled=true, double topologyTolerance=0.0, const QString &ellipsoidID="WGS84")
	Default constructor. More...
virtual	~QgsGraphBuilderInterface ()=default
virtual void	addEdge (int pt1id, const QgsPointXY &pt1, int pt2id, const QgsPointXY &pt2, const QVector< QVariant > &strategies)
	Add edge to the graph. More...
virtual void	addVertex (int id, const QgsPointXY &pt)
	Add vertex to the graph. More...
bool	coordinateTransformationEnabled ()
	Returns coordinate transformation enabled. More...
QgsCoordinateReferenceSystem	destinationCrs () const
	Returns destinaltion CRS. More...
QgsDistanceArea *	distanceArea ()
	Returns measurement tool. More...
double	topologyTolerance ()
	Returns topology tolerance. More...

Detailed Description

Determine interface for creating a graph.

Contains the settings of the graph. QgsGraphBuilder and QgsGraphDirector both use a "builder" design pattern

Definition at line 40 of file qgsgraphbuilderinterface.h.

Constructor & Destructor Documentation

QgsGraphBuilderInterface()

QgsGraphBuilderInterface::QgsGraphBuilderInterface	(	const QgsCoordinateReferenceSystem &	crs,
		bool	ctfEnabled = true,
		double	topologyTolerance = 0.0,
		const QString &	ellipsoidID = "WGS84"
	)

Default constructor.

Parameters

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

Definition at line 20 of file qgsgraphbuilderinterface.cpp.

~QgsGraphBuilderInterface()

virtual QgsGraphBuilderInterface::~QgsGraphBuilderInterface ( )

virtualdefault

Member Function Documentation

addEdge()

void QgsGraphBuilderInterface::addEdge ( int  pt1id, const QgsPointXY &  pt1, int  pt2id, const QgsPointXY &  pt2, const QVector< QVariant > &  strategies  )

virtual

Add edge to the graph.

Parameters

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

Note

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

Reimplemented in QgsGraphBuilder.

Definition at line 36 of file qgsgraphbuilderinterface.cpp.

addVertex()

void QgsGraphBuilderInterface::addVertex ( int  id, const QgsPointXY &  pt  )

virtual

Add vertex to the graph.

Parameters

id	vertex identifier
pt	vertex coordinates

Note

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

Reimplemented in QgsGraphBuilder.

Definition at line 30 of file qgsgraphbuilderinterface.cpp.

coordinateTransformationEnabled()

bool QgsGraphBuilderInterface::coordinateTransformationEnabled ( )

inline

Returns coordinate transformation enabled.

Definition at line 73 of file qgsgraphbuilderinterface.h.

destinationCrs()

QgsCoordinateReferenceSystem QgsGraphBuilderInterface::destinationCrs ( ) const

inline

Returns destinaltion CRS.

Definition at line 67 of file qgsgraphbuilderinterface.h.

distanceArea()

QgsDistanceArea* QgsGraphBuilderInterface::distanceArea ( )

inline

Returns measurement tool.

Definition at line 85 of file qgsgraphbuilderinterface.h.

topologyTolerance()

double QgsGraphBuilderInterface::topologyTolerance ( )

inline

Returns topology tolerance.

Definition at line 79 of file qgsgraphbuilderinterface.h.

---

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

• /build/qgis-3.16.0+99unstable/src/analysis/network/qgsgraphbuilderinterface.h
• /build/qgis-3.16.0+99unstable/src/analysis/network/qgsgraphbuilderinterface.cpp