Aimsun Next Scripting  24.0
Public Types | Public Member Functions | Public Attributes | List of all members
GKScenarioInputData Class Reference

Public Types

enum  ODStatType { eNone , eSelection , eAll }
 
enum class  TrajectoryType { eVehicles = 0 , ePedestrian = 1 }
 

Public Member Functions

 GKScenarioInputData ()
 
GKScenariogetScenario () const
 
bool isCycleDetectionAsSimulationStep () const
 
void setCycleDetectionAsSimulationStep (bool value)
 
float getCycleDetection () const
 
void setCycleDetection (float value)
 
void setInputPathAssignmentPlan (GKPathAssignmentPlan *)
 
GKPathAssignmentPlangetInputPathAssignmentPlan () const
 
const QList< QPair< GKFilePath, QString > > getExtensions () const
 
sipCpp getExtensions ([&extensions](const GKFilePath &path, bool enabled){ extensions->push_back(QPair< GKFilePath, QString >(path, enabled ? QString("1") :QString("0")));})
 
End void removeExtensions ()
 
void addExtension (const QString &extPath, bool enabled)
 
void removeExtension (const QString &extPath)
 
void enableExtension (const QString &extPath, bool value)
 
int getNumberOfAimsunExtensions () const
 
bool containsAimsunExtension (const QString &name) const
 
const QString & getAimsunExtensionAt (int index) const
 
const QString & getParametersFromExtension (const QString &name) const
 
const QString & getParametersFromExtensionAt (int index) const
 
void setParametersForExtension (const QString &name, const QString &params)
 
void setParametersForExtensionAt (int index, const QString &params)
 
void activateExtension (const QString &name)
 
void activateExtensionAt (int index)
 
void deactivateExtension (const QString &name)
 
void deactivateExtensionAt (int index)
 
bool isAimsunExtensionActive (const QString &name) const
 
bool isAimsunExtensionActiveAt (int index) const
 
bool storeEnabled () const
 
bool getKeepHistoryStat () const
 
void setKeepHistoryStat (bool value)
 
bool getKeepHistoryDet () const
 
void setKeepHistoryDet (bool value)
 
bool getActivateStatistics () const
 
const GKTimeDurationgetStatisticalInterval () const
 
void setStatisticalInterval (const GKTimeDuration &atime)
 
bool storeStatisticsEnabled () const
 
void enableStoreStatistics (bool value)
 
const GKTimeDurationgetDetectionInterval () const
 
void setDetectionInterval (const GKTimeDuration &atime)
 
bool storeDetectionEnabled () const
 
void enableStoreDetection (bool value)
 
bool getSectionsStatistics () const
 
void setSectionsStatistics (bool value)
 
bool getSectionLanesStatistics () const
 
void setSectionLanesStatistics (bool value)
 
void setControlPlanStatistics (bool value)
 
bool getControlPlanStatistics () const
 
void setTrafficManagementStatistics (bool value)
 
bool getTrafficManagementStatistics () const
 
bool getPedestrianCrossingStatistics () const
 
void setPedestrianCrossingStatistics (bool value)
 
bool getServicePointStatistics () const
 
void setServicePointStatistics (bool value)
 
bool getPTStopStatistics () const
 
void setPTStopStatistics (bool value)
 
void setGroupStatistics (bool value)
 
bool getGroupStatistics () const
 
bool getMatrixStatistics () const
 
void setMatrixStatistics (bool value)
 
bool getPTStatistics () const
 
void setPTStatistics (bool value)
 
bool getTurnsStatistics () const
 
void setTurnsStatistics (bool value)
 
bool getSubPathsStatistics () const
 
void setSubPathsStatistics (bool value)
 
bool getEnergyConsumption () const
 
void setEnergyConsumption (bool value)
 
bool getPollutionEmission () const
 
void setPollutionEmission (bool value)
 
bool getInstantEmission () const
 
void setInstantEmission (bool value)
 
bool getLemStatistics () const
 
void setLemStatistics (bool value)
 
bool getHcmStatistics () const
 
void setHcmStatistics (bool value)
 
double getHCMApproachMaxDistance () const
 
void setHCMApproachMaxDistance (double aDistance)
 
bool getStoreAllPairsPathStat () const
 
void setStoreAllPairsPathStat (bool)
 
void clearPairsForPathStat ()
 
void addPairForPathStat (uint, uint)
 
void removePairForPathStat (uint, uint)
 
bool getSaveLinkCosts () const
 
void setSaveLinkCosts (bool)
 
ODStatType getPairsStatistics () const
 
void setPairsStatistics (ODStatType)
 
ODStatType getOriginStatistics () const
 
void setOriginStatistics (ODStatType)
 
ODStatType getDestinationStatistics () const
 
void setDestinationStatistics (ODStatType)
 
void clearPairListStatistics ()
 
void addPairListStatistics (const GKPairStat &aPair)
 
void removePairListStatistics (const GKPairStat &aPair)
 
const QVector< GKPairStat > & getPairListStatistics () const
 
bool isPairInStatistics (const GKPairStat &aPair) const
 
void clearSubPaths ()
 
void addSubPath (GKSubPath *subpath)
 
void removeSubPath (GKSubPath *subpath)
 
const QVector< GKSubPath * > & getSubPaths () const
 
