PyANGKernel.GKTrafficArrivals¶

class GKTrafficArrivals¶

Detailed time information of the traffic (all the private vehicles) generated in a micro simulation.

Details

It stores all private vehicle arrival times into a file and the information of the paths being used by these vehicles. When loading a new micro simulation, the user can select a traffic arrival object to define which vehicles will be generated, when and where. Transit Vehicles are not considered at the moment.

Synopsis¶

Methods¶

def __init__()
def clear()
def getDemandType()
def getDuration()
def getFileName()
def getGenerationDate()
def getInitialTime()
def getIntervalForVeh()
def getNbVehiclesForType()
def getProblemNet()
def getProfilingInterval()
def getReplication()
def getSimulatorName()
def getSimulatorVersion()
def getVehicleIDs()
def getWarmUp()
def hasBeenRetrieved()
def initFilePath()
def isAutoRetrieve()
def restoreData()
def setAutoRetrieve()
def setDemandType()
def setDuration()
def setFileName()
def setHasBeenRetrieved()
def setInitialTime()
def setNbVehiclesForType()
def setProblemNet()
def setProfilingInterval()
def setReplication()
def setSimulatorName()
def setSimulatorVersion()
def storeData()

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

clear()¶

Resets data in these vehicle arrival object

getDemandType()¶

Return type:: GKTrafficDemandType

The demand type used to generate these vehicle arrival times

getDuration()¶

Return type:: GKTimeDuration

Returns the duration for this traffic arrivals.

getFileName()¶

Return type:: str

The file where the info is.

getGenerationDate()¶

Return type:: QDateTime

When these vehicle arrival times were generated.

getInitialTime()¶

Return type:: QTime

Returns the initial time for this traffic arrivals.

getIntervalForVeh(vehId)¶

Parameters:: vehId – int
Return type:: .list of uint

* getIntervalForVeh returns all Intervals of each vehicle

getNbVehiclesForType(vehId)¶

Parameters:: vehId – int
Return type:: int

It gives the number of simulation vehicles of the specified vehicle type ID that are included in the Traffic Arrivals object for its whole duration

getProblemNet()¶

Return type:: GKProblemNet

Returns the Subnetwork this traffic arrivals belongs to

getProfilingInterval()¶

Return type:: GKTimeDuration

Gets the interval to store how many vehicles of each type are generated in order to be able to have some kinf of profile information.

getReplication()¶

Return type:: GKReplication

The replication used to generate these vehicle arrival times

getSimulatorName()¶

Return type:: str

The simulator used to generate these vehicle arrival times

getSimulatorVersion()¶

Return type:: str

The simulator version used to generate these vehicle arrival times

getVehicleIDs()¶

Return type:: .list of uint

getVehicles returns the vehicles ID sorted using the modal index

getWarmUp()¶

Return type:: GKTimeDuration

getWarmUp returns the warm-up duration of this traffic arrivals

hasBeenRetrieved()¶

Return type:: bool

Returns true if the vehicle data has been retrieved from the specified file or false otherwise

See also

setHasBeenRetrieved()

initFilePath(aName)¶

Parameters:: aName – str

Sets the default path to the ATA file using ‘aName’ as the file name.

isAutoRetrieve()¶

Return type:: bool

Get the autoRetrieve attribute

restoreData()¶

Restores the vehicle data in from a file

setAutoRetrieve(value)¶

Parameters:: value – bool

Set the autoRetrieve attribute

See also

isAutoRetrieve()

setDemandType(type)¶

Parameters:: type – GKTrafficDemandType

The demand type used to generate these vehicle arrival times

setDuration(dur)¶

Parameters:: dur – GKTimeDuration

Sets the duration for this traffic arrivals.

setFileName(aFileName)¶

Parameters:: aFileName – str

The file where the info is.

setHasBeenRetrieved(value)¶

Parameters:: value – bool

Set the retrieved attribute

See also

hasBeenRetrieved()

setInitialTime(iniTime)¶

Parameters:: iniTime – QTime

Sets the initial time for this traffic arrivals.

setNbVehiclesForType(vehId, interval, nbVehicles)¶

Parameters:

vehId – int
interval – int
nbVehicles – int

It sets the number of simulation vehicles of the specified vehicle type ID and for the specified interval (from 0 to nbintervals being each interval of a duration equivalent to the ProfilingInterval

setProblemNet(aProblemNet)¶

Parameters:: aProblemNet – GKProblemNet

Sets the Subnetwork this traffic arrivals belongs to

setProfilingInterval(aDuration)¶

Parameters:: aDuration – GKTimeDuration

Sets the interval to store how many vehicles of each type are generated in order to be able to have some kinf of profile information.

setReplication(replication)¶

Parameters:: replication – GKReplication

The replication used to generate these vehicle arrival times

setSimulatorName(name)¶

Parameters:: name – str

The simulator used to generate these vehicle arrival times

setSimulatorVersion(name)¶

Parameters:: name – str

The simulator version used to generate these vehicle arrival times

storeData()¶

Stores the vehicle data in a file