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”
Synopsis¶
Methods¶
def
__init__()def
getDefinition()def
getLanguage()def
setDefinition()def
setLanguage()def
validNumber()
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:
model –
GKModel
- evaluateAdjustmentWeight(context, observed)¶
- Parameters:
context –
GKFunctionCostContextobserved – float
- Return type:
Evaluates additional weight to modify reliabilities for the static OD adjustment.
- evaluateArrivalPenalty(context, tt, interval)¶
- Parameters:
context –
GKFunctionCostContexttt – float
interval – float
- Return type:
Evaluates the Arrival Penalty.
- evaluateCAModelFunction(iData, iPurpose, iModelConnection)¶
- Parameters:
iData –
voidiPurpose –
GKBaseObjectiModelConnection –
void
- Return type:
Evaluates a Car Availability Model function.
- evaluateCentroidDistributionUtility(context, iCentroid, iModes, iCentroids, dataProvider)¶
- Parameters:
context –
GKFunctionCostContextiCentroid –
GKCentroidiModes – .list of GKTransportationMode
iCentroids – .list of GKCentroid
dataProvider –
void
- Return type:
.list of double
Evaluates a Distribution choice Utility depending for a given origin function.
- evaluateDistributionFunction(context, iCost)¶
- Parameters:
context –
GKFunctionCostContextiCost – float
- Return type:
Evaluates a Deterrence function.
- evaluateDistributionImpedance(context, modes, origin, destination, dataProvider)¶
- Parameters:
context –
GKFunctionCostContextmodes – .list of GKBaseObject
origin –
GKCentroiddestination –
GKCentroiddataProvider –
void
- Return type:
Evaluate Distribution Impedance Function.
- evaluateGenericKInitials(context, dtaManager, dtasection, dtaturning, volume)¶
- Parameters:
context –
GKFunctionCostContextdtaManager –
voiddtasection –
GKBaseObjectdtaturning –
GKBaseObjectvolume – float
- Return type:
Generic (Python-based or C-based) Dynamic Models evaluator for the K-Initial shortest paths.
- evaluateGenericMacro(context, target, volume[, component=""])¶
- Parameters:
context –
GKFunctionCostContexttarget –
GKBaseObjectvolume –
GKFunctionVolumecomponent – str
- Return type:
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:
context –
GKFunctionCostContexttarget –
GKBaseObjectvolume –
GKFunctionVolumeownVolume –
GKFunctionVolumeconflictVolume –
GKFunctionVolumecomponent – str
- Return type:
Generic (Python-based / C-based) Macro Models evaluator for Junction (Turns) (volume)
- evaluateGenericRouteChoice(context, dtaManager, centroidOrigin, centroidDestination, alternativesRC, alternativesOD, alternativesAPA, indexPath)¶
- Parameters:
context –
GKFunctionCostContextdtaManager –
voidcentroidOrigin –
GKBaseObjectcentroidDestination –
GKBaseObjectalternativesRC – .std.vectorvoid
alternativesOD – .std.vectorvoid
alternativesAPA – .std.vectorvoid
indexPath – int
- Return type:
Generic (Python-based or C-based) Dynamic Route Choice Models evaluator.
- evaluateModalSplitDiscreteChoice(context, vehicles, costs)¶
- Parameters:
context –
GKFunctionCostContextvehicles – .list of GKVehicle
costs – .list of double
- Return type:
.list of double
Evaluate Modal Split Discrete Choice function.
- evaluateModalSplitUtility(context, mode, origin, destination, dataProvider)¶
- Parameters:
context –
GKFunctionCostContextmode –
GKBaseObjectorigin –
GKCentroiddestination –
GKCentroiddataProvider –
void
- Return type:
Evaluate Modal Split Utility Function.
- evaluatePTBoarding(context, iLineOrigin, iStopOrigin[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiLineOrigin –
GKBaseObjectiStopOrigin –
GKBaseObjectcomponent – str
- Return type:
Evaluates boarding cost to a line at a stop.
- evaluatePTCrowdDiscomfort(context, iLine, volume, delay[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiLine –
GKBaseObjectvolume – float
delay – float
component – str
- Return type:
Evaluates the Crowd Discomfort.
- evaluatePTDelayTime(context, iLine, iSection[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiLine –
GKPublicLineiSection –
GKPTSectionDatacomponent – str
- Return type:
- evaluatePTDelayTime(context, iLine, iSection[, component=""])
- Parameters:
context –
GKFunctionCostContextiLine –
GKPublicLineiSection –
StopToStopcomponent – str
- Return type:
- evaluatePTDelayTime(context, iLine, iSection, iFromDTA[, component=""])
- Parameters:
context –
GKFunctionCostContextiLine –
GKSimulatedObjectiSection –
voidiFromDTA – bool
component – str
- Return type:
- evaluatePTDelayTime(context, iLine, iSection, fromGui, iFromDTA[, component=""])
- Parameters:
context –
GKFunctionCostContextiLine –
GKBaseObjectiSection –
voidfromGui – bool
iFromDTA – bool
component – str
- Return type:
Evaluates cost or travel time for a given section and line.
- evaluatePTDwellingTime(context, iLine, ptStop, alightingVolume, boardingVolume[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiLine –
GKBaseObjectptStop –
GKBaseObjectalightingVolume – float
boardingVolume – float
component – str
- Return type:
- evaluatePTPenalty(context, iLineOrigin, iLineDestination, iStopOrigin, iStopDestination[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiLineOrigin –
GKBaseObjectiLineDestination –
GKBaseObjectiStopOrigin –
GKBaseObjectiStopDestination –
GKBaseObjectcomponent – str
- Return type:
Evaluates the transfer penalty from an origin line and stop to a destination line and stop.
- evaluatePTWaitingTime(context, iMeanTime[, component=""])¶
- Parameters:
context –
GKFunctionCostContextiMeanTime – float
component – str
- Return type:
Evaluates waiting time for a given line and stop.
- evaluatePTWalkingOnly(context, fromConnector, toConnector[, component=""])¶
- Parameters:
context –
GKFunctionCostContextfromConnector –
GKBaseObjecttoConnector –
GKBaseObjectcomponent – str
- Return type:
- evaluateParkRideCost(context, dtaManager, dtacentroid, VOT, expectedTravelTime, expetedTravelTimewithPT)¶
- Parameters:
context –
GKFunctionCostContextdtaManager –
voiddtacentroid –
GKBaseObjectVOT – float
expectedTravelTime – float
expetedTravelTimewithPT – float
- Return type:
Generic (Python or C-based) Park and Ride evaluator.
- evaluateStochasticUtility(context, iPathChoice)¶
- Parameters:
context –
GKFunctionCostContextiPathChoice –
GKPathChoice
- Return type:
.list of double
Evaluates a Discrete Choice function.
- getDefaultDefinition(iType)¶
- Parameters:
iType –
GKFunctionCostType- Return type:
Gets the default definition for a function type.
Gets this function definition.
- getDistributionTable()¶
- Return type:
- getFunctionType()¶
- Return type:
Gets the function type.
- getLUADefaultDefinition(iType)¶
- Parameters:
iType –
GKFunctionCostType- Return type:
Gets the default definition for a function type.
- getLanguage()¶
- Return type:
Gets the used language for this function.
Check is definition is a default definition.
Check is definition is a default definition.
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:
atype –
GKFunctionCostType
Sets the function type.
- setLanguage(alanguage)¶
- Parameters:
alanguage –
GKFunctionLanguage
Sets the used language for this function.
Checks for out of bound values, i.e. N.A.N IND and INF.