traci.vehicle
index
/tmp/buildd/sumo-0.21.0+dfsg/tools/traci/vehicle.py

@file    vehicle.py
@author  Michael Behrisch
@author  Lena Kalleske
@author  Mario Krumnow
@author  Lena Kalleske
@author  Jakob Erdmann
@author  Laura Bieker
@author  Daniel Krajzewicz
@date    2011-03-09
@version $Id: vehicle.py 16565 2014-06-10 09:00:08Z namdre $
 
Python implementation of the TraCI interface.
 
SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
Copyright (C) 2011-2014 DLR (http://www.dlr.de/) and contributors
 
This file is part of SUMO.
SUMO is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

 
Modules
       
struct
traci.constants
traci

 
Functions
       
add(vehID, routeID, depart=-2, pos=0, speed=0, lane=0, typeID='DEFAULT_VEHTYPE')
addFull(vehID, routeID, typeID='DEFAULT_VEHTYPE', depart=None, departLane='0', departPos='base', departSpeed='0', arrivalLane='current', arrivalPos='max', arrivalSpeed='current', fromTaz='', toTaz='', line='', personCapacity=0, personNumber=0)
changeLane(vehID, laneIndex, duration)
changeTarget(vehID, edgeID)
getAccel(vehID)
getAccel(string) -> double
 
Returns the maximum acceleration possibility in m/s^2 of this vehicle.
getAdaptedTraveltime(vehID, time, edgeID)
getAdaptedTraveltime(string, double, string) -> double
 
.
getAllowedSpeed(vehID)
getAllowedSpeed(string) -> double
 
Returns the maximum allowed speed on the current lane regarding speed factor in m/s for this vehicle.
getAngle(vehID)
getAngle(string) -> double
 
Returns the angle in degrees of the named vehicle within the last step.
getBestLanes(vehID)
getBestLanes(string) -> 
 
Information about the wish to use subsequent edges' lanes.
getCO2Emission(vehID)
getCO2Emission(string) -> double
 
Returns the CO2 emission in mg for the last time step.
getCOEmission(vehID)
getCOEmission(string) -> double
 
Returns the CO emission in mg for the last time step.
getColor(vehID)
getColor(string) -> (integer, integer, integer, integer)
 
Returns the vehicle's rgba color.
getContextSubscriptionResults(vehID=None)
getDecel(vehID)
getDecel(string) -> double
 
Returns the maximum deceleration possibility in m/s^2 of this vehicle.
getDistance(vehID)
getDistance(string) -> double
 
Returns the distance to the starting point like an odometer
getDrivingDistance(vehID, edgeID, pos, laneID=0)
getDrivingDistance(string, string, double, integer) -> double
 
.
getDrivingDistance2D(vehID, x, y)
getDrivingDistance2D(string, double, double) -> integer
 
.
getEffort(vehID, time, edgeID)
getEffort(string, double, string) -> double
 
.
getEmissionClass(vehID)
getEmissionClass(string) -> string
 
Returns the emission class of this vehicle.
getFuelConsumption(vehID)
getFuelConsumption(string) -> double
 
Returns the fuel consumption in ml for the last time step.
getHCEmission(vehID)
getHCEmission(string) -> double
 
Returns the HC emission in mg for the last time step.
getIDCount()
getIDCount() -> integer
 
Returns the number of vehicle in the network.
getIDList()
getIDList() -> list(string)
 
Returns a list of ids of all vehicles currently running within the scenario.
getImperfection(vehID)
getImperfection(string) -> double
 
.
getLaneID(vehID)
getLaneID(string) -> string
 
Returns the id of the lane the named vehicle was at within the last step.
getLaneIndex(vehID)
getLaneIndex(string) -> integer
 
Returns the index of the lane the named vehicle was at within the last step.
getLanePosition(vehID)
getLanePosition(string) -> double
 
The position of the vehicle along the lane measured in m.
getLeader(vehID, dist=0.0)
getLeader(string, double) -> (string, double)
 
Return the leading vehicle id together with the distance.
The dist parameter defines the maximum lookahead, 0 calculates a lookahead from the brake gap.
getLength(vehID)
getLength(string) -> double
 
Returns the length in m of the given vehicle.
getMaxSpeed(vehID)
getMaxSpeed(string) -> double
 
Returns the maximum speed in m/s of this vehicle.
getMinGap(vehID)
getMinGap(string) -> double
 
Returns the offset (gap to front vehicle if halting) of this vehicle.
getNOxEmission(vehID)
getNOxEmission(string) -> double
 
Returns the NOx emission in mg for the last time step.
getNoiseEmission(vehID)
getNoiseEmission(string) -> double
 
Returns the noise emission in db for the last time step.
getPMxEmission(vehID)
getPMxEmission(string) -> double
 
Returns the particular matter emission in mg for the last time step.
getPersonNumber(vehID)
getPersonNumber(string) -> integer
 
.
getPosition(vehID)
getPosition(string) -> (double, double)
 
Returns the position of the named vehicle within the last step [m,m].
getRoadID(vehID)
getRoadID(string) -> string
 
Returns the id of the edge the named vehicle was at within the last step.
getRoute(vehID)
getRoute(string) -> list(string)
 
Returns the ids of the edges the vehicle's route is made of.
getRouteID(vehID)
getRouteID(string) -> string
 
Returns the id of the route of the named vehicle.
getShapeClass(vehID)
getShapeClass(string) -> string
 
Returns the shape class of this vehicle.
getSignals(vehID)
getSignals(string) -> integer
 
Returns an integer encoding the state of a vehicle's signals.
getSpeed(vehID)
getSpeed(string) -> double
 
Returns the speed in m/s of the named vehicle within the last step.
getSpeedDeviation(vehID)
getSpeedDeviation(string) -> double
 
Returns the maximum speed deviation of the vehicle type.
getSpeedFactor(vehID)
getSpeedFactor(string) -> double
 
Returns the chosen speed factor for this vehicle.
getSpeedWithoutTraCI(vehID)
getSpeedWithoutTraCI(string) -> double
 
.
getSubscriptionResults(vehID=None)
getSubscriptionResults(string) -> dict(integer: <value_type>)
 
Returns the subscription results for the last time step and the given vehicle.
If no vehicle id is given, all subscription results are returned in a dict.
If the vehicle id is unknown or the subscription did for any reason return no data,
'None' is returned.
It is not possible to retrieve older subscription results than the ones
from the last time step.
getTau(vehID)
getTau(string) -> double
 
Returns the driver's reaction time in s for this vehicle.
getTypeID(vehID)
getTypeID(string) -> string
 
Returns the id of the type of the named vehicle.
getVehicleClass(vehID)
getVehicleClass(string) -> string
 
Returns the vehicle class of this vehicle.
getWaitingTime(vehID)
getWaitingTime() -> double
The waiting time of a vehicle is defined as the time (in seconds) spent with a
speed below 0.1m/s since the last time it was faster than 0.1m/s.
(basically, the waiting time of a vehicle is reset to 0 every time it moves).
getWidth(vehID)
getWidth(string) -> double
 
Returns the width in m of this vehicle.
isRouteValid(vehID)
moveTo(vehID, laneID, pos)
moveToVTD(vehID, edgeID, lane, x, y)
remove(vehID, reason=3)
Remove vehicle with the given ID for the give reason. 
Reasons are defined in module constants and start with REMOVE_
rerouteEffort(vehID)
rerouteTraveltime(vehID, currentTravelTimes=True)
rerouteTraveltime(string, bool) -> None Reroutes a vehicle. If
currentTravelTimes is True (default) then the current traveltime of the
edges is loaded and used for rerouting. If currentTravelTimes is False,
travel times loaded from a weight file are used. In the absence of loaded
weights, the minimum travel time is used (speed limit).
setAccel(vehID, accel)
setAccel(string, double) -> None
 
Sets the maximum acceleration in m/s^2 for this vehicle.
setAdaptedTraveltime(vehID, begTime, endTime, edgeID, time)
setAdaptedTraveltime(string, double, string, double) -> None
 
.
setColor(vehID, color)
setColor(string, (integer, integer, integer, integer))
sets color for vehicle with the given ID.
i.e. (255,0,0,0) for the color red. 
The fourth integer (alpha) is currently ignored
setDecel(vehID, decel)
setDecel(string, double) -> None
 
Sets the maximum deceleration in m/s^2 for this vehicle.
setEffort(vehID, begTime, endTime, edgeID, effort)
setEffort(string, double, string, double) -> None
 
.
setEmissionClass(vehID, clazz)
setEmissionClass(string, string) -> None
 
Sets the emission class for this vehicle.
setImperfection(vehID, imperfection)
setImperfection(string, double) -> None
 
.
setLaneChangeMode(vehID, lcm)
setLaneChangeMode(string, integer) -> None
 
Sets the vehicle's lane change mode as a bitset.
setLength(vehID, length)
setLength(string, double) -> None
 
Sets the length in m for the given vehicle.
setMaxSpeed(vehID, speed)
setMaxSpeed(string, double) -> None
 
Sets the maximum speed in m/s for this vehicle.
setMinGap(vehID, minGap)
setMinGap(string, double) -> None
 
Sets the offset (gap to front vehicle if halting) for this vehicle.
setRoute(vehID, edgeList)
setRoute(string, list) ->  None
 
changes the vehicle route to given edges list.
The first edge in the list has to be the one that the vehicle is at at the moment.
 
example usage:
setRoute('1', ['1', '2', '4', '6', '7'])
 
this changes route for vehicle id 1 to edges 1-2-4-6-7
setRouteID(vehID, routeID)
setRouteID(string, string) -> None
 
Sets the id of the route for the named vehicle.
setShapeClass(vehID, clazz)
setShapeClass(string, string) -> None
 
Sets the shape class for this vehicle.
setSignals(vehID, signals)
setSignals(string, integer) -> None
 
Sets an integer encoding the state of the vehicle's signals.
setSpeed(vehID, speed)
setSpeed(string, double) -> None
 
Sets the speed in m/s for the named vehicle within the last step.
setSpeedDeviation(vehID, deviation)
setSpeedDeviation(string, double) -> None
 
Sets the maximum speed deviation for this vehicle.
setSpeedFactor(vehID, factor)
setSpeedFactor(string, double) -> None
 
.
setStop(vehID, edgeID, pos=1.0, laneIndex=0, duration=2147483647, flags=0)
setTau(vehID, tau)
setTau(string, double) -> None
 
Sets the driver's reaction time in s for this vehicle.
setType(vehID, typeID)
setType(string, string) -> None
 
Sets the id of the type for the named vehicle.
setVehicleClass(vehID, clazz)
setVehicleClass(string, string) -> None
 
Sets the vehicle class for this vehicle.
setWidth(vehID, width)
setWidth(string, double) -> None
 
Sets the width in m for this vehicle.
slowDown(vehID, speed, duration)
subscribe(vehID, varIDs=(80, 86), begin=0, end=2147483647)
subscribe(string, list(integer), double, double) -> None
 
Subscribe to one or more vehicle values for the given interval.
subscribeContext(vehID, domain, dist, varIDs=(80, 86), begin=0, end=2147483647)
subscribeLeader(vehID, dist=0.0, begin=0, end=2147483647)
subscribeLeader(string, double) -> None
 
Subscribe for the leading vehicle id together with the distance.
The dist parameter defines the maximum lookahead, 0 calculates a lookahead from the brake gap.

 
Data
        DEPART_MAX = -3
DEPART_NOW = -2
DEPART_TRIGGERED = -1
STOP_DEFAULT = 0
STOP_PARKING = 1
STOP_TRIGGERED = 2
subscriptionResults = <{}, {}>