PyANGKernel.GKRoadPricing

class GKRoadPricing

Force a turn on a vehicle depending on its origin and/or destination to enter or exit a road pricing depending on a percentage and the associated cost.

Details

The user must specify the section where the action is applied and the turn that vehicles will be forced to take if willing to either enter the priced road or exit it if already in. Then the user must specify which vehicles on the section will be affected by this action, by specifying the OD pairs affected. Finally, the user can choose the vehicle class considered and the level of compliance for this action.

Synopsis

Methods

• def __init__()

• def costCalculationIsToEndOfCurrentZone()

• def costCalculationIsToEndOfTrip()

• def costCalculationIsToNextSegment()

• def getCentroidConfiguration()

• def getDestination()

• def getGeneralPurposeSection()

• def getHOTSection()

• def getOrigin()

• def getReevaluateWhenTTIsUpdated()

• def getRoadPricingType()

• def getSegmentWeight()

• def getThresholdAction()

• def getVisibilityDistance()

• def getZone()

• def setCentroidConfiguration()

• def setCostCalculationToEndOfCurrentZone()

• def setCostCalculationToEndOfTrip()

• def setCostCalculationToNextSegment()

• def setDestination()

• def setGeneralPurposeSection()

• def setHOTSection()

• def setOrigin()

• def setReevaluateWhenTTIsUpdated()

• def setRoadPricingType()

• def setSegmentWeight()

• def setThresholdAction()

• def setVisibilityDistance()

• def setZone()

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 GKRoadPricingType

Set whether the action will make vehicles enter or exit the priced road.

__init__()

costCalculationIsToEndOfCurrentZone()

Return type:

bool

Returns whether the cost calculation to take the decision considers the remainder of the current zone.

costCalculationIsToEndOfTrip()

Return type:

bool

Returns whether the cost calculation to take the decision considers the remainder of the trip.

costCalculationIsToNextSegment()

Return type:

bool

Returns whether the cost calculation to take the decision considers the next segment.

getCentroidConfiguration()

Return type:

GKCentroidConfiguration

Gets the related centroid configuration

getDestination()

Return type:

GKCentroid

Gets the destination centroid of the affected car. Can be NULL, means ANY.

getGeneralPurposeSection()

Return type:

GKSection

Gets the complementary section. This is where the vehicles will go into if the action is NOT satisfied. If NULL, Aimsun Next will select a section.

getHOTSection()

Return type:

GKSection

Gets the next section. This is where the vehicles will go into if the action is satisfied.

getOrigin()

Return type:

GKCentroid

Gets the origin centroid of the affected car. Can be NULL, means ANY.

getReevaluateWhenTTIsUpdated()

Return type:

bool

getRoadPricingType()

Return type:

GKRoadPricingType

Gets the type of road pricing, either entry or exit.

getSegmentWeight()

Return type:

float

getThresholdAction()

Return type:

float

getVisibilityDistance()

Return type:

float

getZone()

Return type:

int

setCentroidConfiguration(config)

Parameters:

config – GKCentroidConfiguration

Sets the related centroid configuration

setCostCalculationToEndOfCurrentZone(value)

Parameters:

value – bool

Sets the cost calculation to take the decision to consider the remainder of the current zone when true and not to consider it otherwise.

setCostCalculationToEndOfTrip(value)

Parameters:

value – bool

Sets the cost calculation to take the decision to consider the remainder of the trip when true and not to consider it otherwise.

setCostCalculationToNextSegment(value)

Parameters:

value – bool

Sets the cost calculation to take the decision to consider the next segment when true and not to consider it otherwise.

setDestination(centroid)

Parameters:

centroid – GKCentroid

Sets the destination centroid of the affected car. Can be NULL, means ANY.

setGeneralPurposeSection(section)

Parameters:

section – GKSection

Sets the complementary section. This is where the vehicles will go into if the action is NOT satisfied. If NULL, Aimsun Next will select a section.

setHOTSection(section)

Parameters:

section – GKSection

Sets the next section. This is where the vehicles will go into if the action is satisfied.

setOrigin(centroid)

Parameters:

centroid – GKCentroid

Sets the origin centroid of the affected car. Can be NULL, means ANY.

setReevaluateWhenTTIsUpdated(update)

Parameters:

update – bool

setRoadPricingType(atype)

Parameters:

atype – GKRoadPricingType

Sets the type of road pricing, either entry or exit.

setSegmentWeight(value)

Parameters:

value – float

setThresholdAction(value)

Parameters:

value – float

setVisibilityDistance(value)

Parameters:

value – float

setZone(value)

Parameters:

value – int