Inheritance diagram for GKExperiment:

Public Types
enum	GKInitialStateType { eWarmup , eSavedState }

enum	GKArrivalType { eExponential = 0 , eUniform = 1 , eNormal = 2 , eConstant = 3 , eExternal = 4 , eASAP = 5 , eNone = 6 }

enum	GKReactionTimeType { eAsSimStep = 0 , eVariableVehType = 1 }

enum	EngineMode { eIterative , eOneShot }

enum	PathCalculationAlgorithm { eDijkstra = 0 , eAStar = 1 }

enum	DisablePathCalculation { eNo , eForAllODPairs , eForTheBlockedODPairsInMatrix }

enum	HybridMicroFlags { eMicroNone = 0 , eMicroSectionsWithActuatedCPDestNode = 1 , eMicroSectionsWithBusPreemptionCPDestNode = 2 , eMicroSectionsWithControlledDestNode = 4 , eMicroSectionsWithLegionPedCrossings = 8 , eMicroSectionsWithPTLineStop = 16 , eMicroSectionsUsedByPTLine = 32 , eMicroSectionsWithEVDetector = 64 }

enum	DUEPathCost { Instantaneous , Experienced , TimeDependent }

enum	TravelTime { eInstantaneous , eTotalVdfTpfJdfCost , eFunctionComponent }

typedef int	SimulatorEngine

Public Types inherited from GKGenericExperiment
enum	GKGenericExperimentStatus { ePending , eDone , eDiscarded , eLoaded }

Public Types inherited from GKObject
enum	IdentifierFormFlag { eIdentifierDefault , eIdentifierId , eIdentifierName , eIdentifierExternalId , eIdentifierTypeExternalName , eIdentifierDescription , eIdentifierStandard , eIdentifierStandardWithType , eIdentifierAll }

enum	GKLockType { eNone , eModification , eDelete , eModificationDelete }

enum	GKObjectStatus { eNew , eSaved , eModified , eDeleted }

typedef QFlags< GKObject::IdentifierFormFlag >	IdentifierForm

Public Member Functions
	GKExperiment ()

void	addReplication (GKReplication *)

void	removeReplication (GKReplication *)

const GKFolder *	getReplications () const

uint	getNbThreadsSim () const

void	setNbThreadsSim (uint aths)

uint	getNbMicroSimThreads () const

void	setNbMicroSimThreads (uint aThreads)

uint	getNbMesoSimThreads () const

void	setNbMesoSimThreads (uint aThreads)

uint	getNbThreadsPaths () const

void	setNbThreadsPaths (uint aths)

uint	getNbReplications () const

uint	getNbResults () const

void	setInitialStateType (GKInitialStateType atype)

GKInitialStateType	getInitialStateType () const

void	setWarmupTime (const GKTimeDuration &)

GKTimeDuration	getWarmupTime () const

GKDynamicTrafficSnapshot *	getTrafficSnapshot () const

void	setTrafficSnapshot (GKDynamicTrafficSnapshot *snap)

const GKArrivalType	getArrivalType () const

void	setArrivalType (GKArrivalType)

const GKArrivalType	getArrivalType (GKObject *) const

void	setArrivalType (GKObject *, GKArrivalType)

const QMap< GKObject *, GKExperiment::GKArrivalType > &	getArrivalsType () const

void	clearArrivalsType ()

void	clearVariableReactionTimes ()

const QMap< const GKVehicle *, QVector< GKVehicleReactionTimes > >	getVariableReactionTimesMicro () const

void	setVariableReactionTimesMicro (const GKVehicle *, const QVector< GKVehicleReactionTimes > &)

const QMap< const GKVehicle *, QVector< GKVehicleReactionTimes > >	getVariableReactionTimesMeso () const

void	setVariableReactionTimesMeso (const GKVehicle *, const QVector< GKVehicleReactionTimes > &)

SimulatorEngine	getSimulatorEngine () const

void	setSimulatorEngine (SimulatorEngine se)

EngineMode	getEngineMode () const

void	setEngineMode (EngineMode em)

QString	getNameAutomatically () const

float	getPathAssignmentResultsPercentage (GKMobileAgent *vehicle) const

void	setPathAssignmentResultsPercentage (GKMobileAgent *vehicle, float percentage)

float	getODRoutesPercentage (GKMobileAgent *vehicle) const

void	setODRoutesPercentage (GKMobileAgent *vehicle, float percentage)

float	getEnRouteForPathAssignmentResultsPercentage (GKMobileAgent *vehicle) const

void	setEnRouteForPathAssignmentResultsPercentage (GKMobileAgent *vehicle, float percentage)

float	getEnRouteForODRoutesPercentage (GKMobileAgent *vehicle) const

void	setEnRouteForODRoutesPercentage (GKMobileAgent *vehicle, float percentage)

float	getEnRouteForRouteChoicePathsPercentage (GKMobileAgent *vehicle) const

void	setEnRouteForRouteChoicePathsPercentage (GKMobileAgent *vehicle, float percentage)

int	getMaxPathAlternativesPerVehicle (GKMobileAgent *vehicle) const

void	setMaxPathAlternativesPerVehicle (GKMobileAgent *vehicle, int maxPathAlternatives)

const QVector< GKExperimentODParameters > &	getRouteChoiceODParameters () const

void	setRouteChoiceODParameters (const QVector< GKExperimentODParameters > &params)

