|
Aimsun Next Scripting
22
|
Public Types | |
| enum | GKBusPreemptionType { eAlternative , eAllPhases } |
Priority information in a control plan for a node (GKControlJunction) to foresee the arrival of a transit vehicle in order to anticipate the phase that gives it the right of way. It takes into account the following elements:
If there are several phases in the same node that could receive priority by request, a different Priority Set must be defined for each one.
Defines two types of priority to apply: Serve All (eAllPhases) or Alternative (eAlternative). Serve All serves all the remaining phases between the current green phase and the dwell phase with their minimum green time. The Alternative serves the dwell phase as soon as possible.
| Enumerator | |
|---|---|
| eAlternative | |
| eAllPhases | |
| GKBusPreemption::GKBusPreemption | ( | ) |
| bool GKBusPreemption::addDetectorPriorityEnd | ( | GKDetector * | detector | ) |
Adds a detector to the list of detectors that end the priority
| bool GKBusPreemption::addDetectorPriorityRequest | ( | GKDetector * | detector | ) |
Adds a detector to the list of detectors to request priority.
| bool GKBusPreemption::addDwellPhase | ( | GKControlPhase * | idPhase | ) |
Adds a dwell phase, that is a phase that gives right of way to the emitted priority request, to the bus priority structure. In a multiring control plan one phase per ring (all in the same barrier) should be added. In a single ring just one dwell phase should be defined.
| bool GKBusPreemption::addPTLine | ( | GKPublicLine * | PTline | ) |
Adds a Transit Line that will activate a priority request for the dwell phase.
| float GKBusPreemption::getDelayTime | ( | ) | const |
Gets the Delay Time that is the number of seconds defined to delay the start of the priority timing once a vehicle that activated the priority has been detected.
| QVector< GKDetector * > GKBusPreemption::getDetectorPriorityEnd | ( | ) | const |
Returns the list of detectors that end the priority
| QVector< GKDetector * > GKBusPreemption::getDetectorPriorityRequest | ( | ) | const |
Returns the list of detectors to request priority.
| const QVector< GKControlPhase * > & GKBusPreemption::getDwellPhases | ( | ) | const |
Returns the list of dwell phases defined for this bus priority. In a multiring control plan there should be one phase per ring (all in the same barrier). In a single ring there should be just one dwell phase.
| float GKBusPreemption::getInhibitTime | ( | ) | const |
Gets the inhibit time, that is the duration of the interval while the activation of any phase that is not the requested priority phase is prevented. This interval starts at the beginning of the request, and during this interval, calls from other phases are not taken into account.
| float GKBusPreemption::getMaximumDwellGreen | ( | ) | const |
Gets the maximum duration of the Dwell phase
| float GKBusPreemption::getMinimumDwellGreen | ( | ) | const |
Gets the minimum duration of the Dwell phase
| QVector< GKPublicLine * > GKBusPreemption::getPTLines | ( | ) | const |
Gets the list of Transit Lines that will activate a priority request for the dwell phase.
| float GKBusPreemption::getReserveTime | ( | ) | const |
Gets the reserve time, that is the time during which any other priority request is prevented when one has just been completed. This is used to prevent frequent priority services.
| GKBusPreemptionType GKBusPreemption::getType | ( | ) | const |
Gets the type of priority set to be applied: Serve All (eAllPhases) or Alternative (eAlternative). Serve All serves all the remaining phases between the current green phase and the dwell phase with their minimum green time. The Alternative serves the dwell phase as soon as possible.
| void GKBusPreemption::removeDetectorPriorityEnd | ( | ) |
Clears the list of detectors that end the priority
| bool GKBusPreemption::removeDetectorPriorityEnd | ( | GKDetector * | detector | ) |
Removes a detector from the list of detectors that end the priority
| void GKBusPreemption::removeDetectorPriorityRequest | ( | ) |
Clears the list of detectors to request priority
| bool GKBusPreemption::removeDetectorPriorityRequest | ( | GKDetector * | detector | ) |
Removes a detector from the list of detectors to request priority.
| bool GKBusPreemption::removeDwellPhase | ( | GKControlPhase * | idPhase | ) |
Removes a dwell phase from the bus priority structure.
| void GKBusPreemption::removeDwellPhases | ( | ) |
Removes all dwell phases defined for this bus priority.
| bool GKBusPreemption::removePTLine | ( | GKPublicLine * | PTline | ) |
Removes a Transit Line from the list of lines that activate a priority request for the dwell phase.
| void GKBusPreemption::removePTLines | ( | ) |
Removes all Transit Lines from list of lines that will activate a priority request for the dwell phase.
| void GKBusPreemption::setDelayTime | ( | const float | adelayTime | ) |
Sets the Delay Time, that is the number of seconds to delay the start of the priority timing once a vehicle that activated the priority has been detected.
| void GKBusPreemption::setInhibitTime | ( | const float | aInhibitTime | ) |
Sets the Inhibit Time, that is the duration of the interval while the activation of any phase that is not the requested priority phase is prevented. This interval starts at the beginning of the request, and during this interval, calls from other phases are not taken into account.
| void GKBusPreemption::setMaximumDwellGreen | ( | const float | maxDwellGreen | ) |
Sets the maximum duration of the Dwell phase
| void GKBusPreemption::setMinimumDwellGreen | ( | const float | minDwellGreen | ) |
Sets the minimum duration of the Dwell phase.
| void GKBusPreemption::setReserveTime | ( | const float | areserveTime | ) |
Sets the reserve time, that is the time during which any other priority request is prevented when one has just been completed. This is used to prevent frequent priority services.
| void GKBusPreemption::setType | ( | const GKBusPreemptionType | atype | ) |
It sets the type of priority to apply: Serve All (eAllPhases) or Alternative (eAlternative). Serve All serves all the remaining phases between the current green phase and the dwell phase with their minimum green time. The Alternative serves the dwell phase as soon as possible.
1.9.4