Edge Value Retrieval

Command 0xaa: Get Edge Variable#

ubyte string
Variable Edge ID

Asks for the value of a certain variable of the named edge.

The following variable values can be retrieved, the type of the return value is also shown in the table.

Overview Retrievable Edge Variables

Variable ValueType Description Python Method
id list (0x00) stringList Returns a list of ids of all edges within the scenario (the given Edge ID is ignored) getIDList
count (0x01) int Returns the number of edges within the scenario (the given Edge ID is ignored) getIDCount
lane number (0x52) int Returns the number of lanes for the given edge ID getLaneNumber
street name (0x1b) string Returns the street name for the given edge ID getStreetName
current travel time (0x5a) double Returns the current travel time (length/mean speed).
Note: This definition of travel time has to be reverified.
getTraveltime
CO2 emissions (id 0x60) double Sum of CO2 emissions on this edge in mg/s during this time step. getCO2Emission
CO emissions (id 0x61) double Sum of CO emissions on this edge in mg/s during this time step. getCOEmission
HC emissions (id 0x62) double Sum of HC emissions on this edge in mg/s during this time step. getHCEmission
PMx emissions (id 0x63) double Sum of PMx emissions on this edge in mg/s during this time step. getPMxEmission
NOx emissions (id 0x64) double Sum of NOx emissions on this edge in mg/s during this time step. getNOxEmission
fuel consumption (id 0x65) double Sum of fuel consumption on this edge in mg/s during this time step. getFuelConsumption
noise emission (id 0x66) double Sum of noise generated on this edge in dBA. getNoiseEmission
electricity consumption (id 0x71) double Sum of electricity consumption on this edge in kWh during this time step. getElectricityConsumption
last step vehicle number (0x10) int The number of vehicles on this edge within the last time step. getLastStepVehicleNumber
last step mean speed (0x11) double Returns the mean speed of vehicles that were on the named edge within the last simulation step [m/s] getLastStepMeanSpeed
last step vehicle ids (0x12) stringList Returns the list of ids of vehicles that were on the named edge in the last simulation step. The order is from rightmost to leftmost lane and downstream for each lane. getLastStepVehicleIDs
last step occupancy (0x13) double Returns the percentage of time the edge was occupied by a vehicle [%] getLastStepOccupancy
last step mean vehicle length (0x15) double The mean length of vehicles which were on the edge in the last step [m] getLastStepLength
waiting time (0x7a) double Returns the sum of the waiting times for all vehicles on the edge [s] getWaitingTime
last step person ids (0x1a) stringList Returns the list of ids of persons that were on the named edge in the last simulation step getLastStepPersonIDs
last step halting number (0x14) int Returns the total number of halting vehicles for the last time step on the given edge. A speed of less than 0.1 m/s is considered a halt. getLastStepHaltingNumber
angle (0x43) double Returns the heading of the straight line segment formed by the edge at the given position. getAngle

Response 0xba: Edge Variable#

ubyte string ubyte <return_type>
Variable Edge ID Return type of the variable <VARIABLE_VALUE>

The respond to a "Command Get Edge Variable".

Extended retrieval messages#

Some further messages require additional parameters.

Overview Extended Variables Retrieval

Variable Request ValueType Response ValueType Description Python Method
edge travel time information (0x58) time (double) double Returns the edge travel time for the given time as stored in the global container. If such a value does not exist, -1 is returned. getAdaptedTraveltime
edge effort information (0x59) time (double) double Returns the edge effort for the given time as stored in the global container. If such a value does not exist, -1 is returned. getEffort