PyANGKernel.GKFunctionCost

class GKFunctionCost

A cost function for a link or turn. This function will be evaluated in order to obtain the cost of the link or turn when evaluating the object in a simulation.

Details

The internal name of the centroid configuration folder is “GKModel::functions” The external name is “Functions”

Inheritance diagram of PyANGKernel.GKFunctionCost

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

class GKFunctionCostType
class GKFunctionLanguage

This is the language used in the function: - eStandard: It is the basic language that provide Aimsun Functions (obsolete). - ePython: Using a snippet function in Python. - eC: Using an external C function loaded from a dynamic library.

__init__()
__init__(model)
Parameters:

modelGKModel

evaluateAdjustmentWeight(context, observed)
Parameters:
Return type:

float

Evaluates additional weight to modify reliabilities for the static OD adjustment.

evaluateArrivalPenalty(context, tt, interval)
Parameters:
Return type:

float

Evaluates the Arrival Penalty.

evaluateCAModelFunction(iData, iPurpose, iModelConnection)
Parameters:
  • iDatavoid

  • iPurposeGKBaseObject

  • iModelConnectionvoid

Return type:

float

Evaluates a Car Availability Model function.

evaluateCentroidDistributionUtility(context, iCentroid, iModes, iCentroids, dataProvider)
Parameters:
  • contextGKFunctionCostContext

  • iCentroidGKCentroid

  • iModes – .list of GKTransportationMode

  • iCentroids – .list of GKCentroid

  • dataProvidervoid

Return type:

.list of double

Evaluates a Distribution choice Utility depending for a given origin function.

evaluateDRTUtility(plan, coefs)
Parameters:
  • planvoid

  • coefsvoid

Return type:

float

evaluateDistributionFunction(context, iCost)
Parameters:
Return type:

float

Evaluates a Deterrence function.

evaluateDistributionImpedance(context, modes, origin, destination, dataProvider)
Parameters:
Return type:

float

Evaluate Distribution Impedance Function.

evaluateGenericKInitials(context, dtaManager, dtasection, dtaturning, volume)
Parameters:
Return type:

float

Generic (Python-based or C-based) Dynamic Models evaluator for the K-Initial shortest paths.

evaluateGenericMacro(context, target, volume[, component=""])
Parameters:
Return type:

float

Generic (Python-based / C-based) Macro Models evaluator for Sections (volume), Turns (volume) and Centroid Connections (no extra data)

evaluateGenericMacroJunction(context, target, volume, ownVolume, conflictVolume[, component=""])
Parameters:
Return type:

float

Generic (Python-based / C-based) Macro Models evaluator for Junction (Turns) (volume)

evaluateGenericRouteChoice(context, dtaManager, centroidOrigin, centroidDestination, alternativesRC, alternativesOD, alternativesAPA, indexPath)
Parameters:
  • contextGKFunctionCostContext

  • dtaManagervoid

  • centroidOriginGKBaseObject

  • centroidDestinationGKBaseObject

  • alternativesRC – .std.vectorvoid

  • alternativesOD – .std.vectorvoid

  • alternativesAPA – .std.vectorvoid

  • indexPath – int

Return type:

float

Generic (Python-based or C-based) Dynamic Route Choice Models evaluator.

evaluateModalSplitDiscreteChoice(context, vehicles, costs)
Parameters:
Return type:

.list of double

Evaluate Modal Split Discrete Choice function.

evaluateModalSplitUtility(context, mode, origin, destination, dataProvider)
Parameters:
Return type:

float

Evaluate Modal Split Utility Function.

evaluatePTBoarding(context, iLineOrigin, iStopOrigin[, component=""])
Parameters:
Return type:

float

Evaluates boarding cost to a line at a stop.

evaluatePTCrowdDiscomfort(context, iLine, volume, delay[, component=""])
Parameters:
Return type:

float

Evaluates the Crowd Discomfort.

evaluatePTDelayTime(context, iLine, iSection[, component=""])
Parameters:
Return type:

float

evaluatePTDelayTime(context, iLine, iSection[, component=""])
Parameters:
Return type:

float

evaluatePTDelayTime(context, iLine, iSection, iFromDTA[, component=""])
Parameters:
Return type:

float

evaluatePTDelayTime(context, iLine, iSection, fromGui, iFromDTA[, component=""])
Parameters:
Return type:

float

Evaluates cost or travel time for a given section and line.

evaluatePTDwellingTime(context, iLine, ptStop, alightingVolume, boardingVolume[, component=""])
Parameters:
Return type:

float

evaluatePTPenalty(context, iLineOrigin, iLineDestination, iStopOrigin, iStopDestination[, component=""])
Parameters:
Return type:

float

Evaluates the transfer penalty from an origin line and stop to a destination line and stop.

evaluatePTWaitingTime(context, iMeanTime[, component=""])
Parameters:
Return type:

float

Evaluates waiting time for a given line and stop.

evaluatePTWalkingOnly(context, fromConnector, toConnector[, component=""])
Parameters:
Return type:

float

evaluateParkRideCost(context, dtaManager, dtacentroid, VOT, expectedTravelTime, expetedTravelTimewithPT)
Parameters:
Return type:

float

Generic (Python or C-based) Park and Ride evaluator.

evaluateStochasticUtility(context, iPathChoice)
Parameters:
Return type:

.list of double

Evaluates a Discrete Choice function.

getDefaultDefinition(iType)
Parameters:

iTypeGKFunctionCostType

Return type:

str

Gets the default definition for a function type.

getDefinition()
Return type:

str

Gets this function definition.

getDistributionTable()
Return type:

GKDistributionTable

getFunctionType()
Return type:

GKFunctionCostType

Gets the function type.

getLUADefaultDefinition(iType)
Parameters:

iTypeGKFunctionCostType

Return type:

str

Gets the default definition for a function type.

getLanguage()
Return type:

GKFunctionLanguage

Gets the used language for this function.

isDefaultDefinition(iDefinition)
Parameters:

iDefinition – str

Return type:

bool

Check is definition is a default definition.

isLUADefaultDefinition(iDefinition)
Parameters:

iDefinition – str

Return type:

bool

Check is definition is a default definition.

setDefinition(aDef[, error=None])
Parameters:
  • aDef – str

  • error – str

Return type:

bool

Sets a definition for this function. This is a helper description users can use in order to classify its functions or even write a short description of its functionality. Return false if python code do not compile

setFunctionType(atype)
Parameters:

atypeGKFunctionCostType

Sets the function type.

setLanguage(alanguage)
Parameters:

alanguageGKFunctionLanguage

Sets the used language for this function.

validNumber(iValue)
Parameters:

iValue – float

Return type:

bool

Checks for out of bound values, i.e. N.A.N IND and INF.