bool isSubPathInStatistics (GKSubPath *subpath) const
 
int getNbStatisticsIntervals () const
 
int getNbDetectionIntervals () const
 
bool getKeepPathsInMemory () const
 
void setKeepPathsInMemory (bool keep)
 
bool getActivateLinkCosts () const
 
void setKeepLinkCostsInMemory (bool keep)
 
bool getKeepLinkCostsInMemory () const
 
bool generateRelativeGapMatrices () const
 
void setGenerateRelativeGapMatrices (bool value)
 
bool saveRelativeGapStats () const
 
void setSaveRelativeGapStats (bool value)
 
bool saveLinkCostAndFlowStats () const
 
void setSaveLinkCostAndFlowStats (bool value)
 
uint getNLastIterationsToSave () const
 
void setNLastIterationsToSave (int num)
 
const GKGroupgetLinkStatsGroup () const
 
void setLinkStatsGroup (const GKGroup *group)
 
bool getSaveAnimation () const
 
void setSaveAnimation (bool value)
 
const QString & getAnimationFile () const
 
void setAnimationFile (const QString &afileName)
 
double getAnimationRotation () const
 
double getAnimationXRotationCenter () const
 
double getAnimationYRotationCenter () const
 
double getAnimationXTranslation () const
 
double getAnimationYTranslation () const
 
void setAnimationRotation (double value)
 
void setAnimationXRotationCenter (double value)
 
void setAnimationYRotationCenter (double value)
 
void setAnimationXTranslation (double value)
 
void setAnimationYTranslation (double value)
 
GKPolygongetAnimationPolygon () const
 
void setAnimationPolygon (GKPolygon *pol)
 
void setControlTurnStatistics (bool save)
 
bool getControlTurnStatistics () const
 
void setControlSignalStatistics (bool save)
 
bool getControlSignalStatistics () const
 
void setControlPhaseStatistics (bool save)
 
bool getControlPhaseStatistics () const
 
void setControlPhaseEventStatistics (bool save)
 
bool getControlPhaseEventStatistics () const
 
void setControlMeteringStatistics (bool save)
 
bool getControlMeteringStatistics () const
 
bool getTrajectoriesStatistics () const
 
void setTrajectoriesStatistics (bool value)
 
void setTrajectoryConditionsStats (TrajectoryType aTrajectoriesType, const std::vector< GKTrajectoryCondition > &aTrajectories)
 
const std::vector< GKTrajectoryCondition > & getTrajectoryListStatistics (TrajectoryType aTrajectoriesType) const
 
std::vector< GKTrajectoryConditiongetTrajectoryListByVehicleType (TrajectoryType aTrajectoriesType, uint aMobileAgentId)
 
std::vector< GKTrajectoryConditiongetTrajectoryListByCentroid (TrajectoryType aTrajectoriesType, uint aCentroidId)
 
void addTrajectoryListStatistics (TrajectoryType aTrajectoriesType, const GKTrajectoryCondition &value)
 
void removeTrajectoryListStatistics (TrajectoryType aTrajectoriesType, const GKTrajectoryCondition &value)
 
void clearTrajectoryListStatistics (TrajectoryType aTrajectoriesType)
 
void clearPTTrajectories ()
 
void addPTTrajectory (int idLine, float percentage, bool keepStopTimes)
 
const QMap< int, GKPublicTransportStat > & getPTTrajectories () const
 
void setGlobalTrajectoriesStatistics (bool save)
 
bool getGlobalTrajectoriesStatistics () const
 
void setSectionTrajectoriesStatistics (bool save)
 
bool getSectionTrajectoriesStatistics () const
 
void setDetailedTrajectoriesStatistics (bool save)
 
bool getDetailedTrajectoriesStatistics () const
 
void setGlobalPedTrajectoriesStatistics (bool aGlobalPedTrajectories)
 
bool getGlobalPedTrajectoriesStatistics () const
 
void setDetailedPedTrajectoriesStatistics (bool aDetailedPedTrajectories)
 
bool getDetailedPedTrajectoriesStatistics () const
 
bool getIndividualPTStats () const
 
void setIndividualPTStats (bool value)
 
void setDebugControllers (bool save)
 
bool getDebugControllers () const
 
void setGenerateSCATSSignalGroupFiles (bool save)
 
bool getGenerateSCATSSignalGroupFiles () const
 
void setPrefixForSCATSSignalGroupFiles (const QString &prefix)
 
const QString & getPrefixForSCATSSignalGroupFiles () const
 

Public Attributes

MethodCode QList< QPair< GKFilePath, QString > > * extensions = new QList< QPair<GKFilePath,QString> >()
 
 sipRes = extensions
 

Detailed Description

This class holds all the scenario input data (traffic demand, control plans, transit plans, outputs settings, ...)

Member Enumeration Documentation

◆ ODStatType

Enumerator
eNone 
eSelection 
eAll 

◆ TrajectoryType

Trajectory conditions Type.

Enumerator
eVehicles 
ePedestrian 

Constructor & Destructor Documentation

◆ GKScenarioInputData()

GKScenarioInputData::GKScenarioInputData ( )

Member Function Documentation

◆ activateExtension()

void GKScenarioInputData::activateExtension ( const QString &  name)

