|
Aimsun Next Scripting
22
|
Public Types | |
| enum | ODStatType { eNone , eSelection , eAll } |
This class holds all the scenario input data (traffic demand, control plans, transit plans, statistics, ...)
| GKScenarioInputData::GKScenarioInputData | ( | ) |
| void GKScenarioInputData::activateExtension | ( | const QString & | name | ) |
If 'name' is found in the Enhanced Aimsun Next Extensions, it activates it. Else, nothing happens.
| void GKScenarioInputData::activateExtensionAt | ( | int | index | ) |
It activates the Enhanced Aimsun Next Extension at 'index'. [ Store internal extensions always active ] PRE: 0 <= index < numberOfAimsunExtensions
| void GKScenarioInputData::addExtension | ( | const QString & | extPath, |
| bool | enabled | ||
| ) |
| void GKScenarioInputData::addNodeTurnListStatistics | ( | GKNode * | aNode | ) |
Adds a node to the list of nodes from where turn statistics will be collected.
| void GKScenarioInputData::addPairForPathStat | ( | uint | , |
| uint | |||
| ) |
| void GKScenarioInputData::addPairListStatistics | ( | const GKPairStat & | aPair | ) |
Adds a centroid pair to the list of centroids from where statistics will be collected.
| void GKScenarioInputData::addPTTrajectory | ( | int | idLine, |
| float | percentage, | ||
| bool | keepStopTimes | ||
| ) |
Adds a trajectory to the list of trajectories from where statistics will be collected.
| void GKScenarioInputData::addSectListStatistics | ( | GKSection * | ) |
Adds a section to the list of sections from where statistics will be collected.
| void GKScenarioInputData::addSubPath | ( | GKSubPath * | subpath | ) |
Adds a subpath to the list of subpaths from where statistics will be collected.
| void GKScenarioInputData::addTrajectoryListStatistics | ( | const GKTrajectoryCondition & | value | ) |
Adds a trajectory to the list of trajectories from where statistics will be collected.
| void GKScenarioInputData::clearNodeTurnListStatistics | ( | ) |
Removes all nodes from the list of nodes from where turn statistics will be collected.
| void GKScenarioInputData::clearPairListStatistics | ( | ) |
Removes all centroid pairs from the list of centroid pairs from where statistics will be collected.
| void GKScenarioInputData::clearPairsForPathStat | ( | ) |
| void GKScenarioInputData::clearPTTrajectories | ( | ) |
Removes all trajectories from the list of trajectories from where statistics will be collected.
| void GKScenarioInputData::clearSectListStatistics | ( | ) |
Removes all sections from the list of sections from where statistics will be collected.
| void GKScenarioInputData::clearSubPaths | ( | ) |
Removes all subpaths from the list of subpaths from where statistics will be collected.
| void GKScenarioInputData::clearTrajectoryListStatistics | ( | ) |
Removes all trajectories from the list of trajectories from where statistics will be collected.
| bool GKScenarioInputData::containsAimsunExtension | ( | const QString & | name | ) | const |
Returns if the Enhanced Aimsun Next Extensions with 'name' is included in this scenario (Active or not).
| void GKScenarioInputData::deactivateExtension | ( | const QString & | name | ) |
If 'name' is found in the Enhanced Aimsun Next Extensions, it deactivates it. Else, nothing happens.
| void GKScenarioInputData::deactivateExtensionAt | ( | int | index | ) |
It deactivates the Enhanced Aimsun Next Extension at 'index'. PRE: 0 <= index < numberOfAimsunExtensions
| void GKScenarioInputData::enableExtension | ( | const QString & | extPath, |
| bool | value | ||
| ) |
Activates or deactivates (depending on 'value') the API whose full path is specified in extPath.
| void GKScenarioInputData::enableStoreDetection | ( | bool | value | ) |
Sets whether the detection data will be stored in the database or not
| void GKScenarioInputData::enableStoreStatistics | ( | bool | value | ) |
Sets whether the statistics will be stored in the database or not
| bool GKScenarioInputData::getActivateLinkCosts | ( | ) | const |
returns whether the storing of the link costs is activated or not
| bool GKScenarioInputData::getActivateStatistics | ( | ) | const |
Returns whether the Statistics calculation are activated in the scenario or not.
| 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
| bool GKScenarioInputData::getAllGroupingsStatistics | ( | ) | const |
| bool GKScenarioInputData::getAllNodesTurnsStatistics | ( | ) | const |
Once the Statistics and the turns statistics have been activated, this function returns whether the turns statistics will be calculated for all turns or not.
| bool GKScenarioInputData::getAllPTLinesStatistics | ( | ) | const |
Once the Statistics and the Transit Lines statistics have been activated, this function returns whether the Transit Lines statistics will be calculated for all Transit Lines or not.
| bool GKScenarioInputData::getAllSectStatistics | ( | ) | const |
Once the Statistics have been activated, and the section statistics have been also activated, this function returns whether the section statistics will be calculated for all sections or not.
| bool GKScenarioInputData::getAllSubPathsStatistics | ( | ) | const |
| const QString & GKScenarioInputData::getAnimationFile | ( | ) | const |
| GKPolygon * GKScenarioInputData::getAnimationPolygon | ( | ) | const |
| double GKScenarioInputData::getAnimationRotation | ( | ) | const |
| double GKScenarioInputData::getAnimationXRotationCenter | ( | ) | const |
| double GKScenarioInputData::getAnimationXTranslation | ( | ) | const |
| double GKScenarioInputData::getAnimationYRotationCenter | ( | ) | const |
| double GKScenarioInputData::getAnimationYTranslation | ( | ) | const |
| bool GKScenarioInputData::getControlMeteringStatistics | ( | ) | const |
Returns whether control statistics for meterings are being saved or not.
| bool GKScenarioInputData::getControlPhaseEventStatistics | ( | ) | const |
Returns whether control statistics for phase events are being saved or not. Useful mainly for actuated control plans.
| bool GKScenarioInputData::getControlPhaseStatistics | ( | ) | const |
Returns whether control statistics for phases are being saved or not
| bool GKScenarioInputData::getControlPlanStatistics | ( | ) | const |
returns if control plan statistics are gathered
| bool GKScenarioInputData::getControlSignalStatistics | ( | ) | const |
Returns whether control statistics for signal groups are being saved or not
| bool GKScenarioInputData::getControlTurnStatistics | ( | ) | const |
Returns whether control statistics for turns are being saved or not
| float GKScenarioInputData::getCycleDetection | ( | ) | const |
The detection cycle in seconds
| bool GKScenarioInputData::getDebugControllers | ( | ) | const |
Gets whether to create debug files for controllers or not.
| ODStatType GKScenarioInputData::getDestinationStatistics | ( | ) | const |
| bool GKScenarioInputData::getDetailedTrajectoriesStatistics | ( | ) | const |
| const GKTimeDuration & GKScenarioInputData::getDetectionInterval | ( | ) | const |
Returns the detection interval defined
| bool GKScenarioInputData::getDeviationStatistics | ( | ) | const |
| bool GKScenarioInputData::getEnergyConsumption | ( | ) | const |
Returns whether statistics about fuel consumption will be calculated or not
| bool GKScenarioInputData::getEntrancesStatistics | ( | ) | const |
Once the Statistics have been activated and the section statistics have been also activated, if they have been activated only for some, this function returns whether statistics will be calculated for all the entrance sections or not.
| bool GKScenarioInputData::getExitsStatistics | ( | ) | const |
Once the Statistics have been activated and the section statistics have been also activated, if they have been activated only for some, this function returns whether statistics will be calculated for all the exit sections or not.
| const QList< QPair< QString, QString > > & GKScenarioInputData::getExtensions | ( | ) | const |
| bool GKScenarioInputData::getGenerateSCATSSignalGroupFiles | ( | ) | const |
Gets whether to create log files for SCATS controllers or not.
| bool GKScenarioInputData::getGlobalTrajectoriesStatistics | ( | ) | const |
| bool GKScenarioInputData::getGroupStatistics | ( | ) | const |
Returns whether grouping statistics are gathered or not
| bool GKScenarioInputData::getHcmStatistics | ( | ) | const |
| bool GKScenarioInputData::getIndividualPTStats | ( | ) | const |
| GKPathAssignmentPlan * GKScenarioInputData::getInputPathAssignmentPlan | ( | ) | const |
Returns the path assignment plan object used as input
| bool GKScenarioInputData::getInstantEmission | ( | ) | const |
Returns whether Instant Emission pollutants will be calculated or not
| bool GKScenarioInputData::getKeepHistoryDet | ( | ) | const |
Returns whether the detection data is defined to be kept in memory or not
| bool GKScenarioInputData::getKeepHistoryStat | ( | ) | const |
Returns whether the statistics are defined to be kept in memory on not
| bool GKScenarioInputData::getKeepLinkCostsInMemory | ( | ) | const |
returns the keep in memory flag of the link costs
| bool GKScenarioInputData::getKeepPathsInMemory | ( | ) | const |
Returns whether path assignment is being kept in memory or not
| 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
| bool GKScenarioInputData::getMatrixStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the OD matrices statistics calculation is activated or not.
| int GKScenarioInputData::getNbDetectionIntervals | ( | ) | const |
Helper function: how many intervals for detection? It takes into account the simulation length and the detection interval.
| int GKScenarioInputData::getNbStatisticsIntervals | ( | ) | const |
Helper function: how many intervals for statistics? It takes into account the simulation length and the stat interval.
| const QVector< GKNode * > & GKScenarioInputData::getNodeTurnListStatistics | ( | ) | const |
Returns the list of nodes from where turn statistics will be collected.
| int GKScenarioInputData::getNumberOfAimsunExtensions | ( | ) | const |
Returns the number of Enhanced Aimsun Next Extensions for this scenario (Active or not).
| ODStatType GKScenarioInputData::getOriginStatistics | ( | ) | const |
| const QVector< GKPairStat > & GKScenarioInputData::getPairListStatistics | ( | ) | const |
Returns the list of centroid pairs from where statistics will be collected.
| ODStatType GKScenarioInputData::getPairsStatistics | ( | ) | const |
| 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.
| const QString & GKScenarioInputData::getParametersFromExtensionAt | ( | int | index | ) | const |
Returns the parameters in the Enhanced Aimsun Next Extensions at 'index'. PRE: 0 <= index < numberOfAimsunExtensions
| bool GKScenarioInputData::getPedestrianCrossingStatistics | ( | ) | const |
Returns whether pedestrian crossing statistics are gathered or not
| bool GKScenarioInputData::getPollutionEmission | ( | ) | const |
Returns whether statistics for pollutants will be calculated or not
| 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.
| bool GKScenarioInputData::getPTStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the transit statistics calculation is activated or not.
| bool GKScenarioInputData::getPTStopStatistics | ( | ) | const |
Returns whether pedestrian service point statistics are gathered or not
| const QMap< int, GKPublicTransportStat > & GKScenarioInputData::getPTTrajectories | ( | ) | const |
Returns the list of trajectory from where statistics will be collected.
| bool GKScenarioInputData::getSaveAnimation | ( | ) | const |
| bool GKScenarioInputData::getSaveLinkCosts | ( | ) | const |
| bool GKScenarioInputData::getSaveTrafficArrivals | ( | ) | const |
| GKScenario * GKScenarioInputData::getScenario | ( | ) | const |
Returns the scenario releated to this scenario input data
| bool GKScenarioInputData::getSectionLanesStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the section lane statistics calculation is activated or not.
| bool GKScenarioInputData::getSectionsStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the section statistics calculation is activated or not.
| bool GKScenarioInputData::getSectionTrajectoriesStatistics | ( | ) | const |
| const QVector< GKSection * > & GKScenarioInputData::getSectListStatistics | ( | ) | const |
Returns the list of sections from where statistics will be collected.
| bool GKScenarioInputData::getServicePointStatistics | ( | ) | const |
Returns whether pedestrian service point statistics are gathered or not
| const GKTimeDuration & GKScenarioInputData::getStatisticalInterval | ( | ) | const |
Returns the statistics interval defined
| bool GKScenarioInputData::getStoreAllPairsPathStat | ( | ) | const |
| const QVector< GKSubPath * > & GKScenarioInputData::getSubPaths | ( | ) | const |
Returns the list of subpaths from where statistics will be collected.
| bool GKScenarioInputData::getSubPathsStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the stream statistics calculation is activated or not.
| bool GKScenarioInputData::getSystemStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the system statistics calculation is activated or not.
| GKTrafficArrivals * GKScenarioInputData::getTrafficArrivals | ( | ) | const |
| bool GKScenarioInputData::getTrafficManagementStatistics | ( | ) | const |
returns if traffic management statistics are gathered
| bool GKScenarioInputData::getTrajectoriesStatistics | ( | ) | const |
| const QVector< GKTrajectoryCondition > & GKScenarioInputData::getTrajectoryListStatistics | ( | ) | const |
Returns the list of trajectory from where statistics will be collected.
| bool GKScenarioInputData::getTransytStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the TRANSYT Predictions calculation is activated or not.
| bool GKScenarioInputData::getTurnsStatistics | ( | ) | const |
Once the Statistics have been activated, this function returns whether the nodes and turns statistics calculation is activated or not.
| bool GKScenarioInputData::getVehTypeStatistics | ( | ) | const |
| 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.
| 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
| bool GKScenarioInputData::isCycleDetectionAsSimulationStep | ( | ) | const |
Use the simulation step as the detection cycle? The default is yes.
| bool GKScenarioInputData::isNodeInTurnStatistics | ( | GKNode * | aNode | ) | const |
Returns true if the section is in the list of nodes from where statistics will be collected.
| 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.
| bool GKScenarioInputData::isSectionInStatistics | ( | GKSection * | ) | const |
Retuns true if the section is in the list of sections from where statistics will be collected.
| bool GKScenarioInputData::isSubPathInStatistics | ( | GKSubPath * | subpath | ) | const |
Returns true if the subpath is in the list of subpaths from where statistics will be collected.
| void GKScenarioInputData::removeExtension | ( | const QString & | extPath | ) |
| void GKScenarioInputData::removeExtensions | ( | ) |
Removes all the Aimsun APIs in this scenario from the list.
| void GKScenarioInputData::removeNodeTurnListStatistics | ( | GKNode * | aNode | ) |
Removes a node from the list of nodes from where turn statistics will be collected.
| void GKScenarioInputData::removePairForPathStat | ( | uint | , |
| uint | |||
| ) |
| void GKScenarioInputData::removePairListStatistics | ( | const GKPairStat & | aPair | ) |
Removes a centroid pair from the list of centroid pairs from where statistics will be collected.
| void GKScenarioInputData::removeSectListStatistics | ( | GKSection * | ) |
Removes a section from the list of sections from where statistics will be collected.
| void GKScenarioInputData::removeSubPath | ( | GKSubPath * | subpath | ) |
Removes the specified subpath from the input data.
| void GKScenarioInputData::removeTrajectoryListStatistics | ( | const GKTrajectoryCondition & | value | ) |
Removes a trajectorypair from the list of trajectories from where statistics will be collected.
| void GKScenarioInputData::setAnimationFile | ( | const QString & | afileName | ) |
| void GKScenarioInputData::setAnimationPolygon | ( | GKPolygon * | pol | ) |
| void GKScenarioInputData::setAnimationRotation | ( | double | value | ) |
| void GKScenarioInputData::setAnimationXRotationCenter | ( | double | value | ) |
| void GKScenarioInputData::setAnimationXTranslation | ( | double | value | ) |
| void GKScenarioInputData::setAnimationYRotationCenter | ( | double | value | ) |
| void GKScenarioInputData::setAnimationYTranslation | ( | double | value | ) |
| void GKScenarioInputData::setControlMeteringStatistics | ( | bool | save | ) |
Sets whether control statistics for meterings are being saved or not.
| void GKScenarioInputData::setControlPhaseEventStatistics | ( | bool | save | ) |
Sets whether control statistics for phase events are being saved or not. Useful mainly for actuated control plans.
| void GKScenarioInputData::setControlPhaseStatistics | ( | bool | save | ) |
Sets whether control statistics for phases are being saved or not
| void GKScenarioInputData::setControlPlanStatistics | ( | bool | value | ) |
sets whether control plan statistics are gathered or not
| void GKScenarioInputData::setControlSignalStatistics | ( | bool | save | ) |
Sets whether control statistics for signal groups are being saved or not
| void GKScenarioInputData::setControlTurnStatistics | ( | bool | save | ) |
Sets whether control statistics for turns are being saved or not
| void GKScenarioInputData::setCycleDetection | ( | float | value | ) |
The detection cycle in seconds
| void GKScenarioInputData::setCycleDetectionAsSimulationStep | ( | bool | value | ) |
Use the simulation step as the detection cycle? The default is yes.
| void GKScenarioInputData::setDebugControllers | ( | bool | save | ) |
Sets whether to create debug files for controllers or not.
| void GKScenarioInputData::setDestinationStatistics | ( | ODStatType | ) |
| void GKScenarioInputData::setDetailedTrajectoriesStatistics | ( | bool | save | ) |
| void GKScenarioInputData::setDetectionInterval | ( | const GKTimeDuration & | atime | ) |
Sets the time interval to be used for gathering detection data.
| void GKScenarioInputData::setEnergyConsumption | ( | bool | value | ) |
Sets whether statistics about fuel consumption will be calculated or not
| void GKScenarioInputData::setGenerateSCATSSignalGroupFiles | ( | bool | save | ) |
Sets whether to create log files for SCATS controllers or not.
| void GKScenarioInputData::setGlobalTrajectoriesStatistics | ( | bool | save | ) |
| void GKScenarioInputData::setGroupStatistics | ( | bool | value | ) |
Sets whether grouping statistics are gathered or not
| void GKScenarioInputData::setHcmStatistics | ( | bool | value | ) |
| void GKScenarioInputData::setIndividualPTStats | ( | bool | value | ) |
| void GKScenarioInputData::setInputPathAssignmentPlan | ( | GKPathAssignmentPlan * | ) |
Sets the path assignment plan object used as input
| void GKScenarioInputData::setInstantEmission | ( | bool | value | ) |
Sets whether Instant Emission pollutants will be calculated or not
| void GKScenarioInputData::setKeepHistoryDet | ( | bool | value | ) |
Sets whether the detection data will be kept in memory or not
| void GKScenarioInputData::setKeepHistoryStat | ( | bool | value | ) |
Sets whether the statistics will be kept in memory or not
| void GKScenarioInputData::setKeepLinkCostsInMemory | ( | bool | keep | ) |
sets the keep in memory flag of the link costs
| void GKScenarioInputData::setKeepPathsInMemory | ( | bool | keep | ) |
Sets whether path assignment is going to be kept in memory or not
| 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
| void GKScenarioInputData::setMatrixStatistics | ( | bool | value | ) |
Once the Statistics have been activated, this function returns whether the OD matrices statistics calculation is activated or not.
| void GKScenarioInputData::setOriginStatistics | ( | ODStatType | ) |
| void GKScenarioInputData::setPairsStatistics | ( | ODStatType | ) |
| 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).
| void GKScenarioInputData::setParametersForExtensionAt | ( | int | index, |
| const QString & | params | ||
| ) |
It modifies the parameters in the Enhanced Aimsun Next Extensions at 'index'. PRE: 0 <= index < numberOfAimsunExtensions
| void GKScenarioInputData::setPedestrianCrossingStatistics | ( | bool | value | ) |
Sets whether pedestrian crossing statistics are gathered or not
| void GKScenarioInputData::setPollutionEmission | ( | bool | value | ) |
Sets whether statistics for pollutants will be calculated or not
| 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.
| void GKScenarioInputData::setPTStatistics | ( | bool | value | ) |
Once the Statistics have been activated, this function sets whether the transit statistics calculation will be activated or not.
| void GKScenarioInputData::setPTStopStatistics | ( | bool | value | ) |
Sets whether pedestrian service point statistics are gathered or not
| void GKScenarioInputData::setSaveAnimation | ( | bool | value | ) |
| void GKScenarioInputData::setSaveLinkCosts | ( | bool | ) |
| void GKScenarioInputData::setSectionLanesStatistics | ( | bool | value | ) |
Once the Statistics have been activated, this function returns whether the section lanes statistics calculation is activated or not.
| void GKScenarioInputData::setSectionsStatistics | ( | bool | value | ) |
Once the Statistics have been activated, this function returns whether the section statistics calculation is activated or not.
| void GKScenarioInputData::setSectionTrajectoriesStatistics | ( | bool | save | ) |
| void GKScenarioInputData::setServicePointStatistics | ( | bool | value | ) |
Sets whether pedestrian service point statistics are gathered or not
| void GKScenarioInputData::setStatisticalInterval | ( | const GKTimeDuration & | atime | ) |
Sets the time interval to be used for gathering statistics.
| void GKScenarioInputData::setStoreAllPairsPathStat | ( | bool | ) |
| void GKScenarioInputData::setSubPathsStatistics | ( | bool | value | ) |
Once the Statistics have been activated, this function sets whether the stream statistics calculation is activated or not.
| void GKScenarioInputData::setTrafficManagementStatistics | ( | bool | value | ) |
sets whether traffic management statistics are gathered or not
| void GKScenarioInputData::setTrajectoriesStatistics | ( | bool | value | ) |
| void GKScenarioInputData::setTransytStatistics | ( | bool | ) |
| 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.
| bool GKScenarioInputData::storeDetectionEnabled | ( | ) | const |
Returns whether the detection data is defined to be stored in the database or not
| bool GKScenarioInputData::storeEnabled | ( | ) | const |
Returns true if simulation data will be store in the database (getActivateStatistics, getActivateDetection, getActivatePathStat, storeStatisticsEnabled, storeDetectionEnabled, storePathStatEnabled)
| bool GKScenarioInputData::storeStatisticsEnabled | ( | ) | const |
Returns whether the statistics are defined to be stored in the database or not
1.9.4