void	addRouteChoiceODParameter (const GKExperimentODParameters &params)

void	clearRouteChoiceODParameters ()

PathCalculationAlgorithm	getPathCalculationAlgorithm () const

void	setPathCalculationAlgorithm (PathCalculationAlgorithm pca)

QSet< GKGeoObject * >	getHybridMicroObjects () const

void	setInitialSPTrees (int value)

int	initialSPTrees () const

void	setMaxAssignmentResultsPaths (int value)

int	maxAssignmentResultsPaths () const

void	setMaxODRoutesPaths (int value)

int	maxODRoutesPaths () const

void	setDisablePathCalculation (DisablePathCalculation value)

GKExperiment::DisablePathCalculation	disablePathCalculation () const

void	setBlockedODPairsMatrix (GKODMatrix *matrix)

GKODMatrix *	blockedODPairsMatrix () const

void	addSimulationArea (GKSimulationArea *area)

void	removeSimulationArea (GKSimulationArea *area)

void	clearSimulationAreas ()

const QVector< GKSimulationArea * > &	getSimulationAreas () const

bool	usesSimulationArea (const GKSimulationArea *area) const

uint	getHybridMicroFlags () const

void	setHybridMicroFlags (uint microFlags)

bool	isPolicyActive (const GKPolicy *policy) const

bool	useProfiledRC () const

void	setUseProfiledRC (bool value)

QVector< int >	intervalsRC () const

void	setIntervalsRC (const QVector< int > &intervals)

void	setAppliedTWOPAS (bool aAppliedTWOPAS)

bool	appliedTWOPAS () const

void	setAppliedMFC (bool aAppliedMFC)

bool	appliedMFC () const

Public Member Functions inherited from GKGenericExperiment
	GKGenericExperiment ()

virtual GKGenericExperimentStatus	getExecutionStatus () const

void	setValueForVariable (const QString &variable, const QString &value)

bool	removeVariable (const QString &variable)

const QString &	getValueForVariable (const QString &variable) const

const QMap< QString, QString > &	getVariables () const

void	setVariables (const QMap< QString, QString > &newList)

void	setScenario (GKGenericScenario *anScenario)

GKGenericScenario *	getScenario () const

void	setForest (BaseForest *_forest, bool _delete=true)

const BaseForest *	getForest () const

void	addNetworkAttributesOverride (GKNetworkAttributesOverride *ovrd, int pos=-1)

void	removeNetworkAttributesOverride (GKNetworkAttributesOverride *ovrd)

void	clearNetworkAttributesOverrides ()

const QVector< GKNetworkAttributesOverride * > &	getNetworkAttributesOverrides () const

int	usesNetworkAttributesOverride (const GKNetworkAttributesOverride *ovrd) const

void	setPreExecutionScript (GKScript *script)

void	setPostExecutionScript (GKScript *script)

GKScript *	getPreExecutionScript () const

GKScript *	getPostExecutionScript () const

QString	getOutputFile (const QString &iType) const

void	addPolicy (GKPolicy *)

void	removePolicy (GKPolicy *)

void	removePolicies ()

const QVector< GKPolicy * > &	getPolicies () const

bool	usesPolicy (GKPolicy *) const

bool	canPolicyBeUsed (GKPolicy *) const

const QDateTime &	getInitExecutionTime () const

const QDateTime &	getEndExecutionTime () const

Public Member Functions inherited from GKObject
	GKObject ()

	GKObject (const GKObject &o)

virtual void	addedToCatalog ()

virtual void	removedFromCatalog ()

uint	getTick () const

virtual void	increaseTick ()

void	setTick (uint t)

virtual GKObject *	clone (bool addItToModel=true) const

virtual GKObject *	cloneAsTemporary (bool addItToModel=true) const

GKFolder *	getCreateRootFolder ()

GKFolder *	getRootFolder () const

void	setRootFolder (GKFolder *afolder)

GKFolder *	findFolder (const QString &byName) const

QVector< GKFolder * >	getParentFolders () const

bool	isDataValueNull (const GKColumn *attr) const

virtual QVariant *	getDataValue (const GKColumn attr, bool deleteit, const GKContext &context=GKContext::anyContext) const

QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const

virtual void	setDataValue (const GKColumn *attr, const QVariant &v)

void	setDataValueByID (uint attrId, const QVariant &v)

virtual void	setDataValueObject (const GKColumn attr, const GKObject obj)

void	setDataValueObjectByID (uint attrId, const GKObject *obj)

virtual void	setDataValueDouble (const GKColumn *attr, double v)

void	setDataValueDoubleByID (uint attrId, double v)

virtual double	getDataValueInTS (const GKColumn attr, GKTimeSerieIndex index, double deviation=NULL) const

double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const

bool	hasAnyTSWithData () const

virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const

GKTimeSerie *	getDataValueTSByID (uint attrId) const

virtual void	setDataValueInTS (const GKColumn attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription aDescription=NULL, int reservedSize=0)

virtual void	setDataValueInTS (const GKColumn attr, GKTimeSerieIndex index, double value, double deviation, double lowerValue, GKTSDescription aDescription=NULL, int reservedSize=0)

virtual void	setDataValueInSingleTS (const GKColumn attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription aDescription)

void	setDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)

virtual void	setAggregatedValueInTS (const GKColumn attr, double value, double deviation, GKTSDescription aDescription=NULL)

void	setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)

