PyANGDTA.DTATurning

class DTATurning

Turn representation for the DTA module

Inheritance diagram of PyANGDTA.DTATurning

Synopsis

Methods

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__()
__init__(apturning, modelConnection)
Parameters:
calculationCost(dtaManager, travelTime, vehType)
Parameters:
Return type:

float

Using the current cost function calculates the cost using the travel time and vehicle type vt from o to number vehicles -1.

currentDefaultCost(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Deprecated function. Do not use it and start updating the cost functions that use it to be compatible with future releases. Equivalent to: currentDefaultCostVT (dtaManager, None) const;

currentDefaultCostVT(dtaManager, vehType)
Parameters:
Return type:

float

Current default cost considering the vehicle type.

getAdditionalVolume()
Return type:

float

Gets the additional volume, in PCUs.

getAttractiveness([vehType=None])
Parameters:

vehType – DTAVehicleType

Return type:

float

Returns the turn attractiveness. Without vehType no vehicle distinction is made.

getBehaviourModel()
Return type:

DTABehaviourModelType

Returns if this turn is being used by the micro or meso models

getCapacity()
Return type:

float

Gets the turn capacity, in PCUs/h.

getControlJunctionType()
Return type:

GKControlJunctionType

Gets the control junction type, or the control junction type of the last control plan in the master control plan.

getCycle()
Return type:

float

Gets the cycle time [s].

getDestination()
Return type:

DTASection

Returns the destination section.

getDestinationCapacity()
Return type:

float

Gets the capacity of the destination section, in PCUs/h.

getDynamicDefaultCost(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the default cost of the last route choice interval/s using the dynamic cost function.

getDynamicDefaultCostVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the dynamic default cost of the last route choice interval/s using the dynamic cost function and considering the user class.

getDynamicDefaultCostVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the dynamic default cost of the last route choice interval/s using the dynamic cost function and considering the vehicle type vehType.

getFreeFlowTravelTime(dtaManager, vehType)
Parameters:
Return type:

float

Returns the turn free flow travel time. This is the travel time considering the origin section and turn. VehType defines the vehicle type from (0..number vehicles -1).

getGreenTime()
Return type:

float

Gets the normal green-time for this turn [s].

getInitialDefaultCost(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the default cost of the last route choice interval/s using the initial cost function.

getMaxGreenTime()
Return type:

float

Gets the maximum green-time for this turn [s].

getMaxSpeed()
Return type:

float

Returns the turn speed in the network units, that is either Km/h or miles/h

getMaxSpeedInKmH()
Return type:

float

Returns the turn speed in Km/h

getMinGreenTime()
Return type:

float

Gets the minimum green-time for this turn [s] For actuated phases with recall Max it will add the maximum green time of the phase. For actuated phases with recall No it will not add any time to the min green time.

getOrigin()
Return type:

DTASection

Returns the origin section.

getOriginCapacity()
Return type:

float

Gets the capacity of the origin section, in PCUs/h.

getPastCost(dtaManager, index)
Parameters:
Return type:

float

Returns the past cost that has been read from the replication that has been set for the past costs. The index parameter defines the shift from the current interval. So index = 0 means that the returned path cost will be from the same interval. index = 1 means the next interval and index = -1 the previous interval.

getPastCostVT(dtaManager, gkUserClass, index)
Parameters:
Return type:

float

Returns the past cost that has been read from the replication that has been set for the past costs. The index parameter defines the shift from the current interval. So index = 0 means that the returned path cost will be from the same interval. index = 1 means the next interval and index = -1 the previous interval and using the user class.

getPastCostVT(dtaManager, vehType, index)
Parameters:
Return type:

float

Returns the past cost that has been read from the replication that has been set for the past costs. The index parameter defines the shift from the current interval. So index = 0 means that the returned path cost will be from the same interval. index = 1 means the next interval and index = -1 the previous interval. VehType defines the vehicle type from (0..number vehicles -1).

getSpeed()
Return type:

float

Returns the speed in either m/s (micro/meso) or km/h (macro)

getSpeed_ms()
Return type:

float

Returns the speed in m/s

getStaDelayT(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the link (section + turn) delay time for the last route choice interval/s.

getStaDelayTVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the link (section + turn) delay time for the last route choice interval/s considering the user class.

getStaDelayTVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the link (section + turn) delay time for the last route choice interval/s considering the vehicle type vehType.

getStaFlow(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the flow for the last route choice interval/s

getStaFlowVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the flow for the last route choice interval/s considering the user class.

getStaFlowVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the flow for the last route choice interval/s considering the vehicle type vehType.

getStaNbStopVeh(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the number of stops done for the last route choice interval/s. This is only available for turn being modeled using the micro model.

getStaNbStopVehVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the number of stops for the last route choice interval/s considering the user class.

getStaNbStopVehVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the number of stops for the last route choice interval/s considering the vehicle type vehType.

getStaSpeed(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the link (section + turn) speed for the last route choice interval/s.

getStaSpeedVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the link (section + turn) speed for the last route choice interval/s considering the user class.

getStaSpeedVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the link (section + turn) speed for the last route choice interval/s considering the vehicle type vehType.

getStaStopT(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the stop time for the last route choice interval/s. This is only available for turn being modeled using the micro model.

getStaStopTVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the stop time for the last route choice interval/s considering the user class.

getStaStopTVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the stop time for the last route choice interval/s considering the vehicle type vehType.

getStaTravelT(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the link (section + turn) travel time for the last route choice interval/s. When the section has waiting time in virtual queue, the waiting time is added to the travel time.

getStaTravelTNoVQ(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Returns the link (section + turn) travel time without considering the time in virtual queue for the last route choice interval/s.

getStaTravelTNoVQVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the link (section + turn) travel time without considering the time in virtual queue for the last route choice interval/s considering the vehicle type vehType.

getStaTravelTNoVQVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the link (section + turn) travel time without considering the time in virtual queue for the last route choice interval/s considering the vehicle type vehType.

getStaTravelTVT(dtaManager, gkUserClass)
Parameters:
Return type:

float

Returns the link (section + turn) travel time for the last route choice interval/s considering the user class. When the section has waiting time in virtual queue, the waiting time is added to the travel time.

getStaTravelTVT(dtaManager, vehType)
Parameters:
Return type:

float

Returns the link (section + turn) travel time for the last route choice interval/s considering the vehicle type vehType. When the section has waiting time in virtual queue, the waiting time is added to the travel time.

getUncontrolledTime()
Return type:

float

Gets duration of time with no control defined (Uncontrolled or Unspecified).

getUserDefinedCost()
Return type:

float

Returns the turn user defined cost.

getUserDefinedCost2()
Return type:

float

Returns the turn user defined cost 2.

getUserDefinedCost3()
Return type:

float

Returns the turn user defined cost 3.

getWarningIndicator()
Return type:

GKWarningIndicator

Gets the warning indicator

getYellowDuration()
Return type:

float

Gets the yellow-time for this turn [s].

isVehicleAllowed(vehType)
Parameters:

vehType – DTAVehicleType

Return type:

bool

Returns true if vehicle vehtype can go through this turn

isVehicleAllowed(vehType, idCentroideDesti)
Parameters:
Return type:

bool

Returns true if vehicle vehtype can go through this turn using the destination centroid. The turn may be closed * by a traffic management action that why the destination centroid can be checked too.

length2D()
Return type:

float

Returns the 2D length in meters.

length3D()
Return type:

float

Returns the length, taking into account the z coordinate, in meters.

setCapacity(capacity)
Parameters:

capacity – float

Sets the turn capacity, in PCUs/h.

vdfDefaultCost(dtaManager)
Parameters:

dtaManager – DTAManager

Return type:

float

Deprecated function. Do not use it and start updating the cost functions that use it to be compatible with future releases. Equivalent to: vdfDefaultCostVT (dtaManager, None) const;

vdfDefaultCostVT(dtaManager, vehType)
Parameters:
Return type:

float

Default VDF cost considering the vehicle type.