Aimsun Next Scripting: GKExperimentODParameters Class Reference
Aimsun Next Scripting  22
Public Member Functions | List of all members
GKExperimentODParameters Class Reference

Public Member Functions

 GKExperimentODParameters ()
 
 GKExperimentODParameters (GKCentroid *origin, GKCentroid *destination)
 
GKCentroidgetOrigin () const
 
void setOrigin (GKCentroid *origin)
 
GKCentroidgetDestination () const
 
void setDestination (GKCentroid *origin)
 
void setProbability (double p)
 
double getProbability () const
 
void setAlfaFactor (double alfa)
 
double getAlfaFactor () const
 
void setScaleFactor (double scale)
 
double getScaleFactor () const
 
void setBetaFactor (double beta)
 
double getBetaFactor () const
 
void setGammaFactor (double gamma)
 
double getGammaFactor () const
 

Detailed Description

Route Choice models depen on a series of parameters. This parameteres for each Origin and Destiantion can be defined using this class. It can define parameters for the following route choice models:

More information regarding these Route Choice models can be found in the manual.

Constructor & Destructor Documentation

◆ GKExperimentODParameters() [1/2]

GKExperimentODParameters::GKExperimentODParameters ( )

◆ GKExperimentODParameters() [2/2]

GKExperimentODParameters::GKExperimentODParameters ( GKCentroid origin,
GKCentroid destination 
)

Member Function Documentation

◆ getAlfaFactor()

double GKExperimentODParameters::getAlfaFactor ( ) const

Get the proportional parameter.

◆ getBetaFactor()

double GKExperimentODParameters::getBetaFactor ( ) const

Get the Beta parameter for the C-Logit function.

◆ getDestination()

GKCentroid * GKExperimentODParameters::getDestination ( ) const

Get destination centroid.

◆ getGammaFactor()

double GKExperimentODParameters::getGammaFactor ( ) const

Get the Gamma parameter for the C-Logit function.

◆ getOrigin()

GKCentroid * GKExperimentODParameters::getOrigin ( ) const

Get origin centroid.

◆ getProbability()

double GKExperimentODParameters::getProbability ( ) const

Get the binomial parameter.

◆ getScaleFactor()

double GKExperimentODParameters::getScaleFactor ( ) const

Get the scale factor for the Logit and C-Logits functions.

◆ setAlfaFactor()

void GKExperimentODParameters::setAlfaFactor ( double  alfa)

Set the proportional parameter.

◆ setBetaFactor()

void GKExperimentODParameters::setBetaFactor ( double  beta)

Set the Beta parameter for the C-Logit function.

◆ setDestination()

void GKExperimentODParameters::setDestination ( GKCentroid origin)

Set destination centroid.

◆ setGammaFactor()

void GKExperimentODParameters::setGammaFactor ( double  gamma)

Set the Gamma parameter for the C-Logit function.

◆ setOrigin()

void GKExperimentODParameters::setOrigin ( GKCentroid origin)

Set origin centroid.

◆ setProbability()

void GKExperimentODParameters::setProbability ( double  p)

Set the binomial parameter.

◆ setScaleFactor()

void GKExperimentODParameters::setScaleFactor ( double  scale)

Set the scale factor for the Logit and C-Logits functions.

© Aimsun SLU
Aimsun ®