virtual void	clearDataValueTS (const GKColumn attr, GKTSDescription aDescription=NULL)

void	clearDataValueTSByID (uint attrId, GKTSDescription *aDescription=NULL)

virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const

virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const

QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const

virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const

virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const

QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const

QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const

QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const

GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const

void	removeDataValue (const GKColumn *attr)

void	removeDataValueByID (uint attrId)

const QString &	getDescription () const

void	setDescription (const QString &adescription)

const QString &	getExternalId () const

void	setExternalId (const QString &anId)

virtual GKObjectDelCmd *	getDelCmd ()

virtual GKObjectConnectionDelCmd *	getDelConnectionCmd (GKObject *target)

virtual void	nonCommandObjectRemoved (GKObject *)

virtual void	init ()

virtual void	setId (uint aid, GKModel *model)

uint	getId () const

QUuid	getUUID () const

virtual void	setName (const QString &aname)

const QString &	getName () const

QString	getExtendedId (IdentifierForm form=eIdentifierDefault) const

QString	getNameOrExtendedId (IdentifierForm form=eIdentifierDefault) const

virtual const QString &	getTypeName () const

virtual QString	getTypeExternalName () const

const GKObject *	getMaster () const

GKType *	getType () const

virtual void	setType (GKType *atype)

bool	isA (const GKType *atype) const

bool	isA (const QString &typeName) const

virtual void	setModel (GKModel *amodel)

GKModel *	getModel () const

virtual void	setLock (GKLockType atype)

GKLockType	getLock () const

virtual bool	canBeDeleted () const

virtual bool	canBeModified () const

virtual bool	canBeEdited () const

GKObjectStatus	getStatus () const

virtual void	setStatus (const GKObjectStatus astatus)

void	notifyStatusChange ()

bool	isTemporary () const

void	setTemporary (bool value)

bool	isExternal () const

void	setExternal (bool value)

virtual void	preferencesChanged ()

void	removeColumn (GKColumn *column)

void	resetColumn (GKColumn *column)

Public Member Functions inherited from GKBaseObject
	GKBaseObject ()

	if (base)

virtual uint	getId () const =0

virtual const QString &	getTypeName () const =0

virtual QString	getTypeExternalName () const =0

virtual const GKObject *	getMaster () const =0

virtual const QString &	getName () const =0

virtual const QString &	getExternalId () const =0

virtual const QString &	getDescription () const =0

virtual GKModel *	getModel () const =0

virtual QVariant *	getDataValue (const GKColumn attr, bool deleteit, const GKContext &context=GKContext::anyContext) const =0

virtual QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0

virtual double	getDataValueInTS (const GKColumn attr, GKTimeSerieIndex index, double deviation=NULL) const =0

virtual double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const =0

virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const =0

virtual GKTimeSerie *	getDataValueTSByID (uint attrId) const =0

virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

virtual GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

Static Public Attributes
static const SimulatorEngine	eMicro

static const SimulatorEngine	eMeso

static const SimulatorEngine	eHybrid

static const SimulatorEngine	eDynamicMacro

static const SimulatorEngine	eMacroMesoHybrid

static uint	pathCalculationAlgorithmAtt

static uint	simStepAtt

static uint	reactionTimeAtt

static uint	reactionAtStopAtt

static uint	reactionAtTrafficLightAtt

static uint	reactionAtTrafficLightMesoAtt

static uint	reactionTimeTypeAtt

static uint	queueUpSpeedAtt

static uint	queueLeavingSeepAtt

static uint	carFollowingVersionAtt

static uint	carFollowingConsiderMinHeadwayAtt

static uint	applyTwoLanesAtt

static uint	applyTwopasAtt

static uint	applyMFCAtt

static uint	nbVehiclesAtt

static uint	maxDistanceAtt

static uint	maxSpeedDiffAtt

static uint	maxSpeedDiffRampAtt

static uint	cycleTimeAtt

static uint	intervalsAtt

static uint	capacityWeigthAtt

static uint	userDefinedCostWeigthAtt

static uint	routeChoiceTypeAtt

static uint	dynamicAtt

static uint	initialSPTreesAtt

static uint	pathCostsAtt

static uint	maxAssignPathsAtt

static uint	maxRoutesAtt

static uint	probabilityAtt

static uint	alfaFactorAtt

static uint	scaleFactorAtt

static uint	betaFactorAtt

static uint	gammaFactorAtt

static uint	userFunctionAtt

static uint	pastCostReplicationAtt

static uint	activateExternalBehavioralModelAtt

static uint	warmupDemandAtt

static uint	nbMicroThreads

static uint	nbMesoThreads

static uint	nbPathsThreads

static uint	FirstandLastSegmentTravelTimeType

static uint	ReenteringSegmentTravelTimeType

static uint	travelTimeFunctionComponent

static uint	macroMesoFunctionUnitsConversionFactor

Static Public Attributes inherited from GKObject
static uint	typeNameAtt

static uint	typeExternalNameAtt

static uint	revisedAtt

Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint	idAtt

static uint	nameAtt

static uint	externalIdAtt

static uint	descriptionAtt

Additional Inherited Members
Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp

	sipType = 0

Detailed Description

This object holds all needed parameters to run a Dynamic simulation.

