PyANGKernel.GKForceTurning¶

class GKForceTurning¶

Force a turn on a vehicle depending on its origin and/or destination (if OD matrices are used) or its desired turn.

Details

The user must specify the section where the action is applied and the turn that vehicles will be forced to take. Then the user must specify which vehicles on the section will be affected by this action, by setting either an OD-based condition or a Traffic State-based condition. With an OD-based condition, the OD pairs affected must be specified. An additional information item can be added, which consists of specifying a section belonging to the vehicle path downstream. That means that the turn will be forced for vehicles of the specified OD whose path goes through the specified section later on. The Traffic State-based condition will force the turn only for vehicles who intended to make the turn specified in the condition. Finally, the user can choose the vehicle class considered and the level of compliance for this action.

Synopsis¶

Methods¶

def __init__()
def areSubpathsCorrect()
def containsNextSection()
def getCentroidConfiguration()
def getDestinationCentroidOrGroup()
def getForceType()
def getNextSection()
def getNextSections()
def getNextSectionsData()
def getOriginCentroidOrGroup()
def getOriginalNextSection()
def getSectionInPath()
def getSubPathsPercentageType()
def getVisibilityDistance()
def setCentroidConfiguration()
def setDestinationCentroidOrGroup()
def setForceType()
def setNextSectionsData()
def setOriginCentroidOrGroup()
def setOriginalNextSection()
def setSectionInPath()
def setSubPathsPercentageType()
def setVisibilityDistance()
def turningExists()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class GKForceTurningType¶: For what type of traffic demand.

class GKForceTurningSubPathsPercentageType¶: Type of percentage to use in the subpaths list

__init__()¶

areSubpathsCorrect()¶

Return type:: bool

If true the subpaths is correct as the next section is on it.

containsNextSection(section)¶

Parameters:: section – GKSection
Return type:: bool

Returns true if the section is a next section in this force turn.

getCentroidConfiguration()¶

Return type:: GKCentroidConfiguration

Gets the related centroid configuration

getDestinationCentroidOrGroup()¶

Return type:: GKPolygon

Gets the destination centroid or centroid grouping of the affected car. Can be NULL, means ANY.

getForceType()¶

Return type:: GKForceTurningType

For what type of traffic demand.

getNextSection()¶

Return type:: GKSection

Gets the first next section.

getNextSections()¶

Return type:: .list of const GKSection

Gets the next sections.

getNextSectionsData()¶

Return type:: .list of GKForceTurningSectionData

Gets the next sections information.

getOriginCentroidOrGroup()¶

Return type:: GKPolygon

Gets the origin centroid or centroid grouping of the affected car. Can be NULL, means ANY.

getOriginalNextSection()¶

Return type:: GKSection

Gets the original turn of the affected car. Can be NULL, means ANY.

getSectionInPath()¶

Return type:: GKSection

getSubPathsPercentageType()¶

Return type:: GKForceTurningSubPathsPercentageType

Get type of percentage to use in the subpaths list

getVisibilityDistance()¶

Return type:: float

setCentroidConfiguration(config)¶

Parameters:: config – GKCentroidConfiguration

Sets the related centroid configuration

setDestinationCentroidOrGroup(centroidOrGroup)¶

Parameters:: centroidOrGroup – GKPolygon

Sets the destination centroid or centroid grouping of the affected car. Can be NULL, means ANY.

setForceType(atype)¶

Parameters:: atype – GKForceTurningType

Sets the traffic demand type.

setNextSectionsData(sectionsData)¶

Parameters:: sectionsData – .list of GKForceTurningSectionData

Sets the next sections information.

setOriginCentroidOrGroup(centroidOrGroup)¶

Parameters:: centroidOrGroup – GKPolygon

Sets the origin centroid or centroid grouping of the affected car. Can be NULL, means ANY.

setOriginalNextSection(section)¶

Parameters:: section – GKSection

Sets the original turn of the affected car. Can be NULL, means ANY.

setSectionInPath(section)¶

Parameters:: section – GKSection

setSubPathsPercentageType(atype)¶

Parameters:: atype – GKForceTurningSubPathsPercentageType

Sets the type of percentage to use in the subpaths list

setVisibilityDistance(value)¶

Parameters:: value – float

turningExists()¶

Return type:: bool

If true the turn from section to nextSection exists in the network.