PyANGKernel.BaseForest

class BaseForest

Inherited by: ForestODStorage, NSPForest

Synopsis

Methods

• def __init__()

• def addInterval()

• def addVehicleGroup()

• def addVehicleType()

• def boundigBoxOptimized()

• def calculate()

• def convertFilter()

• def createSubForest()

• def createSubPaths()

• def duration()

• def getAssignmentMatrix()

• def getCostByVehicleType()

• def getDemand()

• def getFileName()

• def getGeometry()

• def getIntervalDuration()

• def getIntervalIndex()

• def getIntervals()

• def getLastGeneration()

• def getLastGenerationDate()

• def getLastGenerationSimulatorEngine()

• def getLastGenerationSimulatorMode()

• def getLastGenerationSimulatorVersion()

• def getModel()

• def getNumWarmUpIntervals()

• def getNumberIntervals()

• def getOriginDestinationBoundingBox()

• def getPathSections()

• def getStationaryIntervals()

• def getTotalNumberOfTrips()

• def getTotalTrips()

• def getTrips()

• def getTripsByIndex()

• def getType()

• def getUserClassIndex()

• def getUserClassIndexForAssignment()

• def getUserClasses()

• def getUserClassesGroups()

• def getVersion()

• def getWarmUpDuration()

• def getWarmUpIntervals()

• def hasStatistics()

• def initialTime()

• def isDynamic()

• def isWarmupInterval()

• def mergePaths()

• def modifyInterval()

• def readIntoMemory()

• def resetVehicleGroups()

• def setCostByVehicleType()

• def setDemand()

• def setLastGeneration()

• def setLastGenerationDate()

• def setLastGenerationSimulatorEngine()

• def setLastGenerationSimulatorMode()

• def setLastGenerationSimulatorVersion()

• def setType()

• def storeGeometryAndDemand()

• def treesInMemory()

• def usesJoinedHeaps()

• def writeGeometry()

Virtual methods

• def getPaths()

• def setNewAssignmentFactor()

• def store()

• def writePathsToFile()

Static functions

• def readFile()

• def readFileForDynamic()

• def readFileGeneric()

• def readFileType()

• def readHeaderFile()

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 ForestType

class WriteStatus

__init__(amodel, iType)

Parameters:

• amodel – GKModel

• iType – ForestType

addInterval(start, end, isWarmup)

Parameters:

• start – QDateTime

• end – QDateTime

• isWarmup – bool

addVehicleGroup(vehgroup)

Parameters:

vehgroup – .list of int

Return type:

int

addVehicleType(userClassId)

Parameters:

userClassId – int

Return type:

int

boundigBoxOptimized()

Return type:

bool

calculate(iCalculator, iFilter)

Parameters:

• iCalculator – ForestCalculator

• iFilter – AnalysisFilter

convertFilter(iFilterAimsunIds)

Parameters:

iFilterAimsunIds – AnalysisFilter

Return type:

AnalysisFilter

createSubForest(iModel, nrPaths)

Parameters:

• iModel – GKModel

• nrPaths – int

Return type:

BaseForest

createSubPaths(iModel, iSectionId, iIntervalIndex, userClassId, iOriginId, iDestinationId)

Parameters:

• iModel – GKModel

• iSectionId – int

• iIntervalIndex – int

• userClassId – int

• iOriginId – int

• iDestinationId – int

duration()

Return type:

GKTimeDuration

duration(interval)

Parameters:

interval – int

Return type:

GKTimeDuration

getAssignmentMatrix(aimsunModel, observations, states)

Parameters:

• aimsunModel – GKModel

• observations – .list of qint32

• states – .list of std.pairqint32,qint32

Return type:

AssignmentMatrix

getCostByVehicleType()

Return type:

bool

getDemand()

Return type:

ForestDemands

getFileName()

Return type:

str

getGeometry()

Return type:

ForestGeometry

getIntervalDuration()

Return type:

int

getIntervalIndex(start, end)

Parameters:

• start – QDateTime

• end – QDateTime

Return type:

int

getIntervals()

Return type:

.list of std.pairQDateTime,QDateTime

getLastGeneration()

Return type:

int

getLastGenerationDate()

Return type:

QDateTime

getLastGenerationSimulatorEngine()

Return type:

int

getLastGenerationSimulatorMode()

Return type:

