PyANGKernel.GKMasterControlPlan¶

class GKMasterControlPlan¶

A set of control plans to be simulated in Aimsun Next.

Details

It keeps control plans not only by time intervals but also by zones, which means that it is possible to redefine the control of a junction subset for a determined time interval, simulating the last not Unspecified control found.

Synopsis¶

Methods¶

def __init__()
def addToSchedule()
def areTurnsGreenSimultaneously()
def duration()
def getControlJunction()
def getControlJunctions()
def getControlMetering()
def getControlMeterings()
def getItemsByControlPlan()
def getPlanForTime()
def getProblemNet()
def getSchedule()
def initialTime()
def isEmpty()
def removeFromSchedule()
def removeSchedule()
def setProblemNet()
def times()

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

addToSchedule(item)¶

Parameters:: item – GKScheduleMasterControlPlanItem

Adds a new schedule into the list

areTurnsGreenSimultaneously(turn1, turn2)¶

Parameters:

turn1 – GKTurning
turn2 – GKTurning

Return type:

bool

For the 2 given turns, that must be in the same node, it returns true if there is a phase in the node that activates both turns at the same time.

duration()¶

Return type:: GKTimeDuration

Duration for this master control plan

getControlJunction(nodeId, fromTime, toTime, iniTimeScheduleItem)¶

Parameters:

nodeId – int
fromTime – int
toTime – int
iniTimeScheduleItem – uint

Return type:

GKControlJunction

Get the control information for a node based in the from and to times and it returns also the initial time of the schedule that contains this control junction. For unspecified control junctions it returns NULL.

getControlJunction(nodeId, fromTime, toTime, iniTimeScheduleItem, zone)

Parameters:

nodeId – int
fromTime – int
toTime – int
iniTimeScheduleItem – uint
zone – int

Return type:

GKControlJunction

Get the control information for a node based in the from and to times and the zone and it returns also the initial time of the schedule that contains this control junction. For unspecified control junctions it returns NULL.

getControlJunctions(nodeId, fromTime, toTime, warmup)¶

Parameters:

nodeId – int
fromTime – int
toTime – int
warmup – int

Return type:

.std.vectorGKScheduleMasterControlJunctionItem

Get the control information for a node based in the from and to times (considering warmup)

getControlMetering(meteringId, fromTime, toTime, iniTimeScheduleItem)¶

Parameters:

meteringId – int
fromTime – int
toTime – int
iniTimeScheduleItem – uint

Return type:

GKControlMetering

Gets the control information for a ramp meter based in the from and to times and it returns also the initial time of the schedule that contains this control ramp meter

getControlMeterings(meteringId, fromTime, toTime, warmup)¶

Parameters:

meteringId – int
fromTime – int
toTime – int
warmup – int

Return type:

.std.vectorGKScheduleMasterControlMeteringItem

Gets the control information for a ramp meter based in the from and to times and it returns also the initial time of the schedule that contains this control ramp meter

getItemsByControlPlan(plan)¶

Parameters:: plan – GKControlPlan
Return type:: .list of GKScheduleMasterControlPlanItem

Return all the items used by this master control plan that uses a particular control plan.

getPlanForTime(fromTime, toTime)¶

Parameters:

fromTime – int
toTime – int

Return type:

GKControlPlan

Get the control information based in the from and to times

getProblemNet()¶

Return type:: GKProblemNet

Returns the Subnetwork Configuration, if any. Otherwise returns NULL

getSchedule()¶

Return type:: .list of GKScheduleMasterControlPlanItem

Schedule… Returns the list of Control Plan items to be simulated

initialTime()¶

Return type:: QTime

Initial Time for this master control plan

isEmpty()¶

Return type:: bool

Returns true if no item is in the Master Control Plan

removeFromSchedule(item)¶

Parameters:: item – GKScheduleMasterControlPlanItem

Removes the specified control plan item, if it exists in the list

removeSchedule()¶

Removes all schedule items

setProblemNet(pn)¶

Parameters:: pn – GKProblemNet

Sets the Subnetwork Configuration. The pointer is adopted

times(from, to)¶

Parameters:

from – int
to – int

Return type:

.list of uint

Calculate the times in where a control plan changes (and the last one ends).