ForestCalculator Class Reference

Inheritance diagram for ForestCalculator:

Public Types
enum	CalculationMethod { eOnlyAvailablePaths =0 , eAvailablePathsAndShortestPaths , eShortestPaths }

Public Member Functions
	ForestCalculator (const BaseForest *iForest, GKModel *iAimsunModel, CalculationMethod iMethod=eOnlyAvailablePaths)
virtual	~ForestCalculator ()
void	setNumPaths (int value)
void	calculate (const AnalysisFilter &iFilter)
virtual void	init ()=0
virtual void	doPath (const PathKey &pathKey, const NSPTreeData &treeData, const QVector< QPair< qint32, qint8 > > &connections, void *aux=nullptr)
virtual void	finishPaths ()

Detailed Description

This class provides the a calculator to iterate over all paths of a forest

Member Enumeration Documentation

CalculationMethod

enum ForestCalculator::CalculationMethod

Enumerator
eOnlyAvailablePaths
eAvailablePathsAndShortestPaths
eShortestPaths

Constructor & Destructor Documentation

ForestCalculator()

ForestCalculator::ForestCalculator	(	const BaseForest *	iForest,
		GKModel *	iAimsunModel,
		CalculationMethod	iMethod = eOnlyAvailablePaths
	)

~ForestCalculator()

virtual ForestCalculator::~ForestCalculator ( )

virtual

Member Function Documentation

calculate()

void ForestCalculator::calculate

(

const AnalysisFilter &

iFilter

)

doPath()

virtual void ForestCalculator::doPath ( const PathKey &  pathKey, const NSPTreeData &  treeData, const QVector< QPair< qint32, qint8 > > &  connections, void *  aux = nullptr  )

virtual

Reimplemented in LinkAnalysisCalculator, and SkimCalculator.

finishPaths()

virtual void ForestCalculator::finishPaths ( )

virtual

Reimplemented in LinkAnalysisCalculator, and SkimCalculator.

init()

virtual void ForestCalculator::init ( )

pure virtual

Implemented in LinkAnalysisCalculator, and SkimCalculator.

setNumPaths()

void ForestCalculator::setNumPaths

(

int

value

)

Set the number of paths to get. If -1 then it gets all paths but they may be disaggregated. It means that the path could be repeated due to internal path calculation. If >0 then it joins those paths that are equal and it takes only the best n paths.