Classes
struct	DTAIterationTask

Public Types
enum	ForestType { eNone , eDTAOneShot , eDTAIterative , eMacroOD , eMacroD , eInitialState }

enum	WriteStatus { eOk , eCannotOpenFile , eWriteError }

enum	AggStat { eSum , eMean , eMin , eMax }

enum	NSPathType { ePathTree , ePointToPoint , eHistoricalRoute }

Public Member Functions
const DTAPTStop *	getOrigin () const

const DTAPTStop *	getDestination () const

const GKFunctionCost *	getFareFunction () const

double	getDistance () const

	DTASimulator ()

virtual void	configureDTAObjects ()=0

virtual void	configureIteration (int iterationNumber)=0

virtual void	postIter (bool iscancel)=0

virtual void	simulateStepOneShot ()=0

virtual double	getTime () const =0

virtual bool	isStationary () const =0

virtual double	getTimeSta () const =0

virtual bool	canFinishNetworkLoadingDTA () const =0

virtual void	dynamicalRouteChange ()=0

virtual void	deactivateOutputs ()=0

virtual void	activateOutputs ()=0

virtual bool	slowOutputsActive () const =0

const GKSimulatedObject *	object () const

const GKPoint &	position () const

uint	internId () const

qint8	index () const

double	length () const

float	cost (const DTAManager , const DTAVehicleType , int) const

float	travelTime (const DTAManager , const DTAVehicleType , int) const

bool	isVehicleAllowed (const DTAVehicleType *, int) const

	BaseForest (GKModel *model, ForestType iType)

virtual	~BaseForest ()

AssignmentMatrix *	getAssignmentMatrix (GKModel *aimsunModel, QVector< qint32 > &observations, QVector< QPair< qint32, qint32 > > &states)

BaseForest *	createSubForest (GKModel *iModel, int nrPaths) const

BaseForest::WriteStatus	writePathsToFile (const QString &fileName) const

void	createSubPaths (GKModel *iModel, qint32 iSectionID, int iIntervalIndex, qint32 userClassID, qint32 iOriginID, qint32 iDestinationID) const

QList< qint32 >	getPathSections (qint32 iEntranceSection, const NSPPath *iTree, qint32 iVehicleIndex) const

AnalysisFilter	convertFilter (const AnalysisFilter &iFilterAimsunIDs) const

const ForestGeometry &	getGeometry () const /NoCopy/

const ForestDemands &	getDemand () const

const QVector< uint > &	getUserClasses () const

void	resetVehicleGroups ()

int	addVehicleGroup (const QVector< int > &vehgroup)

const QVector< QVector< int > > &	getUserClassesGroups () const

BaseForest *	mergePaths (QVector< BaseForest * > &paths)

virtual bool	setNewAssignmentFactor (uint intervalIndex, uint vehicleIndex, uint originIndex, uint originCon, uint destinationIndex, uint destinationCon, const QVector< uint > &sections, double prob)

	ForestPaths (const BaseForest *iForest)

virtual	~ForestPaths ()

bool	addSPTreeCompressed (NSPPath *path, int _treeId=-1, uint iCluster=0, uint iIteration=0, uint iSlice=0)

virtual int	getNBAssignmentIntervals () const =0

virtual QVector< NSPTreeData >	getPaths (uint intervalIndex, uint vehicleIndex, uint originIndex, uint originCon, uint destinationIndex, uint destinationCon, const std::vector< NSPTreeData::PathType > &filterPaths, int nrPaths=-1) const =0

std::vector< NSPPath * >	getTreesForReferenceCentroid (qint32 centroidIndex) const

void	prepareTreesForReferenceCentroid (qint32 centroidId) const

void	prepareTree (NSPPath *path) const

void	clearTreesForReferenceCentroid (qint32 destinationId) const

void	clearTree (NSPPath *path) const

virtual short	getLocalIteration (uint intervalIndex, uint vehicleIndex, uint originIndex, uint originCon, uint destinationIndex, uint destinationCon) const =0

virtual int	getNumberOfIterations (int interval) const

void	joinIdenticalPaths (QVector< NSPTreeData > &paths, qint32 iUserIndex) const

void	sortPaths (QVector< NSPTreeData > &paths) const

void	setLoadTreesInMemory (bool iValue)

	if (base)

Py_END_ALLOW_THREADS End	GKRealDataSetRestorer ()

	~GKRealDataSetRestorer ()

