PyANGKernel.GKExperimentResult¶

class GKExperimentResult¶

This object holds either an average of a collection of replications or a Dynamic User Equilibrium simulation (DUE). A replication can be in more than one average and when is holding a DUE then in does not have any replication.

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

addIncrementalParameters(percentage[, maxPaths=3[, queuePropagation=true]])¶

Parameters:

percentage – float
maxPaths – int
queuePropagation – bool

Sets the percentage, max number of paths and queue propagation option for each outer iteration of an incremental DUE experiment result

addReplication(replication)¶

Parameters:: replication – GKReplication

Adds a replication to this average. Be sure that you add replications of the same experiment.

clearIncrementalParameters()¶

clearRouteChoiceIntervals()¶

getAggregateByVehicleClass()¶

Return type:: bool

getAggregateRouteChoiceInterval()¶

Return type:: bool

getAnySimulatedReplication()¶

Return type:: GKReplication

Return any replication used in this result that has been simulated: Some functions requires the replication times to know the statistics and detection interval This information isn’t in the Result but is the same that in any (and in all) the replications.

getCalculateCostForZeroTrips()¶

Return type:: bool

getGenerateSkimMatrices()¶

Return type:: bool

getIncludeWarmup()¶

Return type:: bool

getIncrementalPercentages()¶

Return type:: .list of float

getReplications()¶

Return type:: .list of GKReplication

Gets all the replications in this average.

getRouteChoiceIntervals()¶

Return type:: .std.vectorint

getStoreIntermediateMatrices()¶

Return type:: bool

isIncremental()¶

Return type:: bool

Returns true if the result is an incremental DUE experiment

See also

setIsIncremental()

isUsed(replication)¶

Parameters:: replication – GKReplication
Return type:: bool

Returns true if the replication is used in this average.

removeReplication(replication)¶

Parameters:: replication – GKReplication

Removes a replication from this average.

removeReplications()¶

Removes all the replications from this average. The replications are not deleted.

resetReplications()¶

Marks all the replications as not simulated.

setAggregateByVehicleClass(arg__1)¶

Parameters:: arg__1 – bool

setAggregateRouteChoiceInterval(arg__1)¶

Parameters:: arg__1 – bool

setCalculateCostForZeroTrips(arg__1)¶

Parameters:: arg__1 – bool

setGenerateSkimMatrices(arg__1)¶

Parameters:: arg__1 – bool

setIncludeWarmup(arg__1)¶

Parameters:: arg__1 – bool

setIncrementalPercentages(arg__1)¶

Parameters:: arg__1 – .list of float

setIsIncremental(isIncremental)¶

Parameters:: isIncremental – bool

Sets whether the result is an incremental DUE experiment

See also

isIncremental()

setRouteChoiceIntervals(arg__1)¶

Parameters:: arg__1 – .std.vectorint
Return type:: bool

setStoreIntermediateMatrices(arg__1)¶

Parameters:: arg__1 – bool