If 'name' is found in the Enhanced Aimsun Next Extensions, it activates it. Else, nothing happens.

◆ activateExtensionAt()

void GKScenarioInputData::activateExtensionAt ( int  index)

It activates the Enhanced Aimsun Next Extension at 'index'. [ Store internal extensions always active ] PRE: 0 <= index < numberOfAimsunExtensions

◆ addExtension()

void GKScenarioInputData::addExtension ( const QString &  extPath,
bool  enabled 
)

Add an Aimsun Next API to the scenario list of APIs. The extPath is the full path to the Aimsun Next API. The enabled indicates whether it is active or not.

◆ addPairForPathStat()

void GKScenarioInputData::addPairForPathStat ( uint  ,
uint   
)

◆ addPairListStatistics()

void GKScenarioInputData::addPairListStatistics ( const GKPairStat aPair)

Adds a centroid pair to the list of centroids from where statistics will be collected.

◆ addPTTrajectory()

void GKScenarioInputData::addPTTrajectory ( int  idLine,
float  percentage,
bool  keepStopTimes 
)

Adds a trajectory to the list of trajectories from where statistics will be collected.

◆ addSubPath()

void GKScenarioInputData::addSubPath ( GKSubPath subpath)

Adds a subpath to the list of subpaths from where statistics will be collected.

◆ addTrajectoryListStatistics()

void GKScenarioInputData::addTrajectoryListStatistics ( TrajectoryType  aTrajectoriesType,
const GKTrajectoryCondition value 
)

Adds a trajectory to the list of trajectories from where statistics will be collected.

◆ clearPairListStatistics()

void GKScenarioInputData::clearPairListStatistics ( )

Removes all centroid pairs from the list of centroid pairs from where statistics will be collected.

◆ clearPairsForPathStat()

void GKScenarioInputData::clearPairsForPathStat ( )

◆ clearPTTrajectories()

void GKScenarioInputData::clearPTTrajectories ( )

Removes all trajectories from the list of trajectories from where statistics will be collected.

◆ clearSubPaths()

void GKScenarioInputData::clearSubPaths ( )

Removes all subpaths from the list of subpaths from where statistics will be collected.

◆ clearTrajectoryListStatistics()

void GKScenarioInputData::clearTrajectoryListStatistics ( TrajectoryType  aTrajectoriesType)

Removes all trajectories from the list of trajectories from where statistics will be collected (API purpose)

◆ containsAimsunExtension()

bool GKScenarioInputData::containsAimsunExtension ( const QString &  name) const

Returns if the Enhanced Aimsun Next Extensions with 'name' is included in this scenario (Active or not).

◆ deactivateExtension()

void GKScenarioInputData::deactivateExtension ( const QString &  name)

If 'name' is found in the Enhanced Aimsun Next Extensions, it deactivates it. Else, nothing happens.

◆ deactivateExtensionAt()

void GKScenarioInputData::deactivateExtensionAt ( int  index)

It deactivates the Enhanced Aimsun Next Extension at 'index'. PRE: 0 <= index < numberOfAimsunExtensions

◆ enableExtension()

void GKScenarioInputData::enableExtension ( const QString &  extPath,
bool  value 
)

Activates or deactivates (depending on 'value') the API whose full path is specified in extPath.

◆ enableStoreDetection()

void GKScenarioInputData::enableStoreDetection ( bool  value)

Sets whether the detection data will be stored in the database or not

◆ enableStoreStatistics()

void GKScenarioInputData::enableStoreStatistics ( bool  value)

Sets whether the statistics will be stored in the database or not

◆ generateRelativeGapMatrices()

bool GKScenarioInputData::generateRelativeGapMatrices ( ) const

Returns true if the relative gap matrices are generated and false otherwise.

◆ getActivateLinkCosts()

bool GKScenarioInputData::getActivateLinkCosts ( ) const

returns whether the storing of the link costs is activated or not

◆ getActivateStatistics()

bool GKScenarioInputData::getActivateStatistics ( ) const

Returns whether the Statistics calculation are activated in the scenario or not. That is whether time series will be generated or they will be stored in the database.

◆ getAimsunExtensionAt()

const QString & GKScenarioInputData::getAimsunExtensionAt ( int  index) const

Returns the name of the Enhanced Aimsun Next Extensions at 'index' in this scenario (Active or not). PRE: 0 <= index < numberOfAimsunExtensions

◆ getAnimationFile()

const QString & GKScenarioInputData::getAnimationFile ( ) const

Gets the file where the XML animation for micro experiments will be stored into.

◆ getAnimationPolygon()

GKPolygon * GKScenarioInputData::getAnimationPolygon ( ) const

Gets the XML animation polygon to limit the animation output to objects inside the polygon. None if all the geometry is going to be taken into account.

◆ getAnimationRotation()

double GKScenarioInputData::getAnimationRotation ( ) const

Gets the XML animation rotation (in degrees)

◆ getAnimationXRotationCenter()

double GKScenarioInputData::getAnimationXRotationCenter ( ) const

Gets the X coordinate of the XML animation rotation center

◆ getAnimationXTranslation()

double GKScenarioInputData::getAnimationXTranslation ( ) const

Gets the X coordinate of the XML animation translation

◆ getAnimationYRotationCenter()