void	setRealDataSet (GKRealDataSet *arealDataSet)

virtual QString	getName () const =0

virtual QString	getExternalName () const =0

virtual QString	getDescription () const =0

virtual uint	order () const

virtual QString	secondaryOrder () const

const GKType *	getObjectType () const

void	setObjectType (const GKType *type)

void	setModel (GKModel *model)

virtual void	preStore ()

virtual bool	restoreData (GKRealDataSet , GKModel )

virtual void	postRestore (const GKModel *aModel)

QString	store () const

virtual End void	restore (GKRealDataSet *, const QString &)=0

virtual GKTimeDuration	getForcedInterval () const

virtual QString	getOriginatorName () const =0

	GKTimeSerie (GKTSDescription *aDescription)

unsigned int	size () const

void	clear ()

const GKTSDescription *	getDescription () const

virtual void	setValue (unsigned int interval, double value, double deviation=-1.0, double lowerValue=-1.0)=0

virtual double	getValue (unsigned int interval, bool *valid=nullptr) const =0

double	getValue (const GKContext &context, bool *valid=nullptr) const

virtual double	getDeviation (unsigned int interval, bool *valid=nullptr) const =0

virtual QPair< double, double >	getBand (unsigned int interval, bool *valid=nullptr) const =0

double	getMean () const

double	getMean (unsigned int start, unsigned int end) const

double	getSum () const

double	getSum (unsigned int start, unsigned int end) const

double	getMax () const

double	getMax (unsigned int start, unsigned int end) const

double	getMin () const

double	getMin (unsigned int start, unsigned int end) const

virtual void	setCustomAggregatedValue (double value, double deviation=-1.0)=0

virtual double	getCustomAggregatedValue () const =0

virtual double	getCustomAggregatedDeviation () const =0

virtual bool	hasAnyData () const =0

double	getAggregatedValue () const

double	getAggregatedValue (GK::AggregationType aggregationType) const

double	getAggregatedDeviation () const

double	getAggregatedDeviation (GK::AggregationType aggregationType) const

double	getStdDev () const

double	getSEMean (const GKTimeSerie *other) const

double	getTheilU (const GKTimeSerie *other) const

void	getTheilUmUcUs (const GKTimeSerie other, double SEm, double Um, double Uc, double Us) const

double	getRMS (const GKTimeSerie *other) const

double	nullValue () const

bool	isNull (double value) const

	NSPPath ()

qint32	getId () const

virtual quint32	getReferenceCentroid () const =0

virtual bool	samePath (const BaseForest _forest, const NSPPath otherPath, quint32 entranceSection, quint32 vehType) const =0

virtual QVector< QPair< qint32, qint8 > >	getPathConnections (qint32 entranceSection, qint32 vehicleIndex, bool includeTrajectorySections) const =0

virtual NSPathType	getType () const =0

	GKPrintLayoutItem (double x, double y, double width, double height)

	if (base)

Py_END_ALLOW_THREADS virtual End	~GKPrintLayoutItem ()

void	setLayout (GKPrintLayout *_layout)

GKPrintLayout *	getLayout () const

QPointF	getPosInPage () const

QSizeF	getSizeInPage () const

QSizeF	getSizeInPageInMM () const

GKBBox	getBBoxInPage () const

bool	setX (double x)

bool	setY (double y)

bool	setWidth (double)

bool	setHeight (double)

double	getX () const

double	getY () const

double	getWidth () const

double	getHeight () const

GKBBox	getBBox () const

bool	drawFrame () const

void	setDrawFrame (bool value)

bool	useBckColor () const

void	setUseBckColor (bool value)

QColor	getBckColor () const

void	setBckColor (QColor color)

virtual QString	getType ()=0

void	setSelected (bool s)

bool	isSelected () const

void	setLocked (bool locked)

bool	isLocked () const

void	setDisableSimpleDrawing (bool disableSimpleDraw)

bool	isSimpleDrawDisabled () const

virtual GKPrintLayoutItem *	clone ()

quint32	getTick () const

Static Public Member Functions
static BaseForest *	readFile (const QString &fileName, GKModel model, GKTask task=NULL)

static void	destroy (BaseForest *iForest)

static void	limitPaths (const BaseForest *forest, QVector< NSPTreeData > &paths, int k)

static void	correctPaths (const BaseForest *forest, QVector< NSPTreeData > &paths, double targetTotal)

Public Attributes
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKRealDataSetRestorer *	base = (GKRealDataSetRestorer*)sipCpp

	sipType = 0