A dynamic experiment can be defined either as a SRC (stochastic route choice) or a DUE (dynamic user-equilibrium). If it is defined as a SRC then it has a collection of replications (GKReplication) an one or more averages (GKExperimentResult). If it is defined as a DUE then it has a collection of experiment results (GKExperimentResult). In both cases this experiment belongs to a only scenario (GKScenario).

Member Typedef Documentation

◆ SimulatorEngine

typedef int GKExperiment::SimulatorEngine

Network loading type:

eMicro: using the microscopic simulator.
eMeso: using the mesoscopic simulator.
eHybrid: using the hybrid meso-micro simulator.
eDynamicMacro: using the macroscopic simulator.
eMacroMesoHybrid: using the hybrid macro-meso simulator.

Member Enumeration Documentation

◆ DisablePathCalculation

enum GKExperiment::DisablePathCalculation

Disable Path Calculation type:

eNo: Don't disable the path calculation.
eForAllODPairs: Disable the path calculation for all ODPairs.
eForTheBlockedODPairsInMatrix: Disable the path calculation for all ODPairs that are blocked in the selected matrix (mBlockedODPairsMatrix).

Enumerator
eNo
eForAllODPairs
eForTheBlockedODPairsInMatrix

◆ DUEPathCost

enum GKExperiment::DUEPathCost

Enumerator
Instantaneous
Experienced
TimeDependent

◆ EngineMode

enum GKExperiment::EngineMode

Type of the dynamic traffic assignment:

eIterative: dynamic traffic assignment based on user equilibrium (DUE)
eOneShot: dynamic traffic assignment based on stochastic route choice (SRC).

Enumerator
eIterative
eOneShot

◆ GKArrivalType

enum GKExperiment::GKArrivalType

Types of arrivals. Refer to the Aimsun Next Micro manual section for more information on the different types. The eNone special value is returned by GKExperiment::getArrivalType when the origin object (centroid or section) has no value.

Enumerator
eExponential
eUniform
eNormal
eConstant
eExternal
eASAP
eNone

◆ GKInitialStateType

enum GKExperiment::GKInitialStateType

The initial state generated either by a wram-up or a save traffic state (GKDynamicTrafficSnapshot)

Enumerator
eWarmup
eSavedState

◆ GKReactionTimeType

enum GKExperiment::GKReactionTimeType

Type of reaction time.

eAsSimStep: reaction time is the same for all vehicle types. It is equal to simulation step.
eVariableVehType: reaction time is set for each vehicle type

Enumerator
eAsSimStep
eVariableVehType

◆ HybridMicroFlags

enum GKExperiment::HybridMicroFlags

Flag values describing the additional objects (other than those obtained from simulation areas) to be micro-simulated in a hybrid experiment

Enumerator
eMicroNone
eMicroSectionsWithActuatedCPDestNode
eMicroSectionsWithBusPreemptionCPDestNode
eMicroSectionsWithControlledDestNode
eMicroSectionsWithLegionPedCrossings
eMicroSectionsWithPTLineStop
eMicroSectionsUsedByPTLine
eMicroSectionsWithEVDetector

◆ PathCalculationAlgorithm

enum GKExperiment::PathCalculationAlgorithm

Choose Path Calculation Algorithm:

Enumerator
eDijkstra
eAStar

◆ TravelTime

enum GKExperiment::TravelTime

Enumerator
eInstantaneous
eTotalVdfTpfJdfCost
eFunctionComponent

Constructor & Destructor Documentation

◆ GKExperiment()

GKExperiment::GKExperiment ( )

Member Function Documentation

◆ addReplication()

void GKExperiment::addReplication ( GKReplication * )

Add a new replication to this experiment.

◆ addRouteChoiceODParameter()

void GKExperiment::addRouteChoiceODParameter ( const GKExperimentODParameters & params )

Adds an OD route choice parameter.

◆ addSimulationArea()

void GKExperiment::addSimulationArea ( GKSimulationArea * area )

Adds a simulation area to this experiment.

◆ appliedMFC()

bool GKExperiment::appliedMFC ( ) const

Returns true if the MFC acceleration model is activated.

◆ appliedTWOPAS()

bool GKExperiment::appliedTWOPAS ( ) const

Returns true if the TWOPAS acceleration model is activated.

◆ blockedODPairsMatrix()

GKODMatrix * GKExperiment::blockedODPairsMatrix ( ) const

Returns the blocked ODPairs matrix

◆ clearArrivalsType()

void GKExperiment::clearArrivalsType ( )

Removes all the arrivals for the origin centroids.

◆ clearRouteChoiceODParameters()

void GKExperiment::clearRouteChoiceODParameters ( )

Removes all OD route choice parameters.

◆ clearSimulationAreas()

void GKExperiment::clearSimulationAreas ( )

Removes all simulation areas from this experiment.

◆ clearVariableReactionTimes()

void GKExperiment::clearVariableReactionTimes ( )

Discard the variable reaction times info.

◆ disablePathCalculation()

GKExperiment::DisablePathCalculation GKExperiment::disablePathCalculation ( ) const

Returns which ODPairs won't be considered during the path calculation

◆ getArrivalsType()

const QMap< GKObject *, GKExperiment::GKArrivalType > & GKExperiment::getArrivalsType ( ) const

Returns all the arrivals for the origin centroids.

◆ getArrivalType() [1/2]

const GKArrivalType GKExperiment::getArrivalType ( ) const

Sets the arrival type.

◆ getArrivalType() [2/2]

const GKArrivalType GKExperiment::getArrivalType ( GKObject * ) const