double GKScenarioInputData::getAnimationYRotationCenter ( ) const

Gets the Y coordinate of the XML animation rotation center

◆ getAnimationYTranslation()

double GKScenarioInputData::getAnimationYTranslation ( ) const

Gets the Y coordinate of the XML animation translation

◆ getControlMeteringStatistics()

bool GKScenarioInputData::getControlMeteringStatistics ( ) const

Returns whether control statistics for meterings are being saved or not.

◆ getControlPhaseEventStatistics()

bool GKScenarioInputData::getControlPhaseEventStatistics ( ) const

Returns whether control statistics for phase events are being saved or not. Useful mainly for actuated control plans.

◆ getControlPhaseStatistics()

bool GKScenarioInputData::getControlPhaseStatistics ( ) const

Returns whether control statistics for phases are being saved or not

◆ getControlPlanStatistics()

bool GKScenarioInputData::getControlPlanStatistics ( ) const

Once the Statistics have been activated, this function returns if control plan statistics are gathered

◆ getControlSignalStatistics()

bool GKScenarioInputData::getControlSignalStatistics ( ) const

Returns whether control statistics for signal groups are being saved or not

◆ getControlTurnStatistics()

bool GKScenarioInputData::getControlTurnStatistics ( ) const

Returns whether control statistics for turns are being saved or not

◆ getCycleDetection()

float GKScenarioInputData::getCycleDetection ( ) const

The detection cycle in seconds

◆ getDebugControllers()

bool GKScenarioInputData::getDebugControllers ( ) const

Gets whether to create debug files for controllers or not.

◆ getDestinationStatistics()

ODStatType GKScenarioInputData::getDestinationStatistics ( ) const

◆ getDetailedPedTrajectoriesStatistics()

bool GKScenarioInputData::getDetailedPedTrajectoriesStatistics ( ) const

◆ getDetailedTrajectoriesStatistics()

bool GKScenarioInputData::getDetailedTrajectoriesStatistics ( ) const

◆ getDetectionInterval()

const GKTimeDuration & GKScenarioInputData::getDetectionInterval ( ) const

Returns the detection interval defined

◆ getEnergyConsumption()

bool GKScenarioInputData::getEnergyConsumption ( ) const

Returns whether statistics about energy consumption will be calculated or not

◆ getExtensions() [1/2]

const QList< QPair< GKFilePath, QString > > GKScenarioInputData::getExtensions ( ) const

Returns the list of Aimsun APIs in this scenario. The first item in the pair is the full path to the Aimsun Next API. The second item in the pair contains a 0 or 1 to indicate if it is active or not.

◆ getExtensions() [2/2]

sipCpp GKScenarioInputData::getExtensions ( [&extensions] (const GKFilePath &path, bool enabled){ extensions->push_back(QPair< GKFilePath, QString >(path, enabled ? QString("1") :QString("0")));}  )

References extensions.

◆ getGenerateSCATSSignalGroupFiles()

bool GKScenarioInputData::getGenerateSCATSSignalGroupFiles ( ) const

Gets whether to create log files for SCATS controllers or not.

◆ getGlobalPedTrajectoriesStatistics()

bool GKScenarioInputData::getGlobalPedTrajectoriesStatistics ( ) const

◆ getGlobalTrajectoriesStatistics()

bool GKScenarioInputData::getGlobalTrajectoriesStatistics ( ) const

◆ getGroupStatistics()

bool GKScenarioInputData::getGroupStatistics ( ) const

Returns whether grouping statistics are gathered or not

◆ getHCMApproachMaxDistance()

double GKScenarioInputData::getHCMApproachMaxDistance ( ) const

Returns the HCM approach building maximum distance (in meters).

◆ getHcmStatistics()

bool GKScenarioInputData::getHcmStatistics ( ) const

Returns whether the HCM statistics are activated or not.

◆ getIndividualPTStats()

bool GKScenarioInputData::getIndividualPTStats ( ) const

◆ getInputPathAssignmentPlan()

GKPathAssignmentPlan * GKScenarioInputData::getInputPathAssignmentPlan ( ) const

Returns the path assignment plan object used as input

◆ getInstantEmission()

bool GKScenarioInputData::getInstantEmission ( ) const

Returns whether Instant Emission pollutants will be calculated or not

◆ getKeepHistoryDet()

bool GKScenarioInputData::getKeepHistoryDet ( ) const

Returns whether the detection data is defined to generate time series or not

◆ getKeepHistoryStat()

bool GKScenarioInputData::getKeepHistoryStat ( ) const

Returns whether the statistics are defined to generate time series or not

◆ getKeepLinkCostsInMemory()

bool GKScenarioInputData::getKeepLinkCostsInMemory ( ) const

returns the keep in memory flag of the link costs

◆ getKeepPathsInMemory()

bool GKScenarioInputData::getKeepPathsInMemory ( ) const

Returns whether path assignment is being kept in memory or not

◆ getLemStatistics()

bool GKScenarioInputData::getLemStatistics ( ) const

Returns whether Tate Emission pollutants model will be calculated or not. Keep in mind that is mandatory "activate" sections check box

◆ getLinkStatsGroup()

const GKGroup * GKScenarioInputData::getLinkStatsGroup ( ) const