MethodCode	sipRes = new QString{ sipCpp->store() }

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKPrintLayoutItem *	base = (GKPrintLayoutItem*)sipCpp

Protected Member Functions
virtual void	createInterval (uint interval)=0

Detailed Description

NSPPath class.

A time series is a collection of values taken starting at some time and every certain time interval.

A restorer of external detection data.

BaseForest class.

Aimsun path class. This is the base class for all paths .

Aimsun Dynamic Traffic Assignment simulator front-end.

This is the base class for all dynamic traffic assignment simulators. For example:

GAimsunSimulator
AMesoDTASimulator The simulatior can hold either a Stochastic Route Choice simulation or an Dyncamic User Equilibrium simulation.

This class contains the shortest paths from an assignment.

See also: GKRealDataSet

The description contains information about the time range, the interval between each value, units... This description is shared among all the TS that use it.

It can have, optionally, either a deviation for each value or a band (a Max and a min value).

A time series can be multi dimensional (for example, speed by different lanes or vehicle types). Use the GKTimeSerie::dimensions to know the number of dimensions available.

Use a suitable dimension (from 0 to GKTimeSerie::dimensions - 1) to set or get the data.

A time series has at least one dimension.

See also: GKTSDescription

This class provides the path definition

Abstract Class implemented by the differents items to be drawn. The positons and the size of the elements are relative to the PageSize from its owner: GKPrintLayout

See also: GKPrintLayout

Member Enumeration Documentation

◆ AggStat

enum Abstract::AggStat

Enumerator
eSum
eMean
eMin
eMax

◆ ForestType

enum Abstract::ForestType

Enumerator
eNone
eDTAOneShot
eDTAIterative
eMacroOD
eMacroD
eInitialState

◆ NSPathType

enum Abstract::NSPathType

Path type.

Enumerator
ePathTree
ePointToPoint
eHistoricalRoute

◆ WriteStatus

enum Abstract::WriteStatus

Enumerator
eOk
eCannotOpenFile
eWriteError

Constructor & Destructor Documentation

◆ ~BaseForest()

virtual Abstract::~BaseForest ( )

virtual

◆ ~ForestPaths()

virtual Abstract::~ForestPaths ( )

virtual

◆ ~GKRealDataSetRestorer()

Abstract::~GKRealDataSetRestorer ( )

◆ ~GKPrintLayoutItem()

Py_END_ALLOW_THREADS virtual End Abstract::~GKPrintLayoutItem ( )

virtual

Member Function Documentation

◆ activateOutputs()

virtual void Abstract::activateOutputs ( )

pure virtual

Active statistics.

◆ addSPTreeCompressed()

bool Abstract::addSPTreeCompressed	(	NSPPath *	path,
		int	_treeId = `-1`,
		uint	iCluster = `0`,
		uint	iIteration = `0`,
		uint	iSlice = `0`
	)

◆ addVehicleGroup()

int Abstract::addVehicleGroup ( const QVector< int > & vehgroup )

Adds a new group of user classes.

◆ BaseForest()

Abstract::BaseForest	(	GKModel *	model,
		ForestType	iType
	)

◆ canFinishNetworkLoadingDTA()

virtual bool Abstract::canFinishNetworkLoadingDTA ( ) const

pure virtual

Returns true if simulation can finish the DNL simulation. This is when the simulation time is greater than the total simulation duration.

◆ clear()

void Abstract::clear ( )

Removes all the values in this attribute.

◆ clearTree()

void Abstract::clearTree ( NSPPath * path ) const

◆ clearTreesForReferenceCentroid()

void Abstract::clearTreesForReferenceCentroid ( qint32 destinationId ) const

◆ clone()

virtual GKPrintLayoutItem * Abstract::clone ( )

virtual

◆ configureDTAObjects()

virtual void Abstract::configureDTAObjects ( )

pure virtual

It binds objects from the dynamic network loading model(micro or meso) to DTA objects.

◆ configureIteration()

virtual void Abstract::configureIteration ( int iterationNumber )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to initilize its respective internal classes. It's called every time before starting the iteration simulation.

◆ convertFilter()

AnalysisFilter Abstract::convertFilter ( const AnalysisFilter & iFilterAimsunIDs ) const

Convert Aimsun IDs in filter to forest IDs in new filter

◆ correctPaths()

