MacroScenarioOutputData Class Reference

Public Member Functions
	MacroScenarioOutputData ()
	~MacroScenarioOutputData ()
bool	storeStatisticsEnabled () const
void	enableStoreStatistics (bool value)
bool	storeSectionsInDatabaseEnabled () const
void	setStoreSectionsInDatabaseEnabled (bool aValue)
bool	storeTurnsInDatabaseEnabled () const
void	setStoreTurnsInDatabaseEnabled (bool aValue)
bool	storeSubpathsInDatabaseEnabled () const
void	setStoreSubpathsInDatabaseEnabled (bool aValue)
void	setGroupStatistics (bool value)
void	setGenerateSkims (bool iValue)
bool	getGroupStatistics () const
bool	getConvergenceStatistics () const
void	setConvergenceStatistics (bool value)
bool	getActivatePathStatistics () const
void	setActivatePathStatistics (bool value)
bool	getGenerateSkims () const
bool	getCollectSubPathsStats () const
void	setCollectSubPathsStats (bool iValue)

Detailed Description

This class holds all the static 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):

• Static 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):

• Static 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):

• Static 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)

Constructor & Destructor Documentation

MacroScenarioOutputData()

MacroScenarioOutputData::MacroScenarioOutputData

(

)

MacroScenarioOutputData constructor

~MacroScenarioOutputData()

MacroScenarioOutputData::~MacroScenarioOutputData

(

)

MacroScenarioOutputData destructor

Member Function Documentation

enableStoreStatistics()

void MacroScenarioOutputData::enableStoreStatistics

(

bool

value

)

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.

getActivatePathStatistics()

bool MacroScenarioOutputData::getActivatePathStatistics

(

)

const

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

getCollectSubPathsStats()

bool MacroScenarioOutputData::getCollectSubPathsStats

(

)

const

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

getConvergenceStatistics()

bool MacroScenarioOutputData::getConvergenceStatistics

(

)

const

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

getGenerateSkims()

bool MacroScenarioOutputData::getGenerateSkims

(

)

const

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

getGroupStatistics()

bool MacroScenarioOutputData::getGroupStatistics

(

)

const

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

setActivatePathStatistics()

void MacroScenarioOutputData::setActivatePathStatistics

(

bool

value

)

Sets whether the path statistics will be activated to be gathered

setCollectSubPathsStats()

void MacroScenarioOutputData::setCollectSubPathsStats

(

bool

iValue

)

Sets whether the subpath statistics will be activated to be gathered

setConvergenceStatistics()

void MacroScenarioOutputData::setConvergenceStatistics

(

bool

value

)

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

setGenerateSkims()

void MacroScenarioOutputData::setGenerateSkims

(

bool

iValue

)

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

setGroupStatistics()

void MacroScenarioOutputData::setGroupStatistics

(

bool

value

)

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

setStoreSectionsInDatabaseEnabled()

void MacroScenarioOutputData::setStoreSectionsInDatabaseEnabled

(

bool

aValue

)

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

setStoreSubpathsInDatabaseEnabled()

void MacroScenarioOutputData::setStoreSubpathsInDatabaseEnabled

(

bool

aValue

)

Sets whether subpaths will be stored in a database or not

setStoreTurnsInDatabaseEnabled()

void MacroScenarioOutputData::setStoreTurnsInDatabaseEnabled

(

bool

aValue

)

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

storeSectionsInDatabaseEnabled()

bool MacroScenarioOutputData::storeSectionsInDatabaseEnabled

(

)

const

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

storeStatisticsEnabled()

bool MacroScenarioOutputData::storeStatisticsEnabled

(

)

const

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()

bool MacroScenarioOutputData::storeSubpathsInDatabaseEnabled

(

)

const

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

storeTurnsInDatabaseEnabled()

bool MacroScenarioOutputData::storeTurnsInDatabaseEnabled

(

)

const

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