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

Public Member Functions

double getSectionVolume (const GKUserClass *iUserClass, const GKSection &iSection) const
 
double getSectionVehicleVolume (const GKVehicle *iVehicle, const GKSection &iSection) const
 
double getSectionOccupancy (const GKUserClass *iUserClass, const GKSection &iSection) const
 
double getSectionCost (const GKUserClass *iUserClass, const GKSection &iSection) const
 
double getSectionCostComponent (const GKUserClass *iUserClass, const GKSection &iSection, const GKFunctionComponent &iComponent) const
 
double getTotalSectionVolume (const GKSection &iSection, const bool iWeightedByPCU=true) const
 
double getTotalSectionOccupancy (const GKSection &iSection) const
 
double getTotalSectionCost (const GKSection &iSection, const bool iWeightedByPCU=true) const
 
double getTotalSectionCostComponent (const GKSection &iSection, const GKFunctionComponent &iComponent, const bool iWeightedByPCU=true) const
 
double getTurningVolume (const GKUserClass *iUserClass, const GKTurning &iTurning) const
 
double getTurningVehicleVolume (const GKVehicle *iVehicle, const GKTurning &iTurning) const
 
double getTurningPercentage (const GKUserClass *iUserClass, const GKTurning &iTurning) const
 
double getTurningCost (const GKUserClass *iUserClass, const GKTurning &iTurning) const
 
double getTurningCostComponent (const GKUserClass *iUserClass, const GKTurning &iTurning, const GKFunctionComponent &iComponent) const
 
double getTotalTurningVolume (const GKTurning &iTurning, const bool iWeightedByPCU=true) const
 
double getTotalTurningPercentage (const GKTurning &iTurning, const bool iWeightedByPCU=true) const
 
double getTotalTurningCost (const GKTurning &iTurning, const bool iWeightedByPCU=true) const
 
double getTotalTurningCostComponent (const GKTurning &iTurning, const GKFunctionComponent &iComponent, const bool iWeightedByPCU=true) const
 
double getTrajectoryVolume (const GKUserClass *iUserClass, const GKSuperNodeTrajectory &iTrajectory) const
 
double getTrajectoryVehicleVolume (const GKVehicle *iVehicle, const GKSuperNodeTrajectory &iTrajectory) const
 
double getTrajectoryPercentage (const GKUserClass *iUserClass, const GKSuperNodeTrajectory &iTrajectory) const
 
double getTrajectoryCost (const GKUserClass *iUserClass, const GKSuperNodeTrajectory &iTrajectory) const
 
double getTrajectoryCostComponent (const GKUserClass *iUserClass, const GKSuperNodeTrajectory &iTrajectory, const GKFunctionComponent &iComponent) const
 
double getTotalTrajectoryVolume (const GKSuperNodeTrajectory &iTrajectory, const bool iWeightedByPCU=true) const
 
double getTotalTrajectoryPercentage (const GKSuperNodeTrajectory &iTrajectory, const bool iWeightedByPCU=true) const
 
double getTotalTrajectoryCost (const GKSuperNodeTrajectory &iTrajectory, const bool iWeightedByPCU=true) const
 
double getTotalTrajectoryCostComponent (const GKSuperNodeTrajectory &iTrajectory, const GKFunctionComponent &iComponent, const bool iWeightedByPCU=true) const
 