Only the Costs and Travel Times for the Links included in the group will be saved to the database. All Links will be saved if no group is specified

◆ getMatrixStatistics()

bool GKScenarioInputData::getMatrixStatistics ( ) const

Once the Statistics have been activated, this function returns whether the centroid statistics calculation is activated or not.

◆ getNbDetectionIntervals()

int GKScenarioInputData::getNbDetectionIntervals ( ) const

Helper function: how many intervals for detection? It takes into account the simulation length and the detection interval.

◆ getNbStatisticsIntervals()

int GKScenarioInputData::getNbStatisticsIntervals ( ) const

Helper function: how many intervals for statistics? It takes into account the simulation length and the stat interval.

◆ getNLastIterationsToSave()

uint GKScenarioInputData::getNLastIterationsToSave ( ) const

Only the Costs and Travel Times for the last N iterations will be saved to the database. All iterations will be saved if set to 0

◆ getNumberOfAimsunExtensions()

int GKScenarioInputData::getNumberOfAimsunExtensions ( ) const

Returns the number of Enhanced Aimsun Next Extensions for this scenario (Active or not).

◆ getOriginStatistics()

ODStatType GKScenarioInputData::getOriginStatistics ( ) const

◆ getPairListStatistics()

const QVector< GKPairStat > & GKScenarioInputData::getPairListStatistics ( ) const

Returns the list of centroid pairs from where statistics will be collected.

◆ getPairsStatistics()

ODStatType GKScenarioInputData::getPairsStatistics ( ) const

◆ getParametersFromExtension()

const QString & GKScenarioInputData::getParametersFromExtension ( const QString &  name) const

If 'name' is found in the Enhanced Aimsun Next Extensions, returns the parameters. Else, returns the name unchanged.

◆ getParametersFromExtensionAt()

const QString & GKScenarioInputData::getParametersFromExtensionAt ( int  index) const

Returns the parameters in the Enhanced Aimsun Next Extensions at 'index'. PRE: 0 <= index < numberOfAimsunExtensions

◆ getPedestrianCrossingStatistics()

bool GKScenarioInputData::getPedestrianCrossingStatistics ( ) const

Returns whether pedestrian crossing statistics are gathered or not

◆ getPollutionEmission()

bool GKScenarioInputData::getPollutionEmission ( ) const

Returns whether statistics for pollutants will be calculated or not

◆ getPrefixForSCATSSignalGroupFiles()

const QString & GKScenarioInputData::getPrefixForSCATSSignalGroupFiles ( ) const

Gets the prefix (that is, complete path + file prefix) to use when creating the log files for SCATS Controllers. The ID of the controller and the txt extension will be automatically added to the prefix when creating the file to write the info in.

◆ getPTStatistics()

bool GKScenarioInputData::getPTStatistics ( ) const

Once the Statistics have been activated, this function returns whether the transit statistics calculation is activated or not.

◆ getPTStopStatistics()

bool GKScenarioInputData::getPTStopStatistics ( ) const

Returns whether pedestrian transit stop statistics are gathered or not

◆ getPTTrajectories()

const QMap< int, GKPublicTransportStat > & GKScenarioInputData::getPTTrajectories ( ) const

Returns the list of trajectory from where statistics will be collected.

◆ getSaveAnimation()

bool GKScenarioInputData::getSaveAnimation ( ) const

Gets whether to store an XML animation or not for micro experiments.

◆ getSaveLinkCosts()

bool GKScenarioInputData::getSaveLinkCosts ( ) const

◆ getScenario()

GKScenario * GKScenarioInputData::getScenario ( ) const

Returns the scenario related to this scenario input data

◆ getSectionLanesStatistics()

bool GKScenarioInputData::getSectionLanesStatistics ( ) const

Once the Statistics have been activated, this function returns whether the section lane statistics calculation is activated or not.

◆ getSectionsStatistics()

bool GKScenarioInputData::getSectionsStatistics ( ) const

Once the Statistics have been activated, this function returns whether the section statistics calculation is activated or not.

◆ getSectionTrajectoriesStatistics()

bool GKScenarioInputData::getSectionTrajectoriesStatistics ( ) const

◆ getServicePointStatistics()

bool GKScenarioInputData::getServicePointStatistics ( ) const

Returns whether pedestrian service point statistics are gathered or not

◆ getStatisticalInterval()

const GKTimeDuration & GKScenarioInputData::getStatisticalInterval ( ) const

Returns the statistics interval defined

◆ getStoreAllPairsPathStat()

bool GKScenarioInputData::getStoreAllPairsPathStat ( ) const

◆ getSubPaths()

const QVector< GKSubPath * > & GKScenarioInputData::getSubPaths ( ) const

Returns the list of subpaths from where statistics will be collected.

◆ getSubPathsStatistics()

bool GKScenarioInputData::getSubPathsStatistics ( ) const

Once the Statistics have been activated, this function returns whether the subpath statistics calculation is activated or not.

◆ getTrafficManagementStatistics()

bool GKScenarioInputData::getTrafficManagementStatistics ( ) const

Once the Statistics have been activated, this function returns if traffic management statistics are gathered

◆ getTrajectoriesStatistics()

bool GKScenarioInputData::getTrajectoriesStatistics ( ) const

