Aimsun Next Scripting  22
Public Member Functions | List of all members
DestinationChoiceModelParams Class Reference
Inheritance diagram for DestinationChoiceModelParams:
DistributionExperimentParams

Public Member Functions

 DestinationChoiceModelParams ()
 
void setMaxRelativeGap (const double iRelativeGap)
 
double getMaxRelativeGap () const
 
void setConstraintError (double iConstrError)
 
double getConstraintError () const
 
void setSideTotalsConstraint (bool iOption)
 
bool getSideTotalsConstraint () const
 
void setMaxSideTotalsIterations (uint iOption)
 
uint getMaxSideTotalsIterations () const
 
QString getTypeName () const
 
bool validParameters (GKModel *iModel) const
 
- Public Member Functions inherited from DistributionExperimentParams
 if (dynamic_cast< GravityModelParams * >(sipCpp) !=nullptr)
 
Py_END_ALLOW_THREADS End DistributionExperimentParams ()
 
virtual QString getTypeName () const =0
 
virtual bool validParameters (GKModel *iModel) const =0
 

Additional Inherited Members

- Public Attributes inherited from DistributionExperimentParams
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS sipType = 0
 
 else
 

Constructor & Destructor Documentation

◆ DestinationChoiceModelParams()

DestinationChoiceModelParams::DestinationChoiceModelParams ( )

Member Function Documentation

◆ getConstraintError()

double DestinationChoiceModelParams::getConstraintError ( ) const

Gets the upper bound to the maximum error between the side totals trip calculated between successive side (G/A) totals iterations.

◆ getMaxRelativeGap()

double DestinationChoiceModelParams::getMaxRelativeGap ( ) const

Gets the upper bound to the maximum relative gap between the side totals trip calculated between successive side (G/A) totals iterations.

◆ getMaxSideTotalsIterations()

uint DestinationChoiceModelParams::getMaxSideTotalsIterations ( ) const

Gets the upper bound to the maximum number of iterations of fitting the trips to the input Generation/Attraction vector.

◆ getSideTotalsConstraint()

bool DestinationChoiceModelParams::getSideTotalsConstraint ( ) const

Gets the option to adjust or not the G/A values to the input Generation/Attraction vector.

◆ getTypeName()

QString DestinationChoiceModelParams::getTypeName ( ) const
virtual

Get Distribution Model type name.

Implements DistributionExperimentParams.

◆ setConstraintError()

void DestinationChoiceModelParams::setConstraintError ( double  iConstrError)

Sets the upper bound to the maximum error between the side totals trip calculated between successive side (G/A) totals iterations.

◆ setMaxRelativeGap()

void DestinationChoiceModelParams::setMaxRelativeGap ( const double  iRelativeGap)

Sets the upper bound to the maximum relative gap between the side total trips calculated between successive side (G/A) totals iterations.

◆ setMaxSideTotalsIterations()

void DestinationChoiceModelParams::setMaxSideTotalsIterations ( uint  iOption)

Sets the upper bound to the maximum number of iterations of fitting of the trips to the input Generation/Attraction vector.

◆ setSideTotalsConstraint()

void DestinationChoiceModelParams::setSideTotalsConstraint ( bool  iOption)

Sets the option to adjust or not the G/A values to the input Generation/Attraction vector.

◆ validParameters()

bool DestinationChoiceModelParams::validParameters ( GKModel iModel) const
virtual

Check if the parameters set are valid or not.

Implements DistributionExperimentParams.

© Aimsun SLU
Aimsun ®