Aimsun Next Scripting  22
Public Types | Public Member Functions | List of all members
GKFunctionCost Class Reference
Inheritance diagram for GKFunctionCost:
GKObject GKBaseObject

Public Types

enum  GKFunctionCostType {
  eBasic , eCost , eCostVehType , eRouteChoice ,
  eVDF , eTurnPenalty , eJunctionDelay , eKInitials ,
  eKInitialsVehType , eDistribution , ePTWaitingTime , ePTDelay ,
  ePTTransferPenalty , eStochasticUtility , ePTBoardingCost , eAdjustmentWeight ,
  ePTFare , eCAModel , eParkAndRide , ePTCrowdingDiscomfort ,
  eModalChoice , eModalSplitUtility , eDistributionDeterrenceFunction , eDyDAArrivalPenaltyFunction ,
  eDistributionUtilityFunction , eDRTUtility
}
 
enum  GKFunctionLanguage { eStandard , ePython , eC , eTable }
 
- Public Types inherited from GKObject
enum  IdentifierFormFlag {
  eIdentifierDefault , eIdentifierId , eIdentifierName , eIdentifierExternalId ,
  eIdentifierTypeExternalName , eIdentifierDescription , eIdentifierStandard , eIdentifierStandardWithType ,
  eIdentifierAll
}
 
enum  GKLockType { eNone , eModification , eDelete , eModificationDelete }
 
enum  GKObjectStatus { eNew , eSaved , eModified , eDeleted }
 
typedef QFlags< GKObject::IdentifierFormFlagIdentifierForm
 

Public Member Functions

 GKFunctionCost (GKModel *model)
 
 ~GKFunctionCost ()
 
void setFunctionType (const GKFunctionCostType atype)
 
const GKFunctionCostType getFunctionType () const
 
void setLanguage (const GKFunctionLanguage alanguage)
 
const GKFunctionLanguage getLanguage () const
 
bool setDefinition (const QString aDef)
 
const QString & getDefinition () const
 
QString getDefaultDefinition (GKFunctionCostType iType) const
 
bool isDefaultDefinition (const QString &iDefinition) const
 
bool validNumber (double iValue)
 
double evaluateAdjustmentWeight (const GKFunctionCostContext *context, const double observed) throw (GKPythonParsingException)
 
double evaluateGenericMacro (const GKFunctionCostContext *context, const GKBaseObject *target, GKFunctionVolume *volume, QString component="") throw (GKPythonParsingException)
 
double evaluateGenericMacroJunction (const GKFunctionCostContext *context, const GKBaseObject *target, GKFunctionVolume *volume, GKFunctionVolume *ownVolume, GKFunctionVolume *conflictVolume, QString component="") throw (GKPythonParsingException)
 
double evaluatePTWaitingTime (const GKFunctionCostContext *context, double iMeanTime) throw (GKPythonParsingException)
 
double evaluatePTDelayTime (const GKFunctionCostContext *context, const GKBaseObject *iLine, const void *iSection, const bool fromGui, const bool iFromDTA) const throw (GKPythonParsingException)
 
double evaluatePTDelayTime (const GKFunctionCostContext *context, const GKPublicLine &iLine, const GKPTSectionData &iSection) const throw (GKPythonParsingException)
 
double evaluatePTDelayTime (const GKFunctionCostContext *context, const GKPublicLine &iLine, const StopToStop &iSection) const throw (GKPythonParsingException)
 
double evaluatePTDelayTime (const GKFunctionCostContext *context, const GKSimulatedObject &iLine, const void *iSection, const bool iFromDTA) const throw (GKPythonParsingException)
 
double evaluatePTPenalty (const GKFunctionCostContext *context, const GKBaseObject *iLineOrigin, const GKBaseObject *iLineDestination, const GKBaseObject *iStopOrigin, const GKBaseObject *iStopDestination) const throw (GKPythonParsingException)
 
double evaluatePTBoarding (const GKFunctionCostContext *context, const GKBaseObject *iLineOrigin, const GKBaseObject *iStopOrigin) const throw (GKPythonParsingException)
 