Returns whether statistics about trajectories will be stored in the database or not

◆ getTrajectoryListByCentroid()

std::vector< GKTrajectoryCondition > GKScenarioInputData::getTrajectoryListByCentroid ( TrajectoryType  aTrajectoriesType,
uint  aCentroidId 
)

Removes a trajectorypair from the list of trajectories from where statistics will be collected by centroid.

◆ getTrajectoryListByVehicleType()

std::vector< GKTrajectoryCondition > GKScenarioInputData::getTrajectoryListByVehicleType ( TrajectoryType  aTrajectoriesType,
uint  aMobileAgentId 
)

Removes a trajectorypair from the list of trajectories from where statistics will be collected by mobile agent.

◆ getTrajectoryListStatistics()

const std::vector< GKTrajectoryCondition > & GKScenarioInputData::getTrajectoryListStatistics ( TrajectoryType  aTrajectoriesType) const

Returns the list of trajectory from where statistics will be collected by trajectories type (veh or ped)

◆ getTurnsStatistics()

bool GKScenarioInputData::getTurnsStatistics ( ) const

Once the Statistics have been activated, this function returns whether the nodes and turns statistics calculation is activated or not.

◆ isAimsunExtensionActive()

bool GKScenarioInputData::isAimsunExtensionActive ( const QString &  name) const

If 'name' is found in the Enhanced Aimsun Next Extensions and is active, returns true. Else, returns false.

◆ isAimsunExtensionActiveAt()

bool GKScenarioInputData::isAimsunExtensionActiveAt ( int  index) const

Returns true if the Enhanced Aimsun Next Extension at 'index' is active. Else, returns false. PRE: 0 <= index < numberOfAimsunExtensions

◆ isCycleDetectionAsSimulationStep()

bool GKScenarioInputData::isCycleDetectionAsSimulationStep ( ) const

Use the simulation step as the detection cycle? The default is yes.

◆ isPairInStatistics()

bool GKScenarioInputData::isPairInStatistics ( const GKPairStat aPair) const

Returns true if the centroid pair is in the list of centroid pairs from where statistics will be collected.

◆ isSubPathInStatistics()

bool GKScenarioInputData::isSubPathInStatistics ( GKSubPath subpath) const

Returns true if the subpath is in the list of subpaths from where statistics will be collected.

◆ removeExtension()

void GKScenarioInputData::removeExtension ( const QString &  extPath)

Removes an Aimsun Next API from the scenario list of APIs. The extPath is the full path to the Aimsun Next API.

◆ removeExtensions()

End void GKScenarioInputData::removeExtensions ( )

Removes all the Aimsun APIs in this scenario from the list.

◆ removePairForPathStat()

void GKScenarioInputData::removePairForPathStat ( uint  ,
uint   
)

◆ removePairListStatistics()

void GKScenarioInputData::removePairListStatistics ( const GKPairStat aPair)

Removes a centroid pair from the list of centroid pairs from where statistics will be collected.

◆ removeSubPath()

void GKScenarioInputData::removeSubPath ( GKSubPath subpath)

Removes the specified subpath from the input data.

◆ removeTrajectoryListStatistics()

void GKScenarioInputData::removeTrajectoryListStatistics ( TrajectoryType  aTrajectoriesType,
const GKTrajectoryCondition value 
)

Removes a trajectorypair from the list of trajectories from where statistics will be collected (API purpose)

◆ saveLinkCostAndFlowStats()

bool GKScenarioInputData::saveLinkCostAndFlowStats ( ) const

Returns true if Link Costs and Travel Times need to be saved to the database. ( DUELINKDATA )

◆ saveRelativeGapStats()

bool GKScenarioInputData::saveRelativeGapStats ( ) const

Returns true if the relative gap statistics need to be saved to the database ( DUERGAP + DUEITERDATA ).

◆ setAnimationFile()

void GKScenarioInputData::setAnimationFile ( const QString &  afileName)

Sets the file where the XML animation for micro experiments will be stored into.

◆ setAnimationPolygon()

void GKScenarioInputData::setAnimationPolygon ( GKPolygon pol)

Sets the XML animation polygon to limit the animation output to objects inside the polygon.

◆ setAnimationRotation()

void GKScenarioInputData::setAnimationRotation ( double  value)

Sets the XML animation rotation (in degrees)

◆ setAnimationXRotationCenter()

void GKScenarioInputData::setAnimationXRotationCenter ( double  value)

Sets the X coordinate of the XML animation rotation center

◆ setAnimationXTranslation()

void GKScenarioInputData::setAnimationXTranslation ( double  value)

Sets the X coordinate of the XML animation translation

◆ setAnimationYRotationCenter()

void GKScenarioInputData::setAnimationYRotationCenter ( double  value)

Sets the Y coordinate of the XML animation rotation center

◆ setAnimationYTranslation()

void GKScenarioInputData::setAnimationYTranslation ( double  value)

Sets the Y coordinate of the XML animation translation

◆ setControlMeteringStatistics()

void GKScenarioInputData::setControlMeteringStatistics ( bool  save)

Sets whether control statistics for meterings are being saved or not.

◆ setControlPhaseEventStatistics()

void GKScenarioInputData::setControlPhaseEventStatistics ( bool  save)

