PyMacroModelPlugin.MacroScenarioOutputData

class MacroScenarioOutputData

Macro Assignment Scenario output data

Details

This class holds all the macro assignment scenario output data ( statistics )

The database will contain two complimentary tables: - MASECT : for the sections’ statistics - MATURN : for the turnings’ statistics

The MASECT will read or write the following information (in brackets, the name of the field in the table): - Macro Assignment Experiment ID (dId) - Section ID (oId) - Section External ID (eId) - Vehicle type (sid) - Interval (ent) - Section Volume (volume) - Section Travel Time (travelTime) - Section Occupancy (occupancy)

The MATURN will read or write the following information (in brackets, the name of the field in the table): - Macro Assignment Experiment ID (dId) - Turn ID (oId) - Turn External ID (eId) - Vehicle type (sId) - Interval (ent) - Turn Volume (volume) - Turn Travel Time (traveltime)

Furthermore, there can be a third table called PLCONV with the following information (related to the algorithm convergence): - Macro Assignment Experiment ID (dId) - Vehicle ID (oId) - Vehicle External ID (eId) - Interval (ent) : iteration number - Relative Gap (relGap) - Lambda (lambda) - Best Lower Bound (blb) - Objective Function (objFunc) - Time (time) - Total Time (ttime)

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()
enableStoreStatistics(value)
Parameters:

value – bool

Prefer setStoreSectionsInDatabaseEnabled and setStoreTurnsInDatabaseEnabled . Sets whether the data related to all of the following is set to be stored in a database or not: sections, centroid connections, detectors, turns, supernode trajectories and subpaths.

generateTimeSeries()
Return type:

bool

getActivatePathStatistics()
Return type:

bool

Returns true if the path statistics are activated to be gathered and false otherwise

getAggregateByVehicleClass()
Return type:

bool

Returns true if the skim matrices to generate must be the aggregate result of each Vehicle Class

getCollectSubPathsStats()
Return type:

bool

Returns true if the subpath statistics are activated to be gathered and false otherwise

getConvergenceStatistics()
Return type:

bool

Returns true if the algorithm convergence data is activated to be gathered and false otherwise

getGenerateGapMatrices()
Return type:

bool

Returns true if the RGap matrices will be generated at the end of the execution and false otherwise

getGenerateSkims()
Return type:

bool

Returns true if the skim matrices will be generated at the end of the execution and false otherwise

getGroupStatistics()
Return type:

bool

Returns true if the data related to groups will be calculated and false otherwise

setActivatePathStatistics(value)
Parameters:

value – bool

Sets whether the path statistics will be activated to be gathered

setAggregateByVehicleClass(value)
Parameters:

value – bool

Sets whether skim matrices to generate must be aggregated by Vehicle Class

setCollectSubPathsStats(iValue)
Parameters:

iValue – bool

Sets whether the subpath statistics will be activated to be gathered

setConvergenceStatistics(value)
Parameters:

value – bool

Sets whether the algorithm convergence data will be activated to be gathered

setGenerateGapMatrices(iValue)
Parameters:

iValue – bool

Sets whether Gap matrices will be generated at the end of the assignment process

setGenerateSkims(iValue)
Parameters:

iValue – bool

Sets whether skim matrices will be generated at the end of the assignment process

setGenerateTimeSeries(value)
Parameters:

value – bool

setGroupStatistics(value)
Parameters:

value – bool

Sets whether the data related to groups will be calculated or not

setStoreSectionsInDatabaseEnabled(aValue)
Parameters:

aValue – bool

Sets whether the data related to sections, centroid connections and detectors will be stored in a database or not

setStoreSubpathsInDatabaseEnabled(aValue)
Parameters:

aValue – bool

Sets whether subpaths will be stored in a database or not

setStoreTurnsInDatabaseEnabled(aValue)
Parameters:

aValue – bool

Sets whether the data related to turnings and supernode trajectories will be stored in a database or not

storeSectionsInDatabaseEnabled()
Return type:

bool

Returns true if the data related to sections, centroid connections and detectors is set to be stored and false otherwise

storeStatisticsEnabled()
Return type:

bool

Prefer storeSectionsInDatabaseEnabled , storeTurnsInDatabaseEnabled and storeSubpathsInDatabaseEnabled . Returns true if any of the data related to subpaths, [sections, centroid connections and detectors] or [turns and supernode trajectories] is set to be stored and false otherwise

storeSubpathsInDatabaseEnabled()
Return type:

bool

Returns true if subpaths are set to be stored and false otherwise

storeTurnsInDatabaseEnabled()
Return type:

bool

Returns true if the data related to turnings and supernode trajectories is set to be stored and false otherwise