QVector< double > evaluateStochasticUtility (const GKFunctionCostContext *context, const GKPathChoice *iPathChoice) throw (GKPythonParsingException)
 
double evaluateDistributionFunction (const GKFunctionCostContext *context, double iCost) throw (GKPythonParsingException)
 
double evaluateCAModelFunction (const void *iData, const GKBaseObject *iPurpose, const void *iModelConnection)
 
double evaluateParkRideCost (const GKFunctionCostContext *context, void *dtaManager, GKBaseObject *dtacentroid, double VOT, double expectedTravelTime, double expetedTravelTimewithPT)
 
double evaluatePTCrowdDiscomfort (const GKFunctionCostContext *context, const GKBaseObject *iLine, double volume) throw (GKPythonParsingException)
 
double evaluateArrivalPenalty (const GKFunctionCostContext *context, double tt, double interval)
 
GKDistributionTablegetDistributionTable ()
 
QVector< double > evaluateModalSplitDiscreteChoice (const GKFunctionCostContext *context, const QVector< GKVehicle * > &vehicles, const QVector< double > &costs) const
 
double evaluateModalSplitUtility (const GKFunctionCostContext *context, GKBaseObject *mode, GKCentroid *origin, GKCentroid *destination, const void *dataProvider) const
 
double evaluateDistributionImpedance (const GKFunctionCostContext *context, const QVector< GKBaseObject * > &modes, GKCentroid *origin, GKCentroid *destination, const void *dataProvider) const throw (GKPythonParsingException)
 
QVector< double > evaluateCentroidDistributionUtility (const GKFunctionCostContext *context, const GKCentroid *iOrigin, const QVector< GKTransportationMode * > &iModes, const QVector< GKCentroid * > &iDestinations, const void *dataProvider) throw (GKPythonParsingException)
 
- Public Member Functions inherited from GKObject
 GKObject ()
 
 GKObject (const GKObject &o)
 
virtual void addedToCatalog ()
 
virtual void removedFromCatalog ()
 
uint getTick () const
 
virtual void increaseTick ()
 
void setTick (uint t)
 
virtual GKObjectclone (bool addItToModel=true) const
 
virtual GKObjectcloneAsTemporary (bool addItToModel=true) const
 
GKFoldergetCreateRootFolder ()
 
GKFoldergetRootFolder () const
 
void setRootFolder (GKFolder *afolder)
 
GKFolderfindFolder (const QString &byName) const
 
QVector< GKFolder * > getParentFolders () const
 
bool isDataValueNull (const GKColumn *attr) const
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
virtual void setDataValue (const GKColumn *attr, const QVariant &v)
 
void setDataValueByID (uint attrId, const QVariant &v)
 
virtual void setDataValueObject (const GKColumn *attr, const GKObject *obj)
 
void setDataValueObjectByID (uint attrId, const GKObject *obj)
 
virtual void setDataValueDouble (const GKColumn *attr, double v)
 
void setDataValueDoubleByID (uint attrId, double v)
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
 
double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
 
bool hasAnyTSWithData () const
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
GKTimeSeriegetDataValueTSByID (uint attrId) const
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInSingleTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription)
 
void setDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL)
 
void setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)
 
virtual void clearDataValueTS (const GKColumn *attr, GKTSDescription *aDescription=NULL)
 
void clearDataValueTSByID (uint attrId, GKTSDescription *aDescription=NULL)
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QTime getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QDateTime getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QDateTime getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
void removeDataValue (const GKColumn *attr)
 
void removeDataValueByID (uint attrId)
 
const QString & getDescription () const
 
void setDescription (const QString &adescription)
 
const QString & getExternalId () const
 
void setExternalId (const QString &anId)
 
virtual GKObjectDelCmd * getDelCmd ()
 
virtual GKObjectConnectionDelCmd * getDelConnectionCmd (GKObject *target)
 
virtual void nonCommandObjectRemoved (GKObject *)
 
virtual void init ()
 
virtual void setId (uint aid, GKModel *model)
 
uint getId () const
 
QUuid getUUID () const
 
virtual void setName (const QString &aname)
 
const QString & getName () const
 