double getConnectionVolume (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionVehicleVolume (const GKVehicle *iVehicle, const GKCenConnection &iConnection) const
 
double getConnectionCost (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionCostComponent (const GKUserClass *iUserClass, const GKCenConnection &iConnection, const GKFunctionComponent &iComponent) const
 
double getTotalConnectionVolume (const GKCenConnection &iConnection, const bool iWeightedByPCU=true) const
 
double getTotalConnectionCost (const GKCenConnection &iConnection, const bool iWeightedByPCU=true) const
 
double getTotalConnectionCostComponent (const GKCenConnection &iConnection, const GKFunctionComponent &iComponent, const bool iWeightedByPCU=true) const
 
double getRouteVolume (const GKUserClass *iUserClass, const GKRoute &iRoute) const
 
double getRouteVehicleVolume (const GKVehicle *iVehicle, const GKRoute &iRoute) const
 
double getRouteCost (const GKUserClass *iUserClass, const GKRoute &iRoute) const
 
double getRouteCostComponent (const GKUserClass *iUserClass, const GKRoute &iRoute, const GKFunctionComponent &iComponent) const
 
double getTotalRouteVolume (const GKRoute &iRoute, const bool iWeightedByPCU=true) const
 
double getTotalRouteCost (const GKRoute &iRoute, const bool iWeightedByPCU=true) const
 
double getTotalRouteCostComponent (const GKRoute &iRoute, const GKFunctionComponent &iComponent, const bool iWeightedByPCU=true) const
 
double getDetectorVolume (const GKUserClass *iUserClass, const GKDetector &iDetector) const
 
double getDetectorVehicleVolume (const GKVehicle *iVehicle, const GKDetector &iDetector) const
 
double getTotalDetectorVolume (const GKDetector &iDetector, const bool iWeightedByPCU=true) const
 
double getSectionVolume (int _userclassId, int _sectionId)
 
double getSectionOccupancy (int _userClassId, int _sectionId)
 
double getSectionCost (int _userclassId, int _sectionId)
 
double getTurningVolume (int _userClassId, int _sectionId)
 
double getTurningPercentage (int _userClassId, int _sectionId)
 
double getTurningCost (int _userclassId, int _sectionId)
 
QVector< int > getSections ()
 
QVector< int > getTurnings ()
 
QVector< int > getUserIds ()
 
QVector< GKUserClass * > getUsers () const
 
QVector< GKVehicle * > getVehicles () const
 
const QVector< MacroIterationInfo > & getIterationsInfo () const
 
void createTrafficState ()
 
double getMeanOccupation (qint32 iUserId) const
 
double getTotalCost (qint32 iUserId) const
 
double getVolumeDistance (qint32 iUserId) const
 

Detailed Description

The CMacroStatsmanager class provides an interface to access the static assignment results.

Member Function Documentation

◆ createTrafficState()

void CMacroStatsManager::createTrafficState ( )

Creates a traffic state for each of the user IDs with their associated volumes

◆ getConnectionCost()

double CMacroStatsManager::getConnectionCost ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

get connection cost for specified iConnection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getConnectionCostComponent()

double CMacroStatsManager::getConnectionCostComponent ( const GKUserClass iUserClass,
const GKCenConnection iConnection,
const GKFunctionComponent iComponent 
) const

get connection cost component for iComponent, and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getConnectionVehicleVolume()

double CMacroStatsManager::getConnectionVehicleVolume ( const GKVehicle iVehicle,
const GKCenConnection iConnection 
) const

get connection volume for specified iConnection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getConnectionVolume()

double CMacroStatsManager::getConnectionVolume ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

get connection volume for specified iConnection and iUserClass id, use userClassId=-1 for the total weighted by PCU

◆ getDetectorVehicleVolume()

double CMacroStatsManager::getDetectorVehicleVolume ( const GKVehicle iVehicle,
const GKDetector iDetector 
) const

get detector volume for specified iDetector and iVehicle, use iVehicle = None for the total

◆ getDetectorVolume()

double CMacroStatsManager::getDetectorVolume ( const GKUserClass iUserClass,
const GKDetector iDetector 
) const

get detector volume for specified iDetector and iUserClass, use iUserClass = None for the total

◆ getIterationsInfo()

const QVector< MacroIterationInfo > & CMacroStatsManager::getIterationsInfo ( ) const

get a list of assignment information for each iteration

◆ getMeanOccupation()

double CMacroStatsManager::getMeanOccupation ( qint32  iUserId) const

Get the mean occupancy of the network for specified user

◆ getRouteCost()

double CMacroStatsManager::getRouteCost ( const GKUserClass iUserClass,
const GKRoute iRoute 
) const

get route cost for specified iRoute and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getRouteCostComponent()

double CMacroStatsManager::getRouteCostComponent ( const GKUserClass iUserClass,
const GKRoute iRoute,
const GKFunctionComponent iComponent 
) const

get route cost component for iComponent, iRoute and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getRouteVehicleVolume()

double CMacroStatsManager::getRouteVehicleVolume ( const GKVehicle iVehicle,
const GKRoute iRoute 
) const

get route volume for specified iRoute and iVehicle, use iVehicle = None for the total weighted by PCU

◆ getRouteVolume()

double CMacroStatsManager::getRouteVolume ( const GKUserClass iUserClass,
const GKRoute iRoute 
) const

get route volume for specified iRoute and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getSectionCost() [1/2]

double CMacroStatsManager::getSectionCost ( const GKUserClass iUserClass,
const GKSection iSection 
) const

get section cost for specified iSection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getSectionCost() [2/2]

double CMacroStatsManager::getSectionCost ( int  _userclassId,
int  _sectionId 
)

get section cost for specified section and userClass id, use userClassId=-1 for all

◆ getSectionCostComponent()

double CMacroStatsManager::getSectionCostComponent ( const GKUserClass iUserClass,
const GKSection iSection,
const GKFunctionComponent iComponent 
) const

get section cost component for iComponent, iSection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getSectionOccupancy() [1/2]

double CMacroStatsManager::getSectionOccupancy ( const GKUserClass iUserClass,
const GKSection iSection 
) const

get section occupancy for specified iSection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getSectionOccupancy() [2/2]

double CMacroStatsManager::getSectionOccupancy ( int  _userClassId,
int  _sectionId 
)

get section occupancy for specified section and userClass id, use userClassId=-1 for all

◆ getSections()

QVector< int > CMacroStatsManager::getSections ( )

get a list of all sections in this assignment

◆ getSectionVehicleVolume()

double CMacroStatsManager::getSectionVehicleVolume ( const GKVehicle iVehicle,
const GKSection iSection 
) const

get section volume for specified iSection and vehicle type, use iUserClass = None for the total weighted by PCU

◆ getSectionVolume() [1/2]

double CMacroStatsManager::getSectionVolume ( const GKUserClass iUserClass,
const GKSection iSection 
) const

get section volume for specified iSection and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getSectionVolume() [2/2]

double CMacroStatsManager::getSectionVolume ( int  _userclassId,
int  _sectionId 
)

get section volume for specified section and userClass id, use userClassId=-1 for all

◆ getTotalConnectionCost()

double CMacroStatsManager::getTotalConnectionCost ( const GKCenConnection iConnection,
const bool  iWeightedByPCU = true 
) const

get total connection cost for iConnection weighted by user class volume (by default in PCUs).

◆ getTotalConnectionCostComponent()

double CMacroStatsManager::getTotalConnectionCostComponent ( const GKCenConnection iConnection,
const GKFunctionComponent iComponent,
const bool  iWeightedByPCU = true 
) const

get total connection cost component for iComponent and iConnection weighted by user class volume (by default in PCUs).

◆ getTotalConnectionVolume()

double CMacroStatsManager::getTotalConnectionVolume ( const GKCenConnection iConnection,
const bool  iWeightedByPCU = true 
) const

get total connection volume component for iConnection weighted by user class volume (by default in PCUs).

◆ getTotalCost()

double CMacroStatsManager::getTotalCost ( qint32  iUserId) const

Get the total cost of the network for specified user

◆ getTotalDetectorVolume()

double CMacroStatsManager::getTotalDetectorVolume ( const GKDetector iDetector,
const bool  iWeightedByPCU = true 
) const

get total detector volume for specified iDetector weighted by user class volume (by default in PCUs).

◆ getTotalRouteCost()

double CMacroStatsManager::getTotalRouteCost ( const GKRoute iRoute,
const bool  iWeightedByPCU = true 
) const

get total route cost for specified iRoute weighted by user class volume (by default in PCUs).

◆ getTotalRouteCostComponent()

double CMacroStatsManager::getTotalRouteCostComponent ( const GKRoute iRoute,
const GKFunctionComponent iComponent,
const bool  iWeightedByPCU = true 
) const

get total route cost component for iComponent and iRoute weighted by user class volume (by default in PCUs).

◆ getTotalRouteVolume()

double CMacroStatsManager::getTotalRouteVolume ( const GKRoute iRoute,
const bool  iWeightedByPCU = true 
) const

get total route volume for specified iRoute weighted by user class volume (by default in PCUs).

◆ getTotalSectionCost()

double CMacroStatsManager::getTotalSectionCost ( const GKSection iSection,
const bool  iWeightedByPCU = true 
) const

get total section cost for specified iSection weighted by user class volume (by default in PCUs).

◆ getTotalSectionCostComponent()

double CMacroStatsManager::getTotalSectionCostComponent ( const GKSection iSection,
const GKFunctionComponent iComponent,
const bool  iWeightedByPCU = true 
) const

get total section cost component for specified iComponent and iSection weighted by user class volume (by default in PCUs).

◆ getTotalSectionOccupancy()

double CMacroStatsManager::getTotalSectionOccupancy ( const GKSection iSection) const

get total section occupancy for specified iSection weighted by user class PCU volume.

◆ getTotalSectionVolume()

double CMacroStatsManager::getTotalSectionVolume ( const GKSection iSection,
const bool  iWeightedByPCU = true 
) const

get total section volume for specified iSection weighted by user class volume (by default in PCUs).

◆ getTotalTrajectoryCost()

double CMacroStatsManager::getTotalTrajectoryCost ( const GKSuperNodeTrajectory iTrajectory,
const bool  iWeightedByPCU = true 
) const

get trajectory cost for specified iTrajectory weighted by user class volume (by default in PCUs).

◆ getTotalTrajectoryCostComponent()

double CMacroStatsManager::getTotalTrajectoryCostComponent ( const GKSuperNodeTrajectory iTrajectory,
const GKFunctionComponent iComponent,
const bool  iWeightedByPCU = true 
) const

get trajectory cost component for iComponent and iTrajectory weighted by user class volume (by default in PCUs).

◆ getTotalTrajectoryPercentage()

double CMacroStatsManager::getTotalTrajectoryPercentage ( const GKSuperNodeTrajectory iTrajectory,
const bool  iWeightedByPCU = true 
) const

get trajectory percentage for specified iTrajectory weighted by user class volume (by default in PCUs).

◆ getTotalTrajectoryVolume()

double CMacroStatsManager::getTotalTrajectoryVolume ( const GKSuperNodeTrajectory iTrajectory,
const bool  iWeightedByPCU = true 
) const

get trajectory volume for specified iTrajectory weighted by user class volume (by default in PCUs).

◆ getTotalTurningCost()

double CMacroStatsManager::getTotalTurningCost ( const GKTurning iTurning,
const bool  iWeightedByPCU = true 
) const

get turning cost for specified iTurning weighted by user class volume (by default in PCUs).

◆ getTotalTurningCostComponent()

double CMacroStatsManager::getTotalTurningCostComponent ( const GKTurning iTurning,
const GKFunctionComponent iComponent,
const bool  iWeightedByPCU = true 
) const

get turning cost component for iComponent and iTurning weighted by user class volume (by default in PCUs).

◆ getTotalTurningPercentage()

double CMacroStatsManager::getTotalTurningPercentage ( const GKTurning iTurning,
const bool  iWeightedByPCU = true 
) const

get turning percentage for specified iTurning weighted by user class volume (by default in PCUs).

◆ getTotalTurningVolume()

double CMacroStatsManager::getTotalTurningVolume ( const GKTurning iTurning,
const bool  iWeightedByPCU = true 
) const

get turning volume for specified iTurning weighted by user class volume (by default in PCUs).

◆ getTrajectoryCost()

double CMacroStatsManager::getTrajectoryCost ( const GKUserClass iUserClass,
const GKSuperNodeTrajectory iTrajectory 
) const

get trajectory cost for specified iTrajectory and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTrajectoryCostComponent()

double CMacroStatsManager::getTrajectoryCostComponent ( const GKUserClass iUserClass,
const GKSuperNodeTrajectory iTrajectory,
const GKFunctionComponent iComponent 
) const

get trajectory cost component for iComponent, iTrajectory and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTrajectoryPercentage()

double CMacroStatsManager::getTrajectoryPercentage ( const GKUserClass iUserClass,
const GKSuperNodeTrajectory iTrajectory 
) const

get trajectory percentage for specified iTrajectory and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTrajectoryVehicleVolume()

double CMacroStatsManager::getTrajectoryVehicleVolume ( const GKVehicle iVehicle,
const GKSuperNodeTrajectory iTrajectory 
) const

get trajectory volume for specified iTrajectory and iVehicle, use iVehicle = None for the total weighted by PCU

◆ getTrajectoryVolume()

double CMacroStatsManager::getTrajectoryVolume ( const GKUserClass iUserClass,
const GKSuperNodeTrajectory iTrajectory 
) const

get trajectory volume for specified iTrajectory and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTurningCost() [1/2]

double CMacroStatsManager::getTurningCost ( const GKUserClass iUserClass,
const GKTurning iTurning 
) const

get turning cost for specified iTurning and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTurningCost() [2/2]

double CMacroStatsManager::getTurningCost ( int  _userclassId,
int  _sectionId 
)

get turn cost for specified turn and userClass id, use userClassId=-1 for all

◆ getTurningCostComponent()

double CMacroStatsManager::getTurningCostComponent ( const GKUserClass iUserClass,
const GKTurning iTurning,
const GKFunctionComponent iComponent 
) const

get turning cost component for iComponent, iTurning and iUserClass, use iUserClass = None for the total

◆ getTurningPercentage() [1/2]

double CMacroStatsManager::getTurningPercentage ( const GKUserClass iUserClass,
const GKTurning iTurning 
) const

get turning percentage for specified iTurning and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTurningPercentage() [2/2]

double CMacroStatsManager::getTurningPercentage ( int  _userClassId,
int  _sectionId 
)

get turn percentage for specified turn and userClass id, use userClassId=-1 for all

◆ getTurnings()

QVector< int > CMacroStatsManager::getTurnings ( )

get a list of all turns in this assignment

◆ getTurningVehicleVolume()

double CMacroStatsManager::getTurningVehicleVolume ( const GKVehicle iVehicle,
const GKTurning iTurning 
) const

get turning volume for specified iTurning and iVehicle, use iVehicle = None for the total weighted by PCU

◆ getTurningVolume() [1/2]

double CMacroStatsManager::getTurningVolume ( const GKUserClass iUserClass,
const GKTurning iTurning 
) const

get turning volume for specified iTurning and iUserClass, use iUserClass = None for the total weighted by PCU

◆ getTurningVolume() [2/2]

double CMacroStatsManager::getTurningVolume ( int  _userClassId,
int  _sectionId 
)

get turn volume for specified turn and userClass id, use userClassId=-1 for all

◆ getUserIds()

QVector< int > CMacroStatsManager::getUserIds ( )

get a list of all userIds in this assignment

◆ getUsers()

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

get a list of all user classes used in this assignment

◆ getVehicles()

QVector< GKVehicle * > CMacroStatsManager::getVehicles ( ) const

get a list of all vehicle types used in this assignment

◆ getVolumeDistance()

double CMacroStatsManager::getVolumeDistance ( qint32  iUserId) const

Get the total distance traveled for a specified user class

© Aimsun SLU
Aimsun ®