Sets whether control statistics for phase events are being saved or not. Useful mainly for actuated control plans.

◆ setControlPhaseStatistics()

void GKScenarioInputData::setControlPhaseStatistics ( bool  save)

Sets whether control statistics for phases are being saved or not

◆ setControlPlanStatistics()

void GKScenarioInputData::setControlPlanStatistics ( bool  value)

Once the Statistics have been activated, this function sets whether control plan statistics are gathered or not

◆ setControlSignalStatistics()

void GKScenarioInputData::setControlSignalStatistics ( bool  save)

Sets whether control statistics for signal groups are being saved or not

◆ setControlTurnStatistics()

void GKScenarioInputData::setControlTurnStatistics ( bool  save)

Sets whether control statistics for turns are being saved or not

◆ setCycleDetection()

void GKScenarioInputData::setCycleDetection ( float  value)

The detection cycle in seconds

◆ setCycleDetectionAsSimulationStep()

void GKScenarioInputData::setCycleDetectionAsSimulationStep ( bool  value)

Use the simulation step as the detection cycle? The default is yes.

◆ setDebugControllers()

void GKScenarioInputData::setDebugControllers ( bool  save)

Sets whether to create debug files for controllers or not.

◆ setDestinationStatistics()

void GKScenarioInputData::setDestinationStatistics ( ODStatType  )

◆ setDetailedPedTrajectoriesStatistics()

void GKScenarioInputData::setDetailedPedTrajectoriesStatistics ( bool  aDetailedPedTrajectories)

◆ setDetailedTrajectoriesStatistics()

void GKScenarioInputData::setDetailedTrajectoriesStatistics ( bool  save)

◆ setDetectionInterval()

void GKScenarioInputData::setDetectionInterval ( const GKTimeDuration atime)

Sets the time interval to be used for gathering detection data.

◆ setEnergyConsumption()

void GKScenarioInputData::setEnergyConsumption ( bool  value)

Sets whether statistics about energy consumption will be calculated or not

◆ setGenerateRelativeGapMatrices()

void GKScenarioInputData::setGenerateRelativeGapMatrices ( bool  value)

Sets whether the relative gap matrices will be generated.

◆ setGenerateSCATSSignalGroupFiles()

void GKScenarioInputData::setGenerateSCATSSignalGroupFiles ( bool  save)

Sets whether to create log files for SCATS controllers or not.

◆ setGlobalPedTrajectoriesStatistics()

void GKScenarioInputData::setGlobalPedTrajectoriesStatistics ( bool  aGlobalPedTrajectories)

◆ setGlobalTrajectoriesStatistics()

void GKScenarioInputData::setGlobalTrajectoriesStatistics ( bool  save)

Once the Trajectories have been activated, this function sets whether the gloabl trajectory data is going to be gathered or not.

◆ setGroupStatistics()

void GKScenarioInputData::setGroupStatistics ( bool  value)

Sets whether grouping statistics are gathered or not

◆ setHCMApproachMaxDistance()

void GKScenarioInputData::setHCMApproachMaxDistance ( double  aDistance)

Set the HCM approach building maximum distance (in meters).

◆ setHcmStatistics()

void GKScenarioInputData::setHcmStatistics ( bool  value)

Returns whether to activate the HCM statistics or not.

◆ setIndividualPTStats()

void GKScenarioInputData::setIndividualPTStats ( bool  value)

◆ setInputPathAssignmentPlan()

void GKScenarioInputData::setInputPathAssignmentPlan ( GKPathAssignmentPlan )

Sets the path assignment plan object used as input

◆ setInstantEmission()

void GKScenarioInputData::setInstantEmission ( bool  value)

Sets whether Instant Emission pollutants will be calculated or not

◆ setKeepHistoryDet()

void GKScenarioInputData::setKeepHistoryDet ( bool  value)

Sets whether the detection data will generate time series or not

◆ setKeepHistoryStat()

void GKScenarioInputData::setKeepHistoryStat ( bool  value)

Sets whether the statistics are defined to generate time series or not

◆ setKeepLinkCostsInMemory()

void GKScenarioInputData::setKeepLinkCostsInMemory ( bool  keep)

sets the keep in memory flag of the link costs

◆ setKeepPathsInMemory()

void GKScenarioInputData::setKeepPathsInMemory ( bool  keep)

Sets whether path assignment is going to be kept in memory or not

◆ setLemStatistics()

void GKScenarioInputData::setLemStatistics ( bool  value)

Sets whether Tate Emission pollutants model will be calculated or not. Keep in mind that is mandatory "activate" sections check box

◆ setLinkStatsGroup()

void GKScenarioInputData::setLinkStatsGroup ( const GKGroup group)

Sets which Links Costs and Travel times need to be saved to the database.

◆ setMatrixStatistics()

void GKScenarioInputData::setMatrixStatistics ( bool  value)

Once the Statistics have been activated, this function returns whether the centroid statistics calculation is activated or not.

◆ setNLastIterationsToSave()

void GKScenarioInputData::setNLastIterationsToSave ( int  num)

Sets the number of iterations ( starting by last one ) that need to be saved to the database.

◆ setOriginStatistics()

void GKScenarioInputData::setOriginStatistics ( ODStatType  )

◆ setPairsStatistics()