QString getExtendedId (IdentifierForm form=eIdentifierDefault) const
 
QString getNameOrExtendedId (IdentifierForm form=eIdentifierDefault) const
 
virtual const QString & getTypeName () const
 
virtual QString getTypeExternalName () const
 
const GKObjectgetMaster () const
 
GKTypegetType () const
 
virtual void setType (GKType *atype)
 
bool isA (const GKType *atype) const
 
bool isA (const QString &typeName) const
 
virtual void setModel (GKModel *amodel)
 
GKModelgetModel () const
 
virtual void setLock (GKLockType atype)
 
GKLockType getLock () const
 
virtual bool canBeDeleted () const
 
virtual bool canBeModified () const
 
virtual bool canBeEdited () const
 
GKObjectStatus getStatus () const
 
virtual void setStatus (const GKObjectStatus astatus)
 
void notifyStatusChange ()
 
bool isTemporary () const
 
void setTemporary (bool value)
 
bool isExternal () const
 
void setExternal (bool value)
 
virtual void preferencesChanged ()
 
void removeColumn (GKColumn *column)
 
void resetColumn (GKColumn *column)
 
- Public Member Functions inherited from GKBaseObject
 GKBaseObject ()
 
 if (base)
 
virtual uint getId () const =0
 
virtual const QString & getTypeName () const =0
 
virtual QString getTypeExternalName () const =0
 
virtual const GKObjectgetMaster () const =0
 
virtual const QString & getName () const =0
 
virtual const QString & getExternalId () const =0
 
virtual const QString & getDescription () const =0
 
virtual GKModelgetModel () const =0
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
 
virtual QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const =0
 
virtual double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const =0
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const =0
 
virtual GKTimeSeriegetDataValueTSByID (uint attrId) const =0
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QTime getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDateTime getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDateTime getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 

Additional Inherited Members

- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 
- Static Public Attributes inherited from GKObject
static uint typeNameAtt
 
static uint typeExternalNameAtt
 
static uint revisedAtt
 
- Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint idAtt
 
static uint nameAtt
 
static uint externalIdAtt
 
static uint descriptionAtt
 

Detailed Description

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

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

Member Enumeration Documentation

◆ GKFunctionCostType

Function cost type. This function cost type may be:

  • eBasic: The default type.
  • eCost: Cost function used to calculate the shortest path trees.
  • eCostVehType: Cost function used to calculate the shortest path trees and taking into account the different vehicle types that are being simulated.
  • eRouteChoice: Function to choose the path that is going to follow a vehicle.
  • eVDF: Volume Delay Function used in the Macro module.
  • eTurnPenalty: Turn penalty function used in the Macro module.
  • eJunctionDelay: Junction delay function used in the Macro module.
  • eKInitials: Cost function used to calculate the K-Initials shortest path trees in a dynamic simulation.
  • eKInitialsVehType: Cost function used to calculate the K-Initials shortest path trees and taking into account the different vehicle types that are being simulated in a dynamic simulation.
  • eDistribution: Cost function that combines the different transportation modes impedances.
  • ePTWaitingTime: Cost function used to calculate the waiting time to enter a Transit Line from a Transit stop.
  • ePTDelay: Cost function for travel time or generalized cost in Transit Assignment.
  • ePTTransferPenalty: Cost of each transfer in a Transit Assignment.
  • eStochasticUtility: Discrete Choice function for Macro Stochastic Assignment.
  • ePTBoardingCost: Cost of boarding a Transit Vehicle (fare).
  • eAdjustmentWeight: Function that weights the reliabilities for the Static OD Adjustment.
  • eParkAndRide: Function to evaluate a centroid park and ride cost.
  • ePTCrowdingDiscomfort: Cost function used to calculate the discomfort in a Transit Assignment.
  • eModalChoice: Discrete choice function used to calculate the percentage for each vehicle type.
  • eModalSplitUtility: Utility function that gives utility by transportation mode for each OD pair.
  • eDistributionDeterrenceFunction: Cost function that models the reluctance to make a trip depending on the trip impedance.
  • eDyDAArrivalPenaltyFunction: Cost function that models the penalty for early and late arrivals in a Dynamic OD Departure Time Rescheduling.
  • eDistributionUtilityFunction: Utility function that gives utility by OD pair.