static void Abstract::correctPaths	(	const BaseForest *	forest,
		QVector< NSPTreeData > &	paths,
		double	targetTotal
	)

static

◆ cost()

float Abstract::cost	(	const DTAManager *	,
		const DTAVehicleType *	,
		int
	)		const

◆ createInterval()

virtual void Abstract::createInterval ( uint interval )

protectedpure virtual

◆ createSubForest()

BaseForest * Abstract::createSubForest	(	GKModel *	iModel,
		int	nrPaths
	)		const

Create subset of the current forest with only nrPaths paths per OD pair

◆ createSubPaths()

void Abstract::createSubPaths	(	GKModel *	iModel,
		qint32	iSectionID,
		int	iIntervalIndex,
		qint32	userClassID,
		qint32	iOriginID,
		qint32	iDestinationID
	)		const

Create subpaths from the forest from a specified section iSectionID, from the shortest path trees for specified interval, userclass, origin, destination

◆ deactivateOutputs()

virtual void Abstract::deactivateOutputs ( )

pure virtual

Deactivate statistics.

◆ destroy()

static void Abstract::destroy ( BaseForest * iForest )

static

Free memory and destroy forest

◆ drawFrame()

bool Abstract::drawFrame ( ) const

Returns true if set to draw a black frame at the border of the element. False otherwise

◆ DTASimulator()

Abstract::DTASimulator ( )

◆ dynamicalRouteChange()

virtual void Abstract::dynamicalRouteChange ( )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to run the dynamic route change. See Aimsun Next Hybrid Meso-Micro model explanation in the manual.

◆ ForestPaths()

Abstract::ForestPaths ( const BaseForest * iForest )

◆ getAggregatedDeviation() [1/2]

double Abstract::getAggregatedDeviation ( ) const

Returns the aggregated deviation corresponding to the description's aggregationType:

GK::eAggregationCustom: getCustomAggregatedDeviation()
other GK::AggregationType : getStdDev() Returns nullValue() if there is no description or if the aggregationType is GK::eAggregationUndefined.

◆ getAggregatedDeviation() [2/2]

double Abstract::getAggregatedDeviation ( GK::AggregationType aggregationType ) const

Returns the aggregation deviation corresponding to the specified aggregationType.

◆ getAggregatedValue() [1/2]

double Abstract::getAggregatedValue ( ) const

Returns the aggregation corresponding to the description's aggregationType Returns nullValue() if there is no description, or if the aggregationType is not supported. Supported aggregationType are : GK::eAggregationCustom, GK::eAggregationMean, GK::eAggregationSum.

◆ getAggregatedValue() [2/2]

double Abstract::getAggregatedValue ( GK::AggregationType aggregationType ) const

Returns the aggregation corresponding to the specified aggregationType.

◆ getAssignmentMatrix()

AssignmentMatrix * Abstract::getAssignmentMatrix	(	GKModel *	aimsunModel,
		QVector< qint32 > &	observations,
		QVector< QPair< qint32, qint32 > > &	states
	)

Create the assignment matrix

◆ getBand()

virtual QPair< double, double > Abstract::getBand	(	unsigned int	interval,
		bool *	valid = `nullptr`
	)		const

pure virtual

Returns the band for an interval and the optional valid value is set to true. If the interval is greater than the current number of intervals then nullValue is returned and valid will be set to false.

If the TS contains only deviations it returns a band calculated using the deviation [Value+DEV,Value-DEV]

◆ getBBox()

GKBBox Abstract::getBBox ( ) const

◆ getBBoxInPage()

GKBBox Abstract::getBBoxInPage ( ) const

◆ getBckColor()

QColor Abstract::getBckColor ( ) const

◆ getCustomAggregatedDeviation()

virtual double Abstract::getCustomAggregatedDeviation ( ) const

pure virtual

Returns the external aggregated deviation previously set if any or nullValue if not set.

◆ getCustomAggregatedValue()

virtual double Abstract::getCustomAggregatedValue ( ) const

pure virtual

Returns the external aggregated value previously set.

◆ getDemand()

const ForestDemands & Abstract::getDemand ( ) const

Get the demand of the forest

◆ getDescription() [1/2]

const GKTSDescription * Abstract::getDescription ( ) const

The description for this TS

◆ getDescription() [2/2]

virtual QString Abstract::getDescription ( ) const

pure virtual

Returns a description of what data can be restored (the file name, the database name...)

◆ getDestination()

const DTAPTStop * Abstract::getDestination ( ) const

◆ getDeviation()

