Aimsun Next Scripting  24.0
Public Member Functions | Public Attributes | List of all members
GKFunctionCostContext Class Reference

Public Member Functions

 GKFunctionCostContext ()
 
 GKFunctionCostContext (const GKGenericExperiment *exp, const GKBaseObject *userClass, double time=-1.0, double timeSta=-1.0)
 
const GKGenericExperimentgetExperiment () const
 
End const GKBaseObjectgetUserClass () const
 
End double getTime () const
 
End double getTimeSta () const
 
End GKBaseObjectgetVehicle () const
 
GKBaseObjectgetPurpose () const
 
int getIteration () const
 

Public Attributes

MethodCode sipRes = sipCpp->experiment
 

Detailed Description

The context to evaluate the function cost. Includes the Experiment to access variables and the user class. For dynamic experiments 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.

Constructor & Destructor Documentation

◆ GKFunctionCostContext() [1/2]

GKFunctionCostContext::GKFunctionCostContext ( )

◆ GKFunctionCostContext() [2/2]

GKFunctionCostContext::GKFunctionCostContext ( const GKGenericExperiment exp,
const GKBaseObject userClass,
double  time = -1.0,
double  timeSta = -1.0 
)

Member Function Documentation

◆ getExperiment()

const GKGenericExperiment * GKFunctionCostContext::getExperiment ( ) const

Gets the experiment

◆ getIteration()

int GKFunctionCostContext::getIteration ( ) const

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

◆ getPurpose()

GKBaseObject * GKFunctionCostContext::getPurpose ( ) const

Gets the purpose of the user class, if any

◆ getTime()

End double GKFunctionCostContext::getTime ( ) const

Gets the time

◆ getTimeSta()

End double GKFunctionCostContext::getTimeSta ( ) const

Gets the timeSta

◆ getUserClass()

End const GKBaseObject * GKFunctionCostContext::getUserClass ( ) const

Gets the user class

◆ getVehicle()

End GKBaseObject * GKFunctionCostContext::getVehicle ( ) const

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

Member Data Documentation

◆ sipRes

MethodCode GKFunctionCostContext::sipRes = sipCpp->experiment

© Aimsun SLU
Aimsun ®