Enumerator
eBasic 
eCost 
eCostVehType 
eRouteChoice 
eVDF 
eTurnPenalty 
eJunctionDelay 
eKInitials 
eKInitialsVehType 
eDistribution 
ePTWaitingTime 
ePTDelay 
ePTTransferPenalty 
eStochasticUtility 
ePTBoardingCost 
eAdjustmentWeight 
ePTFare 
eCAModel 
eParkAndRide 
ePTCrowdingDiscomfort 
eModalChoice 
eModalSplitUtility 
eDistributionDeterrenceFunction 
eDyDAArrivalPenaltyFunction 
eDistributionUtilityFunction 
eDRTUtility 

◆ 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.
Enumerator
eStandard 
ePython 
eC 
eTable 

Constructor & Destructor Documentation

◆ GKFunctionCost()

GKFunctionCost::GKFunctionCost ( GKModel model)

◆ ~GKFunctionCost()

GKFunctionCost::~GKFunctionCost ( )

Member Function Documentation

◆ evaluateAdjustmentWeight()

double GKFunctionCost::evaluateAdjustmentWeight ( const GKFunctionCostContext context,
const double  observed 
)
throw (GKPythonParsingException
)

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

◆ evaluateArrivalPenalty()

double GKFunctionCost::evaluateArrivalPenalty ( const GKFunctionCostContext context,
double  tt,
double  interval 
)

Evaluates the Arrival Penalty.

◆ evaluateCAModelFunction()

double GKFunctionCost::evaluateCAModelFunction ( const void *  iData,
const GKBaseObject iPurpose,
const void *  iModelConnection 
)

Evaluates a Car Availability Model function.

◆ evaluateCentroidDistributionUtility()

QVector< double > GKFunctionCost::evaluateCentroidDistributionUtility ( const GKFunctionCostContext context,
const GKCentroid iOrigin,
const QVector< GKTransportationMode * > &  iModes,
const QVector< GKCentroid * > &  iDestinations,
const void *  dataProvider 
)
throw (GKPythonParsingException
)

Evaluate origin Distribution Utility Function.

◆ evaluateDistributionFunction()

double GKFunctionCost::evaluateDistributionFunction ( const GKFunctionCostContext context,
double  iCost 
)
throw (GKPythonParsingException
)

Evaluates a Distribution Deterrence function.

◆ evaluateDistributionImpedance()

double GKFunctionCost::evaluateDistributionImpedance ( const GKFunctionCostContext context,
const QVector< GKBaseObject * > &  modes,
GKCentroid origin,
GKCentroid destination,
const void *  dataProvider 
) const
throw (GKPythonParsingException
)

Evaluate Distribution Impedance Function.

◆ evaluateGenericMacro()

double GKFunctionCost::evaluateGenericMacro ( const GKFunctionCostContext context,
const GKBaseObject target,
GKFunctionVolume volume,
QString  component = "" 
)
throw (GKPythonParsingException
)

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

◆ evaluateGenericMacroJunction()

double GKFunctionCost::evaluateGenericMacroJunction ( const GKFunctionCostContext context,
const GKBaseObject target,
GKFunctionVolume volume,
GKFunctionVolume ownVolume,
GKFunctionVolume conflictVolume,
QString  component = "" 
)
throw (GKPythonParsingException
)

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

◆ evaluateModalSplitDiscreteChoice()

QVector< double > GKFunctionCost::evaluateModalSplitDiscreteChoice ( const GKFunctionCostContext context,
const QVector< GKVehicle * > &  vehicles,
const QVector< double > &  costs 
) const

Evaluate Modal Split Discrete Choice function.

◆ evaluateModalSplitUtility()

double GKFunctionCost::evaluateModalSplitUtility ( const GKFunctionCostContext context,
GKBaseObject mode,
GKCentroid origin,
GKCentroid destination,
const void *  dataProvider 
) const

Evaluate Modal Split Utility Function.

◆ evaluateParkRideCost()