virtual double Abstract::getDeviation	(	unsigned int	interval,
		bool *	valid = `nullptr`
	)		const

pure virtual

Returns the deviation for an interval and the optional valid value is set to true. If the interval is greater than the current number of intervals then nullValue is returned and valid will be set to false.

◆ getDistance()

double Abstract::getDistance ( ) const

◆ getExternalName()

virtual QString Abstract::getExternalName ( ) const

pure virtual

Returns a name for this restorer type to be presented to the user. It can be localized.

◆ getFareFunction()

const GKFunctionCost * Abstract::getFareFunction ( ) const

◆ getForcedInterval()

virtual GKTimeDuration Abstract::getForcedInterval ( ) const

virtual

Force an aggregation interval for the data. Set 00:00:00 to turn it off.

◆ getGeometry()

const ForestGeometry & Abstract::getGeometry ( ) const

Get the geometry of the forest

◆ getHeight()

double Abstract::getHeight ( ) const

◆ getId()

qint32 Abstract::getId ( ) const

Get the ID of the path.

◆ getLayout()

GKPrintLayout * Abstract::getLayout ( ) const

◆ getLocalIteration()

virtual short Abstract::getLocalIteration	(	uint	intervalIndex,
		uint	vehicleIndex,
		uint	originIndex,
		uint	originCon,
		uint	destinationIndex,
		uint	destinationCon
	)		const

pure virtual

◆ getMax() [1/2]

double Abstract::getMax ( ) const

◆ getMax() [2/2]

double Abstract::getMax	(	unsigned int	start,
		unsigned int	end
	)		const

◆ getMean() [1/2]

double Abstract::getMean ( ) const

◆ getMean() [2/2]

double Abstract::getMean	(	unsigned int	start,
		unsigned int	end
	)		const

◆ getMin() [1/2]

double Abstract::getMin ( ) const

◆ getMin() [2/2]

double Abstract::getMin	(	unsigned int	start,
		unsigned int	end
	)		const

◆ getName()

virtual QString Abstract::getName ( ) const

pure virtual

Returns a unique name for this restorer type. Usually will be the class name.

◆ getNBAssignmentIntervals()

virtual int Abstract::getNBAssignmentIntervals ( ) const

pure virtual

◆ getNumberOfIterations()

virtual int Abstract::getNumberOfIterations ( int interval ) const

virtual

◆ getObjectType()

const GKType * Abstract::getObjectType ( ) const

Type of the objects that will be modified by this restorer. Can be None (any type)

◆ getOrigin()

const DTAPTStop * Abstract::getOrigin ( ) const

◆ getOriginatorName()

virtual QString Abstract::getOriginatorName ( ) const

pure virtual

◆ getPathConnections()

virtual QVector< QPair< qint32, qint8 > > Abstract::getPathConnections	(	qint32	entranceSection,
		qint32	vehicleIndex,
		bool	includeTrajectorySections
	)		const

pure virtual

Get the path section positions and connections

◆ getPaths()

virtual QVector< NSPTreeData > Abstract::getPaths	(	uint	intervalIndex,
		uint	vehicleIndex,
		uint	originIndex,
		uint	originCon,
		uint	destinationIndex,
		uint	destinationCon,
		const std::vector< NSPTreeData::PathType > &	filterPaths,
		int	nrPaths = `-1`
	)		const

pure virtual

◆ getPathSections()

QList< qint32 > Abstract::getPathSections	(	qint32	iEntranceSection,
		const NSPPath *	iTree,
		qint32	iVehicleIndex
	)		const

Get the section IDs for a tree with a given entrance section

◆ getPosInPage()

QPointF Abstract::getPosInPage ( ) const

The relative (to the layout) position of this item.

◆ getReferenceCentroid()

virtual quint32 Abstract::getReferenceCentroid ( ) const

pure virtual

Get Destination Centroid Index

◆ getRMS()

double Abstract::getRMS ( const GKTimeSerie * other ) const

Returns the RMS (Root Mean Squared) error.

◆ getSEMean()

double Abstract::getSEMean ( const GKTimeSerie * other ) const

Square error mean.

◆ getSizeInPage()

QSizeF Abstract::getSizeInPage ( ) const

◆ getSizeInPageInMM()

QSizeF Abstract::getSizeInPageInMM ( ) const

◆ getStdDev()

double Abstract::getStdDev ( ) const

Standard deviation.

◆ getSum() [1/2]

