PyMacroToolPlugin.MacroTraversalPars¶

class MacroTraversalPars¶

Traversal generation parameters

Details

This class contains the input & output parameters for a traversal generation: - subnetwork - macro assignment experiment containing the assignment - type of percentage in internal centroids: The different ways of assigning the percentages to the connections for the centroids that are created and located inside the sub-area. The options are: to assign the percentages that the static traffic assignment has calculated to each connection, to assign the same percentages they had in the original centroid configuration or to do not assign any percentage.

Synopsis¶

Methods¶

def __init__()
def getExperiment()
def getPTTravelTimeCalculationComponent()
def getProblemNet()
def getTypeOfPercentageInInternalCentroids()
def setExperiment()
def setPTTravelTimeCalculationComponent()
def setProblemNet()
def setTypeOfPercentageInInternalCentroids()

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 MacroTraversalPercentagesTypes¶

Traversal Percentages Types

The different ways of assigning the percentages to the connections for the centroids that are created but that have an equivalent centroid on the network. That is, the original centroids that are located inside the sub-area.

Constant

Description

MacroTraversalPars.MacroTraversalPercentagesTypes.eAssignment

to assign the percentages that the static traffic assignment has calculated to each connection

MacroTraversalPars.MacroTraversalPercentagesTypes.eOriginal

to assign the same percentages they had in the original centroid configuration

MacroTraversalPars.MacroTraversalPercentagesTypes.eNone

to do not assign any percentage

Constant	Description
MacroTraversalPars.MacroTraversalPercentagesTypes.eAssignment	to assign the percentages that the static traffic assignment has calculated to each connection
MacroTraversalPars.MacroTraversalPercentagesTypes.eOriginal	to assign the same percentages they had in the original centroid configuration
MacroTraversalPars.MacroTraversalPercentagesTypes.eNone	to do not assign any percentage

__init__([problemNet=NULL[, experiment=NULL[, centroidsPctType=MacroTraversalPars.MacroTraversalPercentagesTypes.eAssignment]]])¶

Parameters:

problemNet – GKProblemNet
experiment – MacroExperiment
centroidsPctType – MacroTraversalPercentagesTypes

getExperiment()¶

Return type:: MacroExperiment

getPTTravelTimeCalculationComponent()¶

Return type:: GKFunctionComponent

getProblemNet()¶

Return type:: GKProblemNet

getTypeOfPercentageInInternalCentroids()¶

Return type:: MacroTraversalPercentagesTypes

It returns whether to keep the original percentages defined for microsimulation in the internal centroids (the ones inside the subnetwork), to assign the new percentages calculated by the assignment algorithm or to do not assign any percentage to the internal centroids

setExperiment(experiment)¶

Parameters:: experiment – MacroExperiment

setPTTravelTimeCalculationComponent(component)¶

Parameters:: component – GKFunctionComponent

setProblemNet(problemNet)¶

Parameters:: problemNet – GKProblemNet

setTypeOfPercentageInInternalCentroids([value=MacroTraversalPars.MacroTraversalPercentagesTypes.eAssignment])¶

Parameters:: value – MacroTraversalPercentagesTypes

Sets whether to keep original percentages in the internal centroids ( eOriginal ), to set to these internal centroids the percentages given from the assignment ( eAssignment ) or to not assign any percentage ( eNone )