Aimsun Next Scripting  22
Public Member Functions | Public Attributes | List of all members
MacroAdjustmentScenarioParams Class Reference

Public Member Functions

bool useMaxDeviationFactor () const
 
bool useMaxDeviationAbsValue () const
 
GKFunctionCostgetWeightFunction () const
 
void setWeightFunction (GKFunctionCost *function)
 
GKGroupgetCongestedSections () const
 
void setCongestedSections (GKGroup *iGroup)
 
void setUserClassParams (const GKUserClass &iUser, const MacroAdjustmentScenarioUserClassParams &iParams)
 
QVector< GKUserClass * > getUsers () const
 
sipCpp applyUsers ([&users](const GKUserClass *user){ users->push_back(const_cast< GKUserClass * >(user));})
 
End MacroAdjustmentScenarioUserClassParams getUserClassParams (const GKUserClass &iUser) const
 
void removeUserClassParams (const GKUserClass &user)
 
void clearUserClassParams ()
 
bool containsUserClassParams (const GKUserClass *user) const
 
void setUseMaxDeviationFactor (bool useFactor)
 
void setUseMaxDeviationAbsValue (bool useFactor)
 
void setDetectorGrouping (GKGroupingType *grouping)
 
void setCentroidGrouping (GKGroupingType *grouping)
 
GKGroupingTypegetDetectorGrouping () const
 
GKGroupingTypegetCentroidGrouping () const
 
int getDetectorCoverageThreshold () const
 
void setTripMatrix (GKODMatrix *iMatrix)
 
GKODMatrixtripMatrix () const
 
void setTripMatrixReliability (double iFactor)
 
double tripMatrixReliability () const
 
void setTripMatrixCentroidGrouping (GKGroup *iGroup)
 
GKGrouptripMatrixCentroidGrouping () const
 

Public Attributes

MethodCode QVector< GKUserClass * > * users = new QVector<GKUserClass*>()
 
 sipRes = users
 

Detailed Description

This Class provides access to the parameters of the Static OD Adjustment.

Member Function Documentation

◆ applyUsers()

sipCpp MacroAdjustmentScenarioParams::applyUsers ( [&users] (const GKUserClass *user){ users->push_back(const_cast< GKUserClass * >(user));}  )

References users.

◆ clearUserClassParams()

void MacroAdjustmentScenarioParams::clearUserClassParams ( )

◆ containsUserClassParams()

bool MacroAdjustmentScenarioParams::containsUserClassParams ( const GKUserClass user) const

◆ getCentroidGrouping()

GKGroupingType * MacroAdjustmentScenarioParams::getCentroidGrouping ( ) const

Get the centroid grouping id

◆ getCongestedSections()

GKGroup * MacroAdjustmentScenarioParams::getCongestedSections ( ) const

Get the congested section grouping

◆ getDetectorCoverageThreshold()

int MacroAdjustmentScenarioParams::getDetectorCoverageThreshold ( ) const

Returns a percentage indicating the Detector Lane-Coverage Threshold for the static OD adjustment

◆ getDetectorGrouping()

GKGroupingType * MacroAdjustmentScenarioParams::getDetectorGrouping ( ) const

Get the detector grouping id

◆ getUserClassParams()

End MacroAdjustmentScenarioUserClassParams MacroAdjustmentScenarioParams::getUserClassParams ( const GKUserClass iUser) const

Gets the adjustment for the user class specified

◆ getUsers()

QVector< GKUserClass * > MacroAdjustmentScenarioParams::getUsers ( ) const

◆ getWeightFunction()

GKFunctionCost * MacroAdjustmentScenarioParams::getWeightFunction ( ) const

Get the weight function

◆ removeUserClassParams()

void MacroAdjustmentScenarioParams::removeUserClassParams ( const GKUserClass user)

◆ setCentroidGrouping()

void MacroAdjustmentScenarioParams::setCentroidGrouping ( GKGroupingType grouping)

Set the centroid grouping

◆ setCongestedSections()

void MacroAdjustmentScenarioParams::setCongestedSections ( GKGroup iGroup)

Set the congested sections

◆ setDetectorGrouping()

void MacroAdjustmentScenarioParams::setDetectorGrouping ( GKGroupingType grouping)

Set the detector grouping

◆ setTripMatrix()

void MacroAdjustmentScenarioParams::setTripMatrix ( GKODMatrix iMatrix)

Sets the additional goal Trip Matrix for the static OD adjustment.

◆ setTripMatrixCentroidGrouping()

void MacroAdjustmentScenarioParams::setTripMatrixCentroidGrouping ( GKGroup iGroup)

Sets the Grouping Category of Centroids used to aggregate zones for Trip Matrix processing.

◆ setTripMatrixReliability()

void MacroAdjustmentScenarioParams::setTripMatrixReliability ( double  iFactor)

Sets the Trip Matrix Reliability factor for the static OD adjustment.

◆ setUseMaxDeviationAbsValue()

void MacroAdjustmentScenarioParams::setUseMaxDeviationAbsValue ( bool  useFactor)

Set to indicate that maxDeviation values are absolute values.

◆ setUseMaxDeviationFactor()

void MacroAdjustmentScenarioParams::setUseMaxDeviationFactor ( bool  useFactor)

Set to use factor for deviation (true) or percentage (false)

◆ setUserClassParams()

void MacroAdjustmentScenarioParams::setUserClassParams ( const GKUserClass iUser,
const MacroAdjustmentScenarioUserClassParams iParams 
)

Sets the adjustment parameters for the user class specified

◆ setWeightFunction()

void MacroAdjustmentScenarioParams::setWeightFunction ( GKFunctionCost function)

Set the weight function

◆ tripMatrix()

GKODMatrix * MacroAdjustmentScenarioParams::tripMatrix ( ) const

Returns the additional goal Trip Matrix for the static OD adjustment.

◆ tripMatrixCentroidGrouping()

GKGroup * MacroAdjustmentScenarioParams::tripMatrixCentroidGrouping ( ) const

Returns the Grouping Category of Centroids used to aggregate zones for Trip Matrix processing.

◆ tripMatrixReliability()

double MacroAdjustmentScenarioParams::tripMatrixReliability ( ) const

Returns the Trip Matrix Reliability factor for the static OD adjustment.

◆ useMaxDeviationAbsValue()

bool MacroAdjustmentScenarioParams::useMaxDeviationAbsValue ( ) const

Apply the matrix deviaton matrix as absolute values

◆ useMaxDeviationFactor()

bool MacroAdjustmentScenarioParams::useMaxDeviationFactor ( ) const

Apply the matrix deviaton matrix as a factor

Member Data Documentation

◆ sipRes

MacroAdjustmentScenarioParams::sipRes = users

◆ users

MethodCode QVector<GKUserClass*>* MacroAdjustmentScenarioParams::users = new QVector<GKUserClass*>()

Referenced by applyUsers().

© Aimsun SLU
Aimsun ®