PyANGKernel.GKFunctionCostContext

class GKFunctionCostContext

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

Detailed Description

The context to evaluate the function cost. It includes the Experiment to access variables, the vehicle type and the purpose. For dynamic experiments, it includes the current time in seconds (timeSta ie: 08:10:20) and the absolute time in seconds (time) since the moment that we start the simulation.

PyANGKernel.GKFunctionCostContext.experiment
PyANGKernel.GKFunctionCostContext.userClass
PyANGKernel.GKFunctionCostContext.time
PyANGKernel.GKFunctionCostContext.timeSta
PyANGKernel.GKFunctionCostContext.iteration
__init__()
__init__(exp, userClass[, time=-1.0[, timeSta=-1.0[, vehicle=None[, purpose=None]]]])
Parameters:
getExperiment()
Return type:

GKGenericExperiment

Gets the experiment

getIteration()
Return type:

int

Gets the iteration number in macro or due experiments. This parameter might be used when evaluating VDFs, TPFs or JDFs or DCFs.

getPurpose()
Return type:

GKBaseObject

Gets the purpose of the user class, if any

getTime()
Return type:

float

Gets the time

getTimeSta()
Return type:

float

Gets the timeSta

getUserClass()
Return type:

GKBaseObject

Gets the user class

getVehicle()
Return type:

GKBaseObject

Gets the vehicle type or pedestrian type of the user class, if any

setPurpose(arg__1)
Parameters:

arg__1 – GKBaseObject

setVehicle(arg__1)
Parameters:

arg__1 – GKBaseObject