PyANGKernel.GKPublicLine¶

class GKPublicLine¶

A transit line consists of a transit route, its stops and the associated timetables.

Details

The internal name of the transit line folder is: “GKModel::publicLines”. The external name is “Transit Lines”.

Synopsis¶

Methods¶

def __init__()
def addStopToStopMark()
def addTimeTable()
def clearStopToStopFunctions()
def clearStopToStopMarks()
def createRouteAndStops()
def crowdDiscomfortFunction()
def getBoardingFare()
def getDelayFunction()
def getDistance()
def getDistanceFare()
def getFareFunction()
def getFreeFlowTravelTime()
def getIndexAppearance()
def getIndexSection()
def getOcitLineNumber()
def getOcitRouteNumber()
def getOcitTrainLength()
def getPTSectionData()
def getProblemNet()
def getSREMRole()
def getSREMSubrole()
def getSectionAppearances()
def getSections()
def getStopToStopMarks()
def getStops()
def getTimeTableStopToStopDelay()
def getTimeTables()
def isCorrect()
def isStopUsed()
def removeStopToStopMark()
def removeTimeTable()
def removeTimeTables()
def reroute()
def setBoardingFare()
def setCrowdDiscomfortFunction()
def setDelayFunction()
def setDistanceFare()
def setFareFunction()
def setOcitLineNumber()
def setOcitRouteNumber()
def setOcitTrainLength()
def setProblemNet()
def setSREMRole()
def setSREMSubrole()
def setStops()

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__()¶

addStopToStopMark(ptSectionIndex)¶

Parameters:: ptSectionIndex – int

Marks the StopToStop in TransitNetwork using this transit line mark color + 1.

addTimeTable(tt)¶

Parameters:: tt – GKPublicLineTimeTable

Adds a timetable. The pointer is adopted.

clearStopToStopFunctions()¶

Removes all stop to stop functions defined

clearStopToStopMarks()¶

Clear all StopToStop marks.

createRouteAndStops()¶

Set the route and the stops of this Transit Line reading the info stored in its ptSections.

crowdDiscomfortFunction()¶

Return type:: GKFunctionCost

Get the crowd discomfort function

See also

setCrowdDiscomfortFunction()

getBoardingFare()¶

Return type:: float

Gets the boarding fare for this line.

getDelayFunction(origin, destination)¶

Parameters:

origin – GKBusStop
destination – GKBusStop

Return type:

GKFunctionCost

Get the delay time function for given origin and destination Transit Stop

getDistance(origin, destination)¶

Parameters:

origin – GKBusStop
destination – GKBusStop

Return type:

float

Get the distance between the two stops

getDistanceFare()¶

Return type:: float

Gets the distance fare for this line.

getFareFunction(origin, destination)¶

Parameters:

origin – GKBusStop
destination – GKBusStop

Return type:

GKFunctionCost

Get the distance fare function from Transit Stop origin to Transit Stop destination

getFreeFlowTravelTime(origin, destination)¶

Parameters:

origin – GKBusStop
destination – GKBusStop

Return type:

float

Get the free flow travel time between the two stops

getIndexAppearance(stop, indexRoute)¶

Parameters:

stop – GKBusStop
indexRoute – int

Return type:

int

Returns the number stop appearances before position indexRoute (indexRoute is also considered).

getIndexSection(stop, indexAppearance)¶

Parameters:

stop – GKBusStop
indexAppearance – int

Return type:

int

Returns the index section (1..N) of the stop considering the index appearance of the stop.

getOcitLineNumber()¶

Return type:: int

getOcitRouteNumber()¶

Return type:: int

getOcitTrainLength()¶

Return type:: int

getPTSectionData()¶

Return type:: .list of GKPTSectionData

Get the route and delay functions for each consecutive pair of stops

getProblemNet()¶

Return type:: GKProblemNet

Returns the Subnetwork this transit line belongs to

getSREMRole()¶

Return type:: int

getSREMSubrole()¶

Return type:: int

getSectionAppearances(section, indexRoute)¶

Parameters:

section – GKSection
indexRoute – int

Return type:

int

Returns the number section appearances before position indexRoute (indexRoute is also considered).

getSections(origin, destination)¶

Parameters:

origin – GKBusStop
destination – GKBusStop

Return type:

.list of GKSection

Returns all transit sections between origin and destination stop

getStopToStopMarks()¶

Return type:: .QSetquint32

Get the StopToStop mark set.

getStops()¶

Return type:: .list of GKBusStop

Returns all the transit stops of this line. It will return a vector with as many positions as sections in the transit line, with NULLs where there is no stop.

getTimeTableStopToStopDelay(origin, destination, iExperiment)¶

Parameters:

origin – GKBusStop
destination – GKBusStop
iExperiment – GKGenericExperiment

Return type:

float

Gets the average delay from stop to stop for active scenario (weighted by schedule duration)

getTimeTables()¶

Return type:: .list of GKPublicLineTimeTable

Returns all the timetables of this line.

isCorrect(scenario)¶

Parameters:: scenario – GKGenericScenario
Return type:: bool

* See GKRoute .

isStopUsed(stop)¶

Parameters:: stop – GKBusStop
Return type:: bool

Returns true if the stop is used in this line.

removeStopToStopMark(ptSectionIndex)¶

Parameters:: ptSectionIndex – int

Unmarks the StopToStop .

removeTimeTable(tt)¶

Parameters:: tt – GKPublicLineTimeTable

Removes the specified timetable from the timetables list of this line. The timetable itself is not deleted.

removeTimeTables()¶

Removes and deletes all the timetables from the timetables list of this line. The timetables themselves are not deleted.

reroute(origin, destination, iRoute)¶

Parameters:

origin – GKBusStop
destination – GKBusStop
iRoute – GKRoute

setBoardingFare(iFare)¶

Parameters:: iFare – float

Sets the boarding fare for this line.

setCrowdDiscomfortFunction(aFunction)¶

Parameters:: aFunction – GKFunctionCost

Set the crowd discomfort function

See also

crowdDiscomfortFunction()

setDelayFunction(origin, destination, iDelayFunction)¶

Parameters:

origin – GKBusStop
destination – GKBusStop
iDelayFunction – GKFunctionCost

Set the delay time function from Transit Stop origin to Transit Stop destination

setDistanceFare(iFare)¶

Parameters:: iFare – float

Sets the distance fare for this line.

setFareFunction(origin, destination, iFareFunction)¶

Parameters:

origin – GKBusStop
destination – GKBusStop
iFareFunction – GKFunctionCost

Set the distance fare function from Transit Stop origin to Transit Stop destination

setOcitLineNumber(value)¶

Parameters:: value – int

setOcitRouteNumber(value)¶

Parameters:: value – int

setOcitTrainLength(value)¶

Parameters:: value – int

setProblemNet(aProblemNet)¶

Parameters:: aProblemNet – GKProblemNet

Sets the Subnetwork this transit line belongs to

setSREMRole(role)¶

Parameters:: role – int

setSREMSubrole(value)¶

Parameters:: value – int

setStops(_stops)¶

Parameters:: _stops – .list of GKBusStop

Sets all the transit stops of this line. The vector has to have as many positions as sections in the transit line, with NULLs where there is no stop.