double Abstract::getSum ( ) const

◆ getSum() [2/2]

double Abstract::getSum	(	unsigned int	start,
		unsigned int	end
	)		const

◆ getTheilU()

double Abstract::getTheilU ( const GKTimeSerie * other ) const

Theil's U_statistic: "this" is the observed series, "serie2" is the forecasted series.

◆ getTheilUmUcUs()

void Abstract::getTheilUmUcUs	(	const GKTimeSerie *	other,
		double	SEm,
		double *	Um,
		double *	Uc,
		double *	Us
	)		const

Theil's statistics: "this" is the observed series, "serie2" is the forecasted series. The SEm is the squared mean returned by function getSEMean.

◆ getTick()

quint32 Abstract::getTick ( ) const

◆ getTime()

virtual double Abstract::getTime ( ) const

pure virtual

Returns the current time.

◆ getTimeSta()

virtual double Abstract::getTimeSta ( ) const

pure virtual

Returns the current time using the initial time as the starting time. During the warm-up the return value is the initial time less the corresponding warm-up simulation time.

◆ getTreesForReferenceCentroid()

std::vector< NSPPath * > Abstract::getTreesForReferenceCentroid ( qint32 centroidIndex ) const

◆ getType() [1/2]

virtual NSPathType Abstract::getType ( ) const

pure virtual

Clone the NSPPath

Returns the type of this path.

◆ getType() [2/2]

virtual QString Abstract::getType ( )

pure virtual

◆ getUserClasses()

const QVector< uint > & Abstract::getUserClasses ( ) const

Get a list of the UserClass ID's

◆ getUserClassesGroups()

const QVector< QVector< int > > & Abstract::getUserClassesGroups ( ) const

Get the user classes groups.

◆ getValue() [1/2]

double Abstract::getValue	(	const GKContext &	context,
		bool *	valid = `nullptr`
	)		const

Returns the value for an interval and the optional valid value is set to true. If the interval is greater than the current number of intervals then nullValue is returned and valid will be set to false.

◆ getValue() [2/2]

virtual double Abstract::getValue	(	unsigned int	interval,
		bool *	valid = `nullptr`
	)		const

pure virtual

Returns the value for an interval and the optional valid value is set to true. If the interval is greater than the current number of intervals then nullValue is returned and valid will be set to false.

◆ getWidth()

double Abstract::getWidth ( ) const

◆ getX()

double Abstract::getX ( ) const

◆ getY()

double Abstract::getY ( ) const

◆ GKPrintLayoutItem()

Abstract::GKPrintLayoutItem	(	double	x,
		double	y,
		double	width,
		double	height
	)

◆ GKRealDataSetRestorer()

Py_END_ALLOW_THREADS End Abstract::GKRealDataSetRestorer ( )

◆ GKTimeSerie()

Abstract::GKTimeSerie ( GKTSDescription * aDescription )

explicit

◆ hasAnyData()

virtual bool Abstract::hasAnyData ( ) const

pure virtual

Returns true if this object has data: at least one element that is not null.

◆ if() [1/2]

Abstract::if ( base )

inline

References GKSystem::getSystem().

◆ if() [2/2]

Abstract::if ( base )

inline

References GKSystem::getSystem().

◆ index()

qint8 Abstract::index ( ) const

◆ internId()

uint Abstract::internId ( ) const

◆ isLocked()

bool Abstract::isLocked ( ) const

◆ isNull()

bool Abstract::isNull ( double value ) const

Checks if the parameter value is considered invalid by this Time Serie. Depends on description. Provided to be used commonly after a getValue or any other returning function.

◆ isSelected()

bool Abstract::isSelected ( ) const

◆ isSimpleDrawDisabled()

bool Abstract::isSimpleDrawDisabled ( ) const

◆ isStationary()

virtual bool Abstract::isStationary ( ) const

pure virtual

Returns true if current time is greater than the warm-up time.

◆ isVehicleAllowed()

bool Abstract::isVehicleAllowed	(	const DTAVehicleType *	,
		int
	)		const

◆ joinIdenticalPaths()

void Abstract::joinIdenticalPaths	(	QVector< NSPTreeData > &	paths,
		qint32	iUserIndex
	)		const

◆ length()

double Abstract::length ( ) const

◆ limitPaths()

static void Abstract::limitPaths	(	const BaseForest *	forest,
		QVector< NSPTreeData > &	paths,
		int	k
	)

static

◆ mergePaths()