int

getLastGenerationSimulatorVersion()

Return type:

str

getModel()

Return type:

GKModel

getNumWarmUpIntervals()

Return type:

int

getNumberIntervals()

Return type:

int

getOriginDestinationBoundingBox(originIndex, destinationIndex)

Parameters:

• originIndex – int

• destinationIndex – int

Return type:

GKBBox

getPathSections(iEntranceSection, iTree, iVehicleIndex)

Parameters:

• iEntranceSection – int

• iTree – NSPPath

• iVehicleIndex – int

Return type:

.list of qint32

abstractmethod getPaths()

Return type:

ForestPaths

getStationaryIntervals()

Return type:

.list of std.pairQDateTime,QDateTime

getTotalNumberOfTrips()

Return type:

float

getTotalTrips(userId, interval)

Parameters:

• userId – int

• interval – int

Return type:

float

getTrips(originId, destinationId, userId, interval)

Parameters:

• originId – int

• destinationId – int

• userId – int

• interval – int

Return type:

float

getTripsByIndex(originIndex, destiationIndex, userIndex, intervalIndex)

Parameters:

• originIndex – int

• destiationIndex – int

• userIndex – int

• intervalIndex – int

Return type:

float

getType()

Return type:

ForestType

getUserClassIndex(userClassId)

Parameters:

userClassId – int

Return type:

int

getUserClassIndexForAssignment(userClassId)

Parameters:

userClassId – int

Return type:

int

getUserClasses()

Return type:

.list of uint

getUserClassesGroups()

Return type:

.list of list of int

getVersion()

Return type:

int

getWarmUpDuration()

Return type:

int

getWarmUpIntervals()

Return type:

.list of std.pairQDateTime,QDateTime

hasStatistics()

Return type:

bool

initialTime()

Return type:

QTime

initialTime(interval)

Parameters:

interval – int

Return type:

QTime

isDynamic()

Return type:

bool

isWarmupInterval(iInterval)

Parameters:

iInterval – int

Return type:

bool

mergePaths(ipaths)

Parameters:

ipaths – .list of BaseForest

Return type:

BaseForest

modifyInterval(index, from, to)

Parameters:

• index – int

• from – QDateTime

• to – QDateTime

static readFile(fileName, model[, task=None])

Parameters:

• fileName – str

• model – GKModel

• task – GKTask

Return type:

BaseForest

static readFileForDynamic(fileName, iModel, nrPaths[, task=NULL])

Parameters:

• fileName – str

• iModel – GKModel

• nrPaths – int

• task – GKTask

Return type:

BaseForest

static readFileGeneric(fileName, iModel[, task=None])

Parameters:

• fileName – str

• iModel – GKModel

• task – GKTask

Return type:

BaseForest

static readFileType(fileName)

Parameters:

fileName – str

Return type:

ForestType

static readHeaderFile(fileName, iModel[, task=None])

Parameters:

• fileName – str

• iModel – GKModel

• task – GKTask

Return type:

BaseForest

readIntoMemory()

resetVehicleGroups()

setCostByVehicleType(value)

Parameters:

value – bool

setDemand(iDemand)

Parameters:

iDemand – ForestDemands

setLastGeneration(object)

Parameters:

object – GKObject

setLastGenerationDate(date)

Parameters:

date – QDateTime

setLastGenerationSimulatorEngine(engine)

Parameters:

engine – int

setLastGenerationSimulatorMode(mode)

Parameters:

mode – int

setLastGenerationSimulatorVersion(version)

Parameters:

version – str

setNewAssignmentFactor(intervalIndex, vehicleIndex, originIndex, originCon, destinationIndex, destinationCon, sections, prob)

Parameters:

• intervalIndex – int

• vehicleIndex – int

• originIndex – int

• originCon – int

• destinationIndex – int

• destinationCon – int

• sections – .list of uint

• prob – float

Return type:

bool

setType(iType)

Parameters:

iType – ForestType

store(stream)

Parameters:

stream – QDataStream

Return type:

bool

storeGeometryAndDemand(stream)

Parameters:

stream – QDataStream

treesInMemory()

Return type:

bool

usesJoinedHeaps()

Return type:

bool

writeGeometry()

Return type:

ForestGeometry

writePathsToFile(fileName)

Parameters:

fileName – str

Return type:

WriteStatus