double GKFunctionCost::evaluateParkRideCost ( const GKFunctionCostContext context,
void *  dtaManager,
GKBaseObject dtacentroid,
double  VOT,
double  expectedTravelTime,
double  expetedTravelTimewithPT 
)

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

◆ evaluatePTBoarding()

double GKFunctionCost::evaluatePTBoarding ( const GKFunctionCostContext context,
const GKBaseObject iLineOrigin,
const GKBaseObject iStopOrigin 
) const
throw (GKPythonParsingException
)

Evaluates boarding cost to a line at a stop.

◆ evaluatePTCrowdDiscomfort()

double GKFunctionCost::evaluatePTCrowdDiscomfort ( const GKFunctionCostContext context,
const GKBaseObject iLine,
double  volume 
)
throw (GKPythonParsingException
)

Evaluates the Crowd Discomfort.

◆ evaluatePTDelayTime() [1/4]

double GKFunctionCost::evaluatePTDelayTime ( const GKFunctionCostContext context,
const GKBaseObject iLine,
const void *  iSection,
const bool  fromGui,
const bool  iFromDTA 
) const
throw (GKPythonParsingException
)

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

◆ evaluatePTDelayTime() [2/4]

double GKFunctionCost::evaluatePTDelayTime ( const GKFunctionCostContext context,
const GKPublicLine iLine,
const GKPTSectionData iSection 
) const
throw (GKPythonParsingException
)

◆ evaluatePTDelayTime() [3/4]

double GKFunctionCost::evaluatePTDelayTime ( const GKFunctionCostContext context,
const GKPublicLine iLine,
const StopToStop iSection 
) const
throw (GKPythonParsingException
)

◆ evaluatePTDelayTime() [4/4]

double GKFunctionCost::evaluatePTDelayTime ( const GKFunctionCostContext context,
const GKSimulatedObject iLine,
const void *  iSection,
const bool  iFromDTA 
) const
throw (GKPythonParsingException
)

◆ evaluatePTPenalty()

double GKFunctionCost::evaluatePTPenalty ( const GKFunctionCostContext context,
const GKBaseObject iLineOrigin,
const GKBaseObject iLineDestination,
const GKBaseObject iStopOrigin,
const GKBaseObject iStopDestination 
) const
throw (GKPythonParsingException
)

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

◆ evaluatePTWaitingTime()

double GKFunctionCost::evaluatePTWaitingTime ( const GKFunctionCostContext context,
double  iMeanTime 
)
throw (GKPythonParsingException
)

Evaluates waiting time for a given line and stop.

◆ evaluateStochasticUtility()

QVector< double > GKFunctionCost::evaluateStochasticUtility ( const GKFunctionCostContext context,
const GKPathChoice iPathChoice 
)
throw (GKPythonParsingException
)

Evaluates a Discrete Choice function.

◆ getDefaultDefinition()

QString GKFunctionCost::getDefaultDefinition ( GKFunctionCostType  iType) const

Get the default definition for a function type.

◆ getDefinition()

const QString & GKFunctionCost::getDefinition ( ) const

Gets this function definition.

◆ getDistributionTable()

GKDistributionTable & GKFunctionCost::getDistributionTable ( )

Gets the distribution values table.

◆ getFunctionType()

const GKFunctionCostType GKFunctionCost::getFunctionType ( ) const

Gets the function type.

◆ getLanguage()

const GKFunctionLanguage GKFunctionCost::getLanguage ( ) const

Gets the used language for this function.

◆ isDefaultDefinition()

bool GKFunctionCost::isDefaultDefinition ( const QString &  iDefinition) const

Check is definition is a default definition.

◆ setDefinition()

bool GKFunctionCost::setDefinition ( const QString  aDef)

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()

void GKFunctionCost::setFunctionType ( const GKFunctionCostType  atype)

Sets the function type.

◆ setLanguage()

void GKFunctionCost::setLanguage ( const GKFunctionLanguage  alanguage)

Sets the used language for this function.

◆ validNumber()

bool GKFunctionCost::validNumber ( double  iValue)

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

© Aimsun SLU
Aimsun ®