PyDistributionPlugin.DistributionScenario

class DistributionScenario

Distribution Scenario

Synopsis

Methods

• def __init__()

• def addVector()

• def generateIntrazonalTrips()

• def generateThroughTraffic()

• def getAllSkims()

• def getBlockingZones()

• def getCarAvailabilityDistinction()

• def getComponentSkim()

• def getDataGroup()

• def getDistributionSide()

• def getInitialUserSkim()

• def getInitialUserSkims()

• def getSkim()

• def getTimePeriod()

• def getUsedVectors()

• def getUserDefinedSkim()

• def getVectors()

• def hasVector()

• def isUsed()

• def removeComponentSkim()

• def removeSkim()

• def removeUserDefinedSkim()

• def removeVector()

• def removeVectors()

• def setBlockingZones()

• def setCarAvailabilityDistinction()

• def setComponentSkim()

• def setDataGroup()

• def setDistributionSide()

• def setGenerateIntrazonalTrips()

• def setGenerateThroughTraffic()

• def setInitialUserSkim()

• def setSkim()

• def setStoreResults()

• def setTimePeriod()

• def setUsedVector()

• def setUserDefinedSkim()

• def storeResults()

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

__init__()

addVector(iVector)

Parameters:

iVector – GKGenerationAttractionVector

generateIntrazonalTrips()

Return type:

bool

generateThroughTraffic()

Return type:

bool

getAllSkims(iGAVector, iMode)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

Return type:

.list of GKODMatrix

getBlockingZones()

Return type:

GKODMatrix

getCarAvailabilityDistinction()

Return type:

int

getComponentSkim(iGAVector, iMode, iComponent)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iComponent – GKFunctionComponent

Return type:

GKODMatrix

getDataGroup()

Return type:

GKDistributionDataSet

getDistributionSide()

Return type:

int

getInitialUserSkim(iUser)

Parameters:

iUser – GKUserClass

Return type:

GKODMatrix

getInitialUserSkims()

Return type:

Dictionary with keys of type .GKUserClass and values of type GKODMatrix.

getSkim(iGAVector, iMode, type)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• type – SkimType

Return type:

GKODMatrix

getTimePeriod()

Return type:

GKTimePeriod

getUsedVectors()

Return type:

.list of const GKGenerationAttractionVector

getUserDefinedSkim(iGAVector, iMode, iColumnIndex)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iColumnIndex – int

Return type:

GKODMatrix

getVectors()

Return type:

.list of const GKGenerationAttractionVector

hasVector(iVector)

Parameters:

iVector – GKGenerationAttractionVector

Return type:

bool

isUsed(iVector)

Parameters:

iVector – GKGenerationAttractionVector

Return type:

bool

removeComponentSkim(iGAVector, iMode, iComponent)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iComponent – GKFunctionComponent

removeSkim(iGAVector, iMode, type)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• type – SkimType

removeUserDefinedSkim(iGAVector, iMode, iColumnIndex)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iColumnIndex – int

removeVector(iVector)

Parameters:

iVector – GKGenerationAttractionVector

removeVectors()

setBlockingZones(value)

Parameters:

value – GKODMatrix

setCarAvailabilityDistinction(iValue)

Parameters:

iValue – int

setComponentSkim(iGAVector, iMode, iComponent, iSkim)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iComponent – GKFunctionComponent

• iSkim – GKODMatrix

setDataGroup(iDataGroup)

Parameters:

iDataGroup – GKDistributionDataSet

setDistributionSide(iSide)

Parameters:

iSide – int

setGenerateIntrazonalTrips(value)

Parameters:

value – bool

setGenerateThroughTraffic(value)

Parameters:

value – bool

setInitialUserSkim(iSkims)

Parameters:

iSkims – Dictionary with keys of type .GKUserClass and values of type GKODMatrix.

setSkim(iGAVector, iMode, iSkim)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iSkim – GKODMatrix

setStoreResults(iValue)

Parameters:

iValue – bool

setTimePeriod(iTimePeriod)

Parameters:

iTimePeriod – GKTimePeriod

setUsedVector(iVector, iUsed)

Parameters:

• iVector – GKGenerationAttractionVector

• iUsed – bool

setUserDefinedSkim(iGAVector, iMode, iColumnIndex, iSkim)

Parameters:

• iGAVector – GKGenerationAttractionVector

• iMode – GKTransportationMode

• iColumnIndex – int

• iSkim – GKODMatrix

storeResults()

Return type:

bool