Returns the arrival type for an origin centroid. If no arrival has been set then the eNone arrival type will be returned.

◆ getEngineMode()

EngineMode GKExperiment::getEngineMode ( ) const

Gets the dynamic traffic assignment's type.

◆ getEnRouteForODRoutesPercentage()

float GKExperiment::getEnRouteForODRoutesPercentage ( GKMobileAgent * vehicle ) const

Gets the number of vehicles that are following an OD-Route and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ getEnRouteForPathAssignmentResultsPercentage()

float GKExperiment::getEnRouteForPathAssignmentResultsPercentage ( GKMobileAgent * vehicle ) const

Gets the number of vehicles that are following a path from the Path Assignment results and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ getEnRouteForRouteChoicePathsPercentage()

float GKExperiment::getEnRouteForRouteChoicePathsPercentage ( GKMobileAgent * vehicle ) const

Gets the number of vehicles that are following route choice paths (paths calculated using the Route Choice model) and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ getHybridMicroFlags()

uint GKExperiment::getHybridMicroFlags ( ) const

Sets the flags value describing the additional objects to be micro-simulated in a hybrid experiment.

◆ getHybridMicroObjects()

QSet< GKGeoObject * > GKExperiment::getHybridMicroObjects ( ) const

Returns the set of objects to be micro-simulated in a hybrid experiment, according to the simulation area and flags configured into the experiment.

◆ getInitialStateType()

GKInitialStateType GKExperiment::getInitialStateType ( ) const

The initial state generated either by a wram-up or a save traffic state (GKDynamicTrafficSnapshot)

◆ getMaxPathAlternativesPerVehicle()

int GKExperiment::getMaxPathAlternativesPerVehicle ( GKMobileAgent * vehicle ) const

Gets the maximum number of path alternatives the route choice will calculate for the specified vehicle.

◆ getNameAutomatically()

QString GKExperiment::getNameAutomatically ( ) const

Generates the name of this object automatically based on its simulator engine and engine mode.

◆ getNbMesoSimThreads()

uint GKExperiment::getNbMesoSimThreads ( ) const

Gets the number of threads used to simulate this Meso replication. Requires an Aimsun Next Advanced License.

◆ getNbMicroSimThreads()

uint GKExperiment::getNbMicroSimThreads ( ) const

Gets the number of threads used to simulate this Micro replication. Requires an Aimsun Next Advanced License.

◆ getNbReplications()

uint GKExperiment::getNbReplications ( ) const

Returns the number of replications on this experiment.

◆ getNbResults()

uint GKExperiment::getNbResults ( ) const

Returns the number of results on this experiment.

◆ getNbThreadsPaths()

uint GKExperiment::getNbThreadsPaths ( ) const

Gets the number of threads used in the Route Choice. Requires an Aimsun Next Advanced Licence.

◆ getNbThreadsSim()

uint GKExperiment::getNbThreadsSim ( ) const

This function is Obsolete, please use: uint getNbMicroSimThreads().

◆ getODRoutesPercentage()

float GKExperiment::getODRoutesPercentage ( GKMobileAgent * vehicle ) const

Gets the OD-Routes's percentage. This is the percentage that will be used to assign paths to vehicle vehicle.

◆ getPathAssignmentResultsPercentage()

float GKExperiment::getPathAssignmentResultsPercentage ( GKMobileAgent * vehicle ) const

Gets the path assignment result's percentage. This is the percentage that will be used to assign paths to vehicle vehicle.

◆ getPathCalculationAlgorithm()

PathCalculationAlgorithm GKExperiment::getPathCalculationAlgorithm ( ) const

Gets the assigned Path Calculation Algorithm.

◆ getReplications()

const GKFolder * GKExperiment::getReplications ( ) const

Returns all the replications of this experiment.

◆ getRouteChoiceODParameters()

const QVector< GKExperimentODParameters > & GKExperiment::getRouteChoiceODParameters ( ) const

Returns the route choice parameters for an Origin and Destination.

◆ getSimulationAreas()

const QVector< GKSimulationArea * > & GKExperiment::getSimulationAreas ( ) const

Returns the simulation areas in this experiment.

◆ getSimulatorEngine()

SimulatorEngine GKExperiment::getSimulatorEngine ( ) const

Gets the type of network loading or simulator engine.

◆ getTrafficSnapshot()

GKDynamicTrafficSnapshot * GKExperiment::getTrafficSnapshot ( ) const

A traffic snapshot to use as the initial point of a simulation.

◆ getVariableReactionTimesMeso()

const QMap< const GKVehicle *, QVector< GKVehicleReactionTimes > > GKExperiment::getVariableReactionTimesMeso ( ) const

Gets all the variable reaction times for the meso model.

◆ getVariableReactionTimesMicro()

const QMap< const GKVehicle *, QVector< GKVehicleReactionTimes > > GKExperiment::getVariableReactionTimesMicro ( ) const

Gets all the variable reaction times for the micro model.

◆ getWarmupTime()

GKTimeDuration GKExperiment::getWarmupTime ( ) const

Gets the simulation warm-up period.

◆ initialSPTrees()

int GKExperiment::initialSPTrees ( ) const

◆ intervalsRC()

QVector< int > GKExperiment::intervalsRC ( ) const

◆ isPolicyActive()

bool GKExperiment::isPolicyActive ( const GKPolicy * policy ) const

