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

Public Member Functions

 MacroPTStatsView ()
 
void setPTExperiment (const MacroPTExperiment &iExperiment)
 
void setViewTimes (const QDateTime &iFrom, const QDateTime &iTo)
 
double getTotalNetworkLength () const
 
double getTotalPassengers (const GKUserClass *iUserClass) const
 
double getTotalTransfers (const GKUserClass *iUserClass) const
 
double getTotalPassengersConsideringTransfer (const GKUserClass *iUserClass) const
 
double getTotalDistanceTravelled (const GKUserClass *iUserClass) const
 
double getMeanTripDistance (const GKUserClass *iUserClass) const
 
double getCentroidAccess (const GKUserClass *iUserClass, const GKCentroid &iCentroid) const
 
double getCentroidEgress (const GKUserClass *iUserClass, const GKCentroid &iCentroid) const
 
double getCentroidWalkOnlyAccess (const GKUserClass *iUserClass, const GKCentroid &iCentroid) const
 
double getCentroidWalkOnlyEgress (const GKUserClass *iUserClass, const GKCentroid &iCentroid) const
 
double getConnectionLoad (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionAccess (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionEgress (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionWalkOnlyAccess (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getConnectionWalkOnlyEgress (const GKUserClass *iUserClass, const GKCenConnection &iConnection) const
 
double getNumberPassengersFromPTZone (const GKUserClass *iUserClass, const MacroPTZone &iFromPTZone, const MacroPTZone *iToPTZone) const
 
double getNumberPassengersToPTZone (const GKUserClass *iUserClass, const MacroPTZone *iFromPTZone, const MacroPTZone &iToPTZone) const
 
double getNumberAccessPassengersAtStop (const GKUserClass *iUserClass, const GKBusStop &iStop) const
 
double getNumberEgressPassengersAtStop (const GKUserClass *iUserClass, const GKBusStop &iStop) const
 
double getNumberTransfersWithinStop (const GKUserClass *iUserClass, const GKBusStop &iStop) const
 
double getNumberExternalTransfersFromStop (const GKUserClass *iUserClass, const GKBusStop &iStop) const
 
double getNumberExternalTransfersToStop (const GKUserClass *iUserClass, const GKBusStop &iStop) const
 
double getNumberConnectedTransfersFromStop (const GKUserClass *iUserClass, const GKBusStop &iStop, const GKPublicLine *iPTLine) const
 
double getNumberConnectedTransfersToStop (const GKUserClass *iUserClass, const GKBusStop &iStop, const GKPublicLine *iPTLine) const
 
double getNumberBoardingPassengersAtStop (const GKUserClass *iUserClass, const GKBusStop &iStop, const GKPublicLine *iPTLine) const
 
double getNumberAlightingPassengersAtStop (const GKUserClass *iUserClass, const GKBusStop &iStop, const GKPublicLine *iPTLine) const
 
double getNumberPassengersDwellingAtStop (const GKUserClass *iUserClass, const GKBusStop &iStop, const GKPublicLine *iPTLine) const
 
double getNumberAccessPassengersAtStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberEgressPassengersAtStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberTransfersWithinStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberExternalTransfersFromStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberExternalTransfersToStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberConnectedTransfersStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberBoardingPassengersAtStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getNumberAlightingPassengersAtStation (const GKUserClass *iUserClass, const GKPTStation &iStation) const
 
double getSectionPTFrequency (const GKUserClass *iUserClass, const GKSection &iSection) const
 
double getSectionPTLoad (const GKUserClass *iUserClass, const GKSection &iSection, const GKPublicLine *iPTLine) const
 
double getSectionPTOccupancy (const GKUserClass *iUserClass, const GKSection &iSection, const GKPublicLine *iPTLine) const
 
double getSectionPTCapacity (const GKUserClass *iUserClass, const GKSection &iSection, const GKPublicLine *iPTLine) const
 
double getNumberPassengersUsingPTLine (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineNumberAlightingPassengers (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineNumberBoardingPassengers (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getNumberTransfersUsingPTLine (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMaximumLoad (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMeanLoad (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMaximumOccupancy (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMeanOccupancy (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMeanTripDistance (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineTotalPassengersDistance (const GKUserClass *iUserClass, const GKPublicLine &iPTLine) const
 
double getPTLineMaximumSpeed (const GKPublicLine &iPTLine) const
 
double getPTLineMeanSpeed (const GKPublicLine &iPTLine) const
 
double getPTLineMinimumSpeed (const GKPublicLine &iPTLine) const
 
double getPTLinePTPassengersCapacity (const GKPublicLine &iPTLine) const
 
double getPTLinePTPassengersFrequency (const GKPublicLine &iPTLine) const
 
double getDetectorPTLoad (const GKUserClass *iUserClass, const GKDetector &iDetector, const GKPublicLine *iPTLine) const
 

Static Public Member Functions

static bool isValidExperiment (const MacroPTExperiment &iExperiment)
 
static bool areValidTimes (const QDateTime &iFrom, const QDateTime &iTo)
 

Static Public Attributes

static const GKUserClassAggregatedByUserClass
 
static const GKPublicLineAggregatedByPTLine
 
static const MacroPTZoneAggregatedByPTZone
 

Constructor & Destructor Documentation

◆ MacroPTStatsView()

MacroPTStatsView::MacroPTStatsView ( )

Member Function Documentation

◆ areValidTimes()

static bool MacroPTStatsView::areValidTimes ( const QDateTime &  iFrom,
const QDateTime &  iTo 
)
static

Checks whether the from and to date times are valid to read statistics. If not and set, all accessed values will return 0.0.

◆ getCentroidAccess()

double MacroPTStatsView::getCentroidAccess ( const GKUserClass iUserClass,
const GKCentroid iCentroid 
) const

!Gets Number of Passengers accessing to the Transit Network through the GKCentroid*‍/

◆ getCentroidEgress()

double MacroPTStatsView::getCentroidEgress ( const GKUserClass iUserClass,
const GKCentroid iCentroid 
) const

!Gets Number of Passengers egress from the Transit Network to the GKCentroid*‍/

◆ getCentroidWalkOnlyAccess()

double MacroPTStatsView::getCentroidWalkOnlyAccess ( const GKUserClass iUserClass,
const GKCentroid iCentroid 
) const

!Gets Number of Passengers accessing from the GKCentroid and doing Walking-Only trips*‍/

◆ getCentroidWalkOnlyEgress()

double MacroPTStatsView::getCentroidWalkOnlyEgress ( const GKUserClass iUserClass,
const GKCentroid iCentroid 
) const

!Gets Number of Passengers egress to the GKCentroid and doing Walking Only trips*‍/

◆ getConnectionAccess()

double MacroPTStatsView::getConnectionAccess ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

!Gets Number of Passengers accessing to the Transit Network through the GKCenConnection*‍/

◆ getConnectionEgress()

double MacroPTStatsView::getConnectionEgress ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

!Gets Number of Passengers egress from the Transit Network through the GKCenConnection*‍/

◆ getConnectionLoad()

double MacroPTStatsView::getConnectionLoad ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

!Gets Number of Passengers crossing in the GKCenConnection (in any direction)*‍/

◆ getConnectionWalkOnlyAccess()

double MacroPTStatsView::getConnectionWalkOnlyAccess ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

!Gets Number of Passengers accessing through the GKCenConnection and doing Walking-Only trips*‍/

◆ getConnectionWalkOnlyEgress()

double MacroPTStatsView::getConnectionWalkOnlyEgress ( const GKUserClass iUserClass,
const GKCenConnection iConnection 
) const

!Gets Number of Passengers egress through the GKCenConnection and doing Walking-Only trips*‍/

◆ getDetectorPTLoad()

double MacroPTStatsView::getDetectorPTLoad ( const GKUserClass iUserClass,
const GKDetector iDetector,
const GKPublicLine iPTLine 
) const

!Gets PT Passengers on PTLine at Detector *‍/

◆ getMeanTripDistance()

double MacroPTStatsView::getMeanTripDistance ( const GKUserClass iUserClass) const

!Gets Mean Trip Distance traveled by passengers (km)*‍/

◆ getNumberAccessPassengersAtStation()

double MacroPTStatsView::getNumberAccessPassengersAtStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Accessing Passengers from Transit Station *‍/

◆ getNumberAccessPassengersAtStop()

double MacroPTStatsView::getNumberAccessPassengersAtStop ( const GKUserClass iUserClass,
const GKBusStop iStop 
) const

!Gets Number of Accessing Passengers from Bus Stop *‍/

◆ getNumberAlightingPassengersAtStation()

double MacroPTStatsView::getNumberAlightingPassengersAtStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Passengers Alighting from PTLine at Transit Station *‍/

◆ getNumberAlightingPassengersAtStop()

double MacroPTStatsView::getNumberAlightingPassengersAtStop ( const GKUserClass iUserClass,
const GKBusStop iStop,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers Alighting from PTLine at Bus Stop *‍/

◆ getNumberBoardingPassengersAtStation()

double MacroPTStatsView::getNumberBoardingPassengersAtStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Passengers Boarding to PTLine at Transit Station *‍/

◆ getNumberBoardingPassengersAtStop()

double MacroPTStatsView::getNumberBoardingPassengersAtStop ( const GKUserClass iUserClass,
const GKBusStop iStop,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers Boarding to PTLine at Bus Stop *‍/

◆ getNumberConnectedTransfersFromStop()

double MacroPTStatsView::getNumberConnectedTransfersFromStop ( const GKUserClass iUserClass,
const GKBusStop iStop,
const GKPublicLine iPTLine 
) const

!Gets Number of Connected Trasfers Passengers using PTLine from Bus Stop *‍/

◆ getNumberConnectedTransfersStation()

double MacroPTStatsView::getNumberConnectedTransfersStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Connected Trasfers Passengers using PTLine using Transit Station *‍/

◆ getNumberConnectedTransfersToStop()

double MacroPTStatsView::getNumberConnectedTransfersToStop ( const GKUserClass iUserClass,
const GKBusStop iStop,
const GKPublicLine iPTLine 
) const

!Gets Number of Connected Trasfers Passengers using PTLine to Bus Stop *‍/

◆ getNumberEgressPassengersAtStation()

double MacroPTStatsView::getNumberEgressPassengersAtStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Egressing Passengers to Transit Station *‍/

◆ getNumberEgressPassengersAtStop()

double MacroPTStatsView::getNumberEgressPassengersAtStop ( const GKUserClass iUserClass,
const GKBusStop iStop 
) const

!Gets Number of Egressing Passengers to Bus Stop *‍/

◆ getNumberExternalTransfersFromStation()

double MacroPTStatsView::getNumberExternalTransfersFromStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of External Trasfers Passengers from Transit Station *‍/

◆ getNumberExternalTransfersFromStop()

double MacroPTStatsView::getNumberExternalTransfersFromStop ( const GKUserClass iUserClass,
const GKBusStop iStop 
) const

!Gets Number of External Trasfers Passengers from Bus Stop *‍/

◆ getNumberExternalTransfersToStation()

double MacroPTStatsView::getNumberExternalTransfersToStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of External Trasfers Passengers to Transit Station *‍/

◆ getNumberExternalTransfersToStop()

double MacroPTStatsView::getNumberExternalTransfersToStop ( const GKUserClass iUserClass,
const GKBusStop iStop 
) const

!Gets Number of External Trasfers Passengers to Bus Stop *‍/

◆ getNumberPassengersDwellingAtStop()

double MacroPTStatsView::getNumberPassengersDwellingAtStop ( const GKUserClass iUserClass,
const GKBusStop iStop,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers Dwelling in PTLine at Bus Stop *‍/

◆ getNumberPassengersFromPTZone()

double MacroPTStatsView::getNumberPassengersFromPTZone ( const GKUserClass iUserClass,
const MacroPTZone iFromPTZone,
const MacroPTZone iToPTZone 
) const

!Gets Number of Passengers traveling from MacroPTZone *‍/

◆ getNumberPassengersToPTZone()

double MacroPTStatsView::getNumberPassengersToPTZone ( const GKUserClass iUserClass,
const MacroPTZone iFromPTZone,
const MacroPTZone iToPTZone 
) const

!Gets Number of Passengers traveling to MacroPTZone *‍/

◆ getNumberPassengersUsingPTLine()

double MacroPTStatsView::getNumberPassengersUsingPTLine ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers using PTLine *‍/

◆ getNumberTransfersUsingPTLine()

double MacroPTStatsView::getNumberTransfersUsingPTLine ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Number of Transfers using PTLine *‍/

◆ getNumberTransfersWithinStation()

double MacroPTStatsView::getNumberTransfersWithinStation ( const GKUserClass iUserClass,
const GKPTStation iStation 
) const

!Gets Number of Trasfers withinPT Station *‍/

◆ getNumberTransfersWithinStop()

double MacroPTStatsView::getNumberTransfersWithinStop ( const GKUserClass iUserClass,
const GKBusStop iStop 
) const

!Gets Number of Trasfers Passengers within Stop *‍/

◆ getPTLineMaximumLoad()

double MacroPTStatsView::getPTLineMaximumLoad ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Maximum Passengers on PTLine *‍/

◆ getPTLineMaximumOccupancy()

double MacroPTStatsView::getPTLineMaximumOccupancy ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Max Occupancy of PTLine *‍/

◆ getPTLineMaximumSpeed()

double MacroPTStatsView::getPTLineMaximumSpeed ( const GKPublicLine iPTLine) const

!Gets Maximum Speed of PTLine *‍/

◆ getPTLineMeanLoad()

double MacroPTStatsView::getPTLineMeanLoad ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Mean Passengers on PTLine *‍/

◆ getPTLineMeanOccupancy()

double MacroPTStatsView::getPTLineMeanOccupancy ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Mean Occupancy of PTLine *‍/

◆ getPTLineMeanSpeed()

double MacroPTStatsView::getPTLineMeanSpeed ( const GKPublicLine iPTLine) const

!Gets Mean Speed of PTLine *‍/

◆ getPTLineMeanTripDistance()

double MacroPTStatsView::getPTLineMeanTripDistance ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Mean Trip Distance of Passengers using PTLine (km)*‍/

◆ getPTLineMinimumSpeed()

double MacroPTStatsView::getPTLineMinimumSpeed ( const GKPublicLine iPTLine) const

!Gets Min Speed of PTLine *‍/

◆ getPTLineNumberAlightingPassengers()

double MacroPTStatsView::getPTLineNumberAlightingPassengers ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers Alighting from PTLine *‍/

◆ getPTLineNumberBoardingPassengers()

double MacroPTStatsView::getPTLineNumberBoardingPassengers ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers Boarding to PTLine *‍/

◆ getPTLinePTPassengersCapacity()

double MacroPTStatsView::getPTLinePTPassengersCapacity ( const GKPublicLine iPTLine) const

!Gets Passengers Capacity of PTLine *‍/

◆ getPTLinePTPassengersFrequency()

double MacroPTStatsView::getPTLinePTPassengersFrequency ( const GKPublicLine iPTLine) const

!Gets Passengers Frequency of PTLine *‍/S

◆ getPTLineTotalPassengersDistance()

double MacroPTStatsView::getPTLineTotalPassengersDistance ( const GKUserClass iUserClass,
const GKPublicLine iPTLine 
) const

!Gets Total Distance of Passengers using PTLine (km)*‍/

◆ getSectionPTCapacity()

double MacroPTStatsView::getSectionPTCapacity ( const GKUserClass iUserClass,
const GKSection iSection,
const GKPublicLine iPTLine 
) const

!Gets Number of Transit Capacity at Section *‍/

◆ getSectionPTFrequency()

double MacroPTStatsView::getSectionPTFrequency ( const GKUserClass iUserClass,
const GKSection iSection 
) const

!Gets Number of Transit Passengers Frequency at Section *‍/

◆ getSectionPTLoad()

double MacroPTStatsView::getSectionPTLoad ( const GKUserClass iUserClass,
const GKSection iSection,
const GKPublicLine iPTLine 
) const

!Gets Number of Passengers on PTLine at Section *‍/

◆ getSectionPTOccupancy()

double MacroPTStatsView::getSectionPTOccupancy ( const GKUserClass iUserClass,
const GKSection iSection,
const GKPublicLine iPTLine 
) const

!Gets Number of Transit Passengers Occupancy at Section *‍/

◆ getTotalDistanceTravelled()

double MacroPTStatsView::getTotalDistanceTravelled ( const GKUserClass iUserClass) const

!Gets Total Distance Traveled by passengers (km)*‍/

◆ getTotalNetworkLength()

double MacroPTStatsView::getTotalNetworkLength ( ) const

!Gets Total length of Transit Lines (km)*‍/

◆ getTotalPassengers()

double MacroPTStatsView::getTotalPassengers ( const GKUserClass iUserClass) const

!Gets Total Number of Passengers *‍/

◆ getTotalPassengersConsideringTransfer()

double MacroPTStatsView::getTotalPassengersConsideringTransfer ( const GKUserClass iUserClass) const

!Gets Total Number of Passengers considering Transfer option *‍/

◆ getTotalTransfers()

double MacroPTStatsView::getTotalTransfers ( const GKUserClass iUserClass) const

!Gets Total Number of Transfers done *‍/

◆ isValidExperiment()

static bool MacroPTStatsView::isValidExperiment ( const MacroPTExperiment iExperiment)
static

Checks whether the MacroPTExperiment is valid to read its stastistics. If not and set, all accessed values will return 0.0.

◆ setPTExperiment()

void MacroPTStatsView::setPTExperiment ( const MacroPTExperiment iExperiment)

Sets the Transit Stats Manager to be read.

◆ setViewTimes()

void MacroPTStatsView::setViewTimes ( const QDateTime &  iFrom,
const QDateTime &  iTo 
)

Sets the Statistics from and to time to be read.

Member Data Documentation

◆ AggregatedByPTLine

const GKPublicLine* MacroPTStatsView::AggregatedByPTLine
static

◆ AggregatedByPTZone

const MacroPTZone* MacroPTStatsView::AggregatedByPTZone
static

◆ AggregatedByUserClass

const GKUserClass* MacroPTStatsView::AggregatedByUserClass
static

© Aimsun SLU
Aimsun ®