BaseForest * Abstract::mergePaths ( QVector< BaseForest * > & paths )

◆ NSPPath()

Abstract::NSPPath ( )

Default constructor.

◆ nullValue()

double Abstract::nullValue ( ) const

Returns the value that is considered not valid for the given Time Serie. Depends on description.

◆ object()

const GKSimulatedObject * Abstract::object ( ) const

◆ order()

virtual uint Abstract::order ( ) const

virtual

When a GKRealDataSet contains more than one GKRealDataSetRestorer this method is used to sort the GKRealDataSetRestorer on it and do the restoration in order.

◆ position()

const GKPoint & Abstract::position ( ) const

◆ postIter()

virtual void Abstract::postIter ( bool iscancel )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to initilize its respective internal classes. It's called every time a iteration simulation is finished.

◆ postRestore()

virtual void Abstract::postRestore ( const GKModel * aModel )

virtual

Only for GKRealDataSetRestorerSimple. Post-process to work with vehicles ids instead names.

◆ prepareTree()

void Abstract::prepareTree ( NSPPath * path ) const

◆ prepareTreesForReferenceCentroid()

void Abstract::prepareTreesForReferenceCentroid ( qint32 centroidId ) const

◆ preStore()

virtual void Abstract::preStore ( )

virtual

Only for GKRealDataSetRestorerSimple. Pre-process to work with vehicles ids instead names.

◆ readFile()

static BaseForest * Abstract::readFile	(	const QString &	fileName,
		GKModel *	model,
		GKTask *	task = `NULL`
	)

static

Read a file and create forest

◆ resetVehicleGroups()

void Abstract::resetVehicleGroups ( )

Resets the user classes groups.

◆ restore()

virtual End void Abstract::restore	(	GKRealDataSet *	,
		const QString &
	)

pure virtual

Restores the object state from a XML string.

◆ restoreData()

virtual bool Abstract::restoreData	(	GKRealDataSet *	,
		GKModel *
	)

virtual

Restores the data. Returns true if the data was restored, false otherwise.

◆ samePath()

virtual bool Abstract::samePath	(	const BaseForest *	_forest,
		const NSPPath *	otherPath,
		quint32	entranceSection,
		quint32	vehType
	)		const

pure virtual

Returns true if the two paths are the same.

◆ secondaryOrder()

virtual QString Abstract::secondaryOrder ( ) const

virtual

When a GKRealDataSet contains more than one GKRealDataSetRestorer this method is used to sort the GKRealDataSetRestorer on it and do the restoration in order.

◆ setBckColor()

void Abstract::setBckColor ( QColor color )

◆ setCustomAggregatedValue()

virtual void Abstract::setCustomAggregatedValue	(	double	value,
		double	deviation = `-1.0`
	)

pure virtual

Sets the aggregated value in case the type of aggregation is set to eAggregated, what means that it cannot be calculated and it needs to be user-specified.

◆ setDisableSimpleDrawing()

void Abstract::setDisableSimpleDrawing ( bool disableSimpleDraw )

◆ setDrawFrame()

void Abstract::setDrawFrame ( bool value )

Use true to draw a black frame at the border of the element. False otherwise

◆ setHeight()

bool Abstract::setHeight ( double )

Sets Height. Returns false if the specified value as been bounded because out-of-page, else return true.

◆ setLayout()

void Abstract::setLayout ( GKPrintLayout * _layout )

◆ setLoadTreesInMemory()

void Abstract::setLoadTreesInMemory ( bool iValue )

◆ setLocked()

void Abstract::setLocked ( bool locked )

◆ setModel()

void Abstract::setModel ( GKModel * model )

Sets the model.

◆ setNewAssignmentFactor()

virtual bool Abstract::setNewAssignmentFactor	(	uint	intervalIndex,
		uint	vehicleIndex,
		uint	originIndex,
		uint	originCon,
		uint	destinationIndex,
		uint	destinationCon,
		const QVector< uint > &	sections,
		double	prob
	)

virtual

Change the assignment factor, path usage probability. It only works with od apas. BaseForest that are actually ForestODStorage.

◆ setObjectType()

void Abstract::setObjectType ( const GKType * type )

Type of the objects that will be modified by this restorer. Can be None (any type)

◆ setRealDataSet()

void Abstract::setRealDataSet ( GKRealDataSet * arealDataSet )

Set the real dataset

◆ setSelected()

void Abstract::setSelected ( bool s )