Returns true if the given policy is active in this experiment or is active in the scenario of this exepriment (as traffic condition).

◆ maxAssignmentResultsPaths()

int GKExperiment::maxAssignmentResultsPaths ( ) const

◆ maxODRoutesPaths()

int GKExperiment::maxODRoutesPaths ( ) const

◆ removeReplication()

void GKExperiment::removeReplication ( GKReplication * )

Removes a replication from this experiment. The replication is not deleted.

◆ removeSimulationArea()

void GKExperiment::removeSimulationArea ( GKSimulationArea * area )

Removes a simulation area from this experiment.

◆ setAppliedMFC()

void GKExperiment::setAppliedMFC ( bool aAppliedMFC )

Sets if the MFC acceleration model is activated.

◆ setAppliedTWOPAS()

void GKExperiment::setAppliedTWOPAS ( bool aAppliedTWOPAS )

Sets if the TWOPAS acceleration model is activated.

◆ setArrivalType() [1/2]

void GKExperiment::setArrivalType ( GKArrivalType )

Gets the arrival type.

◆ setArrivalType() [2/2]

void GKExperiment::setArrivalType	(	GKObject *	,
		GKArrivalType
	)

Sets the arrival type for an origin centroid.

◆ setBlockedODPairsMatrix()

void GKExperiment::setBlockedODPairsMatrix ( GKODMatrix * matrix )

Sets the blocked ODPairs matrix that will be used if "eForTheBlockedODPairsInMatrix" is selected

◆ setDisablePathCalculation()

void GKExperiment::setDisablePathCalculation ( DisablePathCalculation value )

Set which ODPairs won't be considered during the path calculation

◆ setEngineMode()

void GKExperiment::setEngineMode ( EngineMode em )

Sets the dynamic traffic assignment's type.

◆ setEnRouteForODRoutesPercentage()

void GKExperiment::setEnRouteForODRoutesPercentage	(	GKMobileAgent *	vehicle,
		float	percentage
	)

Sets the number of vehicles that are following an OD-Route and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ setEnRouteForPathAssignmentResultsPercentage()

void GKExperiment::setEnRouteForPathAssignmentResultsPercentage	(	GKMobileAgent *	vehicle,
		float	percentage
	)

Sets the number of vehicles that are following a path from the Path Assignment results and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ setEnRouteForRouteChoicePathsPercentage()

void GKExperiment::setEnRouteForRouteChoicePathsPercentage	(	GKMobileAgent *	vehicle,
		float	percentage
	)

Sets the number of vehicles that are following route choice paths (paths calculated using the Route Choice model) and can change its paths during the simulaton. This percentage is taken into account only when the experiment is "Dynamic".

◆ setHybridMicroFlags()

void GKExperiment::setHybridMicroFlags ( uint microFlags )

Returns the flags value describing the additional objects to be micro-simulated in a hybrid experiment.

◆ setInitialSPTrees()

void GKExperiment::setInitialSPTrees ( int value )

◆ setInitialStateType()

void GKExperiment::setInitialStateType ( GKInitialStateType atype )

The initial state generated either by a wram-up or a save traffic state (GKDynamicTrafficSnapshot)

◆ setIntervalsRC()

void GKExperiment::setIntervalsRC ( const QVector< int > & intervals )

◆ setMaxAssignmentResultsPaths()

void GKExperiment::setMaxAssignmentResultsPaths ( int value )

◆ setMaxODRoutesPaths()

void GKExperiment::setMaxODRoutesPaths ( int value )

◆ setMaxPathAlternativesPerVehicle()

void GKExperiment::setMaxPathAlternativesPerVehicle	(	GKMobileAgent *	vehicle,
		int	maxPathAlternatives
	)

Sets the maximum number of path alternatives the route choice will calculate for the specified vehicle.

◆ setNbMesoSimThreads()

void GKExperiment::setNbMesoSimThreads ( uint aThreads )

Sets the number of threads used to simulate this Meso replication. Requires an Aimsun Next Advanced License.

◆ setNbMicroSimThreads()

void GKExperiment::setNbMicroSimThreads ( uint aThreads )

Sets the number of threads used to simulate this Micro replication. Requires an Aimsun Next Advanced License.

◆ setNbThreadsPaths()

void GKExperiment::setNbThreadsPaths ( uint aths )

Sets the number of threads used in the Route Choice. Requires an Aimsun Next Advanced Licence.

◆ setNbThreadsSim()

void GKExperiment::setNbThreadsSim ( uint aths )

This function is Obsolete, please use: void setNbMicroSimThreads( uint aThreads ).

◆ setODRoutesPercentage()

void GKExperiment::setODRoutesPercentage	(	GKMobileAgent *	vehicle,
		float	percentage
	)

Sets the OD-Routes's percentage. This is the percentage that will be used to assign paths to vehicle vehicle.

◆ setPathAssignmentResultsPercentage()

void GKExperiment::setPathAssignmentResultsPercentage	(	GKMobileAgent *	vehicle,
		float	percentage
	)

Sets the path assignment result's percentage. This is the percentage that will be used to assign paths to vehicle vehicle.

◆ setPathCalculationAlgorithm()

void GKExperiment::setPathCalculationAlgorithm ( PathCalculationAlgorithm pca )

Sets the assigned Path Calculation Algorithm.

◆ setRouteChoiceODParameters()

void GKExperiment::setRouteChoiceODParameters ( const QVector< GKExperimentODParameters > & params )