void GKScenarioInputData::setPairsStatistics ( ODStatType  )

◆ setParametersForExtension()

void GKScenarioInputData::setParametersForExtension ( const QString &  name,
const QString &  params 
)

If 'name' is found in the Enhanced Aimsun Next Extensions, is modifies its parameters with 'params'. Else, it creates the extension with (name, params, false).

◆ setParametersForExtensionAt()

void GKScenarioInputData::setParametersForExtensionAt ( int  index,
const QString &  params 
)

It modifies the parameters in the Enhanced Aimsun Next Extensions at 'index'. PRE: 0 <= index < numberOfAimsunExtensions

◆ setPedestrianCrossingStatistics()

void GKScenarioInputData::setPedestrianCrossingStatistics ( bool  value)

Sets whether pedestrian crossing statistics are gathered or not

◆ setPollutionEmission()

void GKScenarioInputData::setPollutionEmission ( bool  value)

Sets whether statistics for pollutants will be calculated or not

◆ setPrefixForSCATSSignalGroupFiles()

void GKScenarioInputData::setPrefixForSCATSSignalGroupFiles ( const QString &  prefix)

Sets the prefix (that is, complete path + file prefix) to use when creating the log files for SCATS Controllers. The ID of the controller and the txt extension will be automatically added to the prefix when creating the file to write the info in.

◆ setPTStatistics()

void GKScenarioInputData::setPTStatistics ( bool  value)

Once the Statistics have been activated, this function sets whether the transit statistics calculation will be activated or not.

◆ setPTStopStatistics()

void GKScenarioInputData::setPTStopStatistics ( bool  value)

Sets whether pedestrian transit stop statistics are gathered or not

◆ setSaveAnimation()

void GKScenarioInputData::setSaveAnimation ( bool  value)

Sets whether to store an XML animation or not for micro experiments.

◆ setSaveLinkCostAndFlowStats()

void GKScenarioInputData::setSaveLinkCostAndFlowStats ( bool  value)

Sets whether Link Cost and Travel Times statistics need to be saved to the database.

◆ setSaveLinkCosts()

void GKScenarioInputData::setSaveLinkCosts ( bool  )

◆ setSaveRelativeGapStats()

void GKScenarioInputData::setSaveRelativeGapStats ( bool  value)

Sets whether the relative gap statistics need to be saved to the database.

◆ setSectionLanesStatistics()

void GKScenarioInputData::setSectionLanesStatistics ( bool  value)

Once the Statistics have been activated, this function activates or deactivates section lanes statistics calculation.

◆ setSectionsStatistics()

void GKScenarioInputData::setSectionsStatistics ( bool  value)

Once the Statistics have been activated, this function activates or deactivates section statistics calculation.

◆ setSectionTrajectoriesStatistics()

void GKScenarioInputData::setSectionTrajectoriesStatistics ( bool  save)

◆ setServicePointStatistics()

void GKScenarioInputData::setServicePointStatistics ( bool  value)

Sets whether pedestrian service point statistics are gathered or not

◆ setStatisticalInterval()

void GKScenarioInputData::setStatisticalInterval ( const GKTimeDuration atime)

Sets the time interval to be used for gathering statistics.

◆ setStoreAllPairsPathStat()

void GKScenarioInputData::setStoreAllPairsPathStat ( bool  )

◆ setSubPathsStatistics()

void GKScenarioInputData::setSubPathsStatistics ( bool  value)

Once the Statistics have been activated, this function sets whether the subpath statistics calculation is activated or not.

◆ setTrafficManagementStatistics()

void GKScenarioInputData::setTrafficManagementStatistics ( bool  value)

Once the Statistics have been activated, this function sets whether traffic management statistics are gathered or not

◆ setTrajectoriesStatistics()

void GKScenarioInputData::setTrajectoriesStatistics ( bool  value)

Sets whether to store statistics about trajectories in the database or not

◆ setTrajectoryConditionsStats()

void GKScenarioInputData::setTrajectoryConditionsStats ( TrajectoryType  aTrajectoriesType,
const std::vector< GKTrajectoryCondition > &  aTrajectories 
)

Set trajectory conditions for statistics.

◆ setTurnsStatistics()

void GKScenarioInputData::setTurnsStatistics ( bool  value)

Once the Statistics have been activated, this function sets whether the nodes and turns statistics calculation will be activated or not.

◆ storeDetectionEnabled()

bool GKScenarioInputData::storeDetectionEnabled ( ) const

Returns whether the detection data is defined to be stored in the database or not

◆ storeEnabled()

bool GKScenarioInputData::storeEnabled ( ) const

Returns true if simulation data will be store in the database (getActivateStatistics, getActivateDetection, getActivatePathStat, storeStatisticsEnabled, storeDetectionEnabled, storePathStatEnabled)

◆ storeStatisticsEnabled()

bool GKScenarioInputData::storeStatisticsEnabled ( ) const

Returns whether the statistics are defined to be stored in the database or not

Member Data Documentation

◆ extensions

MethodCode QList< QPair<GKFilePath,QString> >* GKScenarioInputData::extensions = new QList< QPair<GKFilePath,QString> >()

Referenced by getExtensions().

◆ sipRes

GKScenarioInputData::sipRes = extensions

© Aimsun SLU
Aimsun ®