◆ setUseBckColor()

void Abstract::setUseBckColor ( bool value )

◆ setValue()

virtual void Abstract::setValue	(	unsigned int	interval,
		double	value,
		double	deviation = `-1.0`,
		double	lowerValue = `-1.0`
	)

pure virtual

Sets the value and deviation or band for an interval. If the interval to be set is greater than the current number of intervals, empty intervals are added (values for these intervals will be -1).

If lowerValue is >= 0 then deviation will be used as the higher value of the band (and lowerValue as the lower one).

◆ setWidth()

bool Abstract::setWidth ( double )

Sets Width. Returns false if the specified value as been bounded because out-of-page, else return true.

◆ setX()

bool Abstract::setX ( double x )

Sets X. Returns false if the specified value as been bounded because out-of-page, else return true.

◆ setY()

bool Abstract::setY ( double y )

Sets Y. Returns false if the specified value as been bounded because out-of-page, else return true.

◆ simulateStepOneShot()

virtual void Abstract::simulateStepOneShot ( )

pure virtual

Simulated a one shot simulation step.

◆ size()

unsigned int Abstract::size ( ) const

Return the number of values in this attribute.

◆ slowOutputsActive()

virtual bool Abstract::slowOutputsActive ( ) const

pure virtual

Returns the current status of statistics. True means that is not gathering statistics false is gathering.

◆ sortPaths()

void Abstract::sortPaths ( QVector< NSPTreeData > & paths ) const

◆ store()

QString Abstract::store ( ) const

Returns a XML string with this object data (but not the data restored). This data will be stored in the Aimsun database.

◆ travelTime()

float Abstract::travelTime	(	const DTAManager *	,
		const DTAVehicleType *	,
		int
	)		const

◆ useBckColor()

bool Abstract::useBckColor ( ) const

◆ writePathsToFile()

BaseForest::WriteStatus Abstract::writePathsToFile ( const QString & fileName ) const

Write the forest to file

Member Data Documentation

◆ base [1/2]

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKRealDataSetRestorer* Abstract::base = (GKRealDataSetRestorer*)sipCpp

◆ base [2/2]

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKPrintLayoutItem* Abstract::base = (GKPrintLayoutItem*)sipCpp

◆ sipRes

MethodCode Abstract::sipRes = new QString{ sipCpp->store() }

◆ sipType

Abstract::sipType = 0

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ AggStat

◆ ForestType

◆ NSPathType

◆ WriteStatus

Constructor & Destructor Documentation

◆ ~BaseForest()

◆ ~ForestPaths()

◆ ~GKRealDataSetRestorer()

◆ ~GKPrintLayoutItem()

Member Function Documentation

◆ activateOutputs()

◆ addSPTreeCompressed()

◆ addVehicleGroup()

◆ BaseForest()

◆ canFinishNetworkLoadingDTA()

◆ clear()

◆ clearTree()

◆ clearTreesForReferenceCentroid()

◆ clone()

◆ configureDTAObjects()

◆ configureIteration()

◆ convertFilter()

◆ correctPaths()

◆ cost()

◆ createInterval()

◆ createSubForest()

◆ createSubPaths()

◆ deactivateOutputs()

◆ destroy()

◆ drawFrame()

◆ DTASimulator()

◆ dynamicalRouteChange()

◆ ForestPaths()

◆ getAggregatedDeviation() [1/2]

◆ getAggregatedDeviation() [2/2]

◆ getAggregatedValue() [1/2]

◆ getAggregatedValue() [2/2]

◆ getAssignmentMatrix()

◆ getBand()

◆ getBBox()

◆ getBBoxInPage()

◆ getBckColor()

◆ getCustomAggregatedDeviation()

◆ getCustomAggregatedValue()

◆ getDemand()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getDestination()

◆ getDeviation()

◆ getDistance()

◆ getExternalName()

◆ getFareFunction()

◆ getForcedInterval()

◆ getGeometry()

◆ getHeight()

◆ getId()

◆ getLayout()

◆ getLocalIteration()

◆ getMax() [1/2]

◆ getMax() [2/2]

◆ getMean() [1/2]

◆ getMean() [2/2]

◆ getMin() [1/2]

◆ getMin() [2/2]

◆ getName()

◆ getNBAssignmentIntervals()

◆ getNumberOfIterations()

◆ getObjectType()

◆ getOrigin()

◆ getOriginatorName()

◆ getPathConnections()

◆ getPaths()