Sets the Origin/Destination route choice models.

◆ setSimulatorEngine()

void GKExperiment::setSimulatorEngine ( SimulatorEngine se )

Sets the type of network loading or simulator engine.

◆ setTrafficSnapshot()

void GKExperiment::setTrafficSnapshot ( GKDynamicTrafficSnapshot * snap )

A traffic snapshot to use as the initial point of a simulation.

◆ setUseProfiledRC()

void GKExperiment::setUseProfiledRC ( bool value )

◆ setVariableReactionTimesMeso()

void GKExperiment::setVariableReactionTimesMeso	(	const GKVehicle *	,
		const QVector< GKVehicleReactionTimes > &
	)

Sets the variable reaction times by vehicle type for the meso model.

◆ setVariableReactionTimesMicro()

void GKExperiment::setVariableReactionTimesMicro	(	const GKVehicle *	,
		const QVector< GKVehicleReactionTimes > &
	)

Sets the variable reaction times by vehicle type for the micro model.

◆ setWarmupTime()

void GKExperiment::setWarmupTime ( const GKTimeDuration & )

Sets the simulation warm-up period.

◆ useProfiledRC()

bool GKExperiment::useProfiledRC ( ) const

◆ usesSimulationArea()

bool GKExperiment::usesSimulationArea ( const GKSimulationArea * area ) const

Returns true is the simulation area is used in the experiment.

Member Data Documentation

◆ activateExternalBehavioralModelAtt

uint GKExperiment::activateExternalBehavioralModelAtt

static

Aimsun Next Micro SDK: Use External Model

◆ alfaFactorAtt

uint GKExperiment::alfaFactorAtt

static

Route Choice: Alpha Factor

◆ applyMFCAtt

uint GKExperiment::applyMFCAtt

static

Apply the Micro Free-Flow acceleration MFC model or not.

◆ applyTwoLanesAtt

uint GKExperiment::applyTwoLanesAtt

static

Apply a Two-Lane Car-Following?

◆ applyTwopasAtt

uint GKExperiment::applyTwopasAtt

static

Apply the Twopas model or not.

◆ betaFactorAtt

uint GKExperiment::betaFactorAtt

static

Route Choice: Beta Factor

◆ capacityWeigthAtt

uint GKExperiment::capacityWeigthAtt

static

Route Choice: Capacity weight

◆ carFollowingConsiderMinHeadwayAtt

uint GKExperiment::carFollowingConsiderMinHeadwayAtt

static

Consider minimum headway in Car-Following or not

◆ carFollowingVersionAtt

uint GKExperiment::carFollowingVersionAtt

static

Car-Following version:

0: 4.1
1: 4.2

◆ cycleTimeAtt

uint GKExperiment::cycleTimeAtt

static

Route Choice: cycle time in seconds

◆ dynamicAtt

uint GKExperiment::dynamicAtt

static

Route Choice: Dynamic?

◆ eDynamicMacro

const SimulatorEngine GKExperiment::eDynamicMacro

static

◆ eHybrid

const SimulatorEngine GKExperiment::eHybrid

static

◆ eMacroMesoHybrid

const SimulatorEngine GKExperiment::eMacroMesoHybrid

static

◆ eMeso

const SimulatorEngine GKExperiment::eMeso

static

◆ eMicro

const SimulatorEngine GKExperiment::eMicro

static

◆ FirstandLastSegmentTravelTimeType

uint GKExperiment::FirstandLastSegmentTravelTimeType

static

Hybrid macro-meso travel time First and last type.

◆ gammaFactorAtt

uint GKExperiment::gammaFactorAtt

static

Route Choice: Gamma Factor

◆ initialSPTreesAtt

uint GKExperiment::initialSPTreesAtt

static

Route Choice: Initial K-SPs

◆ intervalsAtt

uint GKExperiment::intervalsAtt

static

Route Choice: Number of Intervals

◆ macroMesoFunctionUnitsConversionFactor

uint GKExperiment::macroMesoFunctionUnitsConversionFactor

static

Hybrid macro-meso Cost Function unit conversion factor.

◆ maxAssignPathsAtt

uint GKExperiment::maxAssignPathsAtt

static

Route Choice: Maximum Number of Paths from Path assignment result

◆ maxDistanceAtt

uint GKExperiment::maxDistanceAtt

static

Maximum distance when using Two-Lane Car-Following

◆ maxRoutesAtt

uint GKExperiment::maxRoutesAtt

static

Route Choice: Maximum Number of Routes

◆ maxSpeedDiffAtt

uint GKExperiment::maxSpeedDiffAtt

static

Maximum speed difference when using Two-Lane Car-Following

◆ maxSpeedDiffRampAtt

uint GKExperiment::maxSpeedDiffRampAtt

static

Maximum speed difference on-ramp when using Two-Lane Car-Following

◆ nbMesoThreads

uint GKExperiment::nbMesoThreads

static

Number of threads in Meso Simulation.

◆ nbMicroThreads

uint GKExperiment::nbMicroThreads

static

Number of threads in Micro Simulation.

◆ nbPathsThreads

uint GKExperiment::nbPathsThreads

static

Number of threads in Route Choice.

◆ nbVehiclesAtt

uint GKExperiment::nbVehiclesAtt

static

Number of Vehicles to consider when using Two-Lane Car-Following

◆ pastCostReplicationAtt

uint GKExperiment::pastCostReplicationAtt

static

Route Choice: Link Costs Replication

◆ pathCalculationAlgorithmAtt

uint GKExperiment::pathCalculationAlgorithmAtt

static

Path Calculation: Algorithm Choice.

◆ pathCostsAtt

uint GKExperiment::pathCostsAtt

static

DUE: use instantaneous, experienced or time-dependent costs

◆ probabilityAtt

uint GKExperiment::probabilityAtt

static

Route Choice: Probability

◆ queueLeavingSeepAtt

uint GKExperiment::queueLeavingSeepAtt

static

Queue Exit Speed

◆ queueUpSpeedAtt

uint GKExperiment::queueUpSpeedAtt

static

Queue Entry Speed

◆ reactionAtStopAtt

uint GKExperiment::reactionAtStopAtt

static

Reaction Time at Stop

◆ reactionAtTrafficLightAtt

uint GKExperiment::reactionAtTrafficLightAtt

static

Reaction Time at Traffic Light, applied to the first vehicle stopping at the traffic light, in the micro model.

◆ reactionAtTrafficLightMesoAtt

uint GKExperiment::reactionAtTrafficLightMesoAtt

static

Reaction Time at Traffic Light, applied to the first vehicle stopping at the traffic light, in the meso model.

◆ reactionTimeAtt

uint GKExperiment::reactionTimeAtt

static

Reaction Time for meso experiments

◆ reactionTimeTypeAtt

uint GKExperiment::reactionTimeTypeAtt

static

Reaction Time Type (GKReactionTimeType)

◆ ReenteringSegmentTravelTimeType

uint GKExperiment::ReenteringSegmentTravelTimeType

static

Hybrid macro-meso travel time Reentering type.

◆ routeChoiceTypeAtt

uint GKExperiment::routeChoiceTypeAtt

static

Route Choice: Route Choice Type:

0: Fixed (distance)
1: Fixed (time)
2: Binomial
3: Proportional
4: Logit
5: C-Logit
6: User-Defined

◆ scaleFactorAtt

uint GKExperiment::scaleFactorAtt

static

Route Choice: Scale Factor

◆ simStepAtt

uint GKExperiment::simStepAtt

static

Simulation Step

◆ travelTimeFunctionComponent

uint GKExperiment::travelTimeFunctionComponent

static

Hybrid macro-meso travel time.

◆ userDefinedCostWeigthAtt

uint GKExperiment::userDefinedCostWeigthAtt

static

Route Choice: User-Defined Cost Weight

◆ userFunctionAtt

uint GKExperiment::userFunctionAtt

static

Route Choice: User Function

◆ warmupDemandAtt

uint GKExperiment::warmupDemandAtt

static

Warm-up demand object

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SimulatorEngine

Member Enumeration Documentation

◆ DisablePathCalculation

◆ DUEPathCost

◆ EngineMode

◆ GKArrivalType

◆ GKInitialStateType

◆ GKReactionTimeType

◆ HybridMicroFlags

◆ PathCalculationAlgorithm

◆ TravelTime

Constructor & Destructor Documentation

◆ GKExperiment()

Member Function Documentation

◆ addReplication()

◆ addRouteChoiceODParameter()

◆ addSimulationArea()

◆ appliedMFC()

◆ appliedTWOPAS()

◆ blockedODPairsMatrix()

◆ clearArrivalsType()

◆ clearRouteChoiceODParameters()

◆ clearSimulationAreas()

◆ clearVariableReactionTimes()

◆ disablePathCalculation()

◆ getArrivalsType()

◆ getArrivalType() [1/2]

◆ getArrivalType() [2/2]

◆ getEngineMode()

◆ getEnRouteForODRoutesPercentage()

◆ getEnRouteForPathAssignmentResultsPercentage()

◆ getEnRouteForRouteChoicePathsPercentage()

◆ getHybridMicroFlags()

◆ getHybridMicroObjects()

◆ getInitialStateType()

◆ getMaxPathAlternativesPerVehicle()

◆ getNameAutomatically()

◆ getNbMesoSimThreads()

◆ getNbMicroSimThreads()

◆ getNbReplications()

◆ getNbResults()

◆ getNbThreadsPaths()

◆ getNbThreadsSim()

◆ getODRoutesPercentage()

◆ getPathAssignmentResultsPercentage()

◆ getPathCalculationAlgorithm()

◆ getReplications()

◆ getRouteChoiceODParameters()

◆ getSimulationAreas()

◆ getSimulatorEngine()

◆ getTrafficSnapshot()

◆ getVariableReactionTimesMeso()

◆ getVariableReactionTimesMicro()

◆ getWarmupTime()

◆ initialSPTrees()

◆ intervalsRC()

◆ isPolicyActive()

◆ maxAssignmentResultsPaths()

◆ maxODRoutesPaths()

◆ removeReplication()

◆ removeSimulationArea()

◆ setAppliedMFC()

◆ setAppliedTWOPAS()

◆ setArrivalType() [1/2]

◆ setArrivalType() [2/2]

◆ setBlockedODPairsMatrix()

◆ setDisablePathCalculation()

◆ setEngineMode()

◆ setEnRouteForODRoutesPercentage()

◆ setEnRouteForPathAssignmentResultsPercentage()

◆ setEnRouteForRouteChoicePathsPercentage()

◆ setHybridMicroFlags()

◆ setInitialSPTrees()

◆ setInitialStateType()