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

Public Types

enum  GKTraversalPercentagesTypes { eAssignment , eOriginal , eNone }
 

Public Member Functions

 GKTraversal (const GKGenericScenario *scenario)
 
void setTrafficDemand (const GKTrafficDemand *trafficDemand)
 
const GKTrafficDemandgetTrafficDemand () const
 
void setSubNetwork (GKProblemNet *pNet)
 
GKProblemNetgetSubNetwork () const
 
void setTypeOfPercentageInInternalCentroids (GKTraversalPercentagesTypes value=GKTraversal::eAssignment)
 
GKTraversalPercentagesTypes getTypeOfPercentageInInternalCentroids () const
 
void calculateGates (qint32 scenarioId)
 
const QMap< int, GKSection * > & getEntranceGates () const
 
const QMap< int, GKSection * > & getExitGates () const
 
void calculatePublicTransport (qint32 scenarioId)
 

Detailed Description

Class for calculating a traversal matrix for a sub-area. It contains all the input data needed for the traversal and the output data obtained once the traversal has been calculated.

Member Enumeration Documentation

◆ GKTraversalPercentagesTypes

The different ways of assigning the percentages to the connections for the centroids that are created but that have an equivalent centroid on the network. That is, the original centroids that are located inside the sub-area. The options are:

  • eAssignment: to assign the percentages that the static traffic assignment has calculated to each connection
  • eOriginal: to assign the same percentages they had in the original centroid configuration
  • eNone: to do not assign any percentage
Enumerator
eAssignment 
eOriginal 
eNone 

Constructor & Destructor Documentation

◆ GKTraversal()

GKTraversal::GKTraversal ( const GKGenericScenario scenario)

Member Function Documentation

◆ calculateGates()

void GKTraversal::calculateGates ( qint32  scenarioId)

Function that needs to be called after the sub-area and the original centroid configuration have been defined to calculate the entrance and exit gates for the traversal

◆ calculatePublicTransport()

void GKTraversal::calculatePublicTransport ( qint32  scenarioId)

Function that needs to be called after the subnetwork and the public plan have been defined to calculate the new public plan for the target subnetwork

◆ getEntranceGates()

const QMap< int, GKSection * > & GKTraversal::getEntranceGates ( ) const

Returns a map with all the sections that are considered entrance gates for the traversal calculation because they are in the borders of the sub-area. The key of the map is the section id and the data the section itself

◆ getExitGates()

const QMap< int, GKSection * > & GKTraversal::getExitGates ( ) const

Returns a map with all the sections that are considered exit gates for the traversal calculation because they are in the borders of the sub-area. The key of the map is the section id and the data the section itself

◆ getSubNetwork()

GKProblemNet * GKTraversal::getSubNetwork ( ) const

It returns the subarea the traversal matrix has been calculated for.

◆ getTrafficDemand()

const GKTrafficDemand * GKTraversal::getTrafficDemand ( ) const

It returns the traffic demand that has been used to calculate the traversal.

◆ getTypeOfPercentageInInternalCentroids()

GKTraversalPercentagesTypes GKTraversal::getTypeOfPercentageInInternalCentroids ( ) const

It returns whether to keep the original percentages defined for microsimulation in the internal centroids (the ones inside the subnetwork), to assign the new percentages calculated by the assignment algorithm or to do not assign any percentage to the internal centroids

◆ setSubNetwork()

void GKTraversal::setSubNetwork ( GKProblemNet pNet)

Sets the subnetwork, the traversal will be calculated to

◆ setTrafficDemand()

void GKTraversal::setTrafficDemand ( const GKTrafficDemand trafficDemand)

Sets the valid centroid configurations in the traffic demand

◆ setTypeOfPercentageInInternalCentroids()

void GKTraversal::setTypeOfPercentageInInternalCentroids ( GKTraversalPercentagesTypes  value = GKTraversal::eAssignment)

Sets whether to keep original percentages in the internal centroids (eOriginal), to set to these internal centroids the percentages given from the assignment (eAssignment) or to not assign any percentage (eNone)

© Aimsun SLU
Aimsun ®