Class: QgsVectorLayerDirector

Determines creating a graph from a vector line layer.

Class Hierarchy

Inheritance diagram of qgis.analysis.QgsVectorLayerDirector

Base classes

QgsGraphDirector

Determine making the graph. QgsGraphBuilder and QgsGraphDirector implemented using “builder” design patter.

QObject

class qgis.analysis.QgsVectorLayerDirector[source]

Bases: QgsGraphDirector

__init__(source: QgsFeatureSource | None, directionFieldId: int, directDirectionValue: str | None, reverseDirectionValue: str | None, bothDirectionValue: str | None, defaultDirection: QgsVectorLayerDirector.Direction)

Default constructor

Parameters:
  • source (Optional[QgsFeatureSource]) – feature source representing network

  • directionFieldId (int) – field containing direction value

  • directDirectionValue (Optional[str]) – value for direct one-way road

  • reverseDirectionValue (Optional[str]) – value for reversed one-way road

  • bothDirectionValue (Optional[str]) – value for two-way (bidirectional) road

  • defaultDirection (QgsVectorLayerDirector.Direction) – default direction. Will be used if corresponding attribute value is not set or does not equal to the given values

class Direction

Bases: int

DirectionBackward = 1
DirectionBoth = 2
DirectionForward = 0
virtual makeGraph(self, builder: QgsGraphBuilderInterface | None, additionalPoints: Iterable[QgsPointXY], feedback: QgsFeedback | None = None) List[QgsPointXY][source]

MANDATORY DIRECTOR PROPERTY DECLARATION

Parameters:
Return type:

List[QgsPointXY]