traci._vehicletype | index /home/delphi/gcc/sumo/tools/traci/_vehicletype.py

`# -*- coding: utf-8 -*-
# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
# Copyright (C) 2008-2022 German Aerospace Center (DLR) and others.
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# https://www.eclipse.org/legal/epl-2.0/
# This Source Code may also be made available under the following Secondary
# Licenses when the conditions for such availability set forth in the Eclipse
# Public License 2.0 are satisfied: GNU General Public License, version 2
# or later which is available at
# https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later`

Modules
`` |  |
traci.exceptions | traci.constants |  |

Classes
`` |  | traci.domain.Domain(builtins.object) VTypeDomain VehicleTypeDomain
class VTypeDomain(traci.domain.Domain)
`` | `VTypeDomain(name, cmdGetID, cmdSetID, subscribeID, subscribeResponseID, contextID, contextResponseID, retValFunc=None, deprecatedFor=None, subscriptionDefault=(0,)) This class contains all functions which are common to the vehicletype, vehicle and person domain`
| Method resolution order: VTypeDomain traci.domain.Domain builtins.object Methods defined here: __init__(self, name, cmdGetID, cmdSetID, subscribeID, subscribeResponseID, contextID, contextResponseID, retValFunc=None, deprecatedFor=None, subscriptionDefault=(0,)) `Initialize self. See help(type(self)) for accurate signature.` getAccel(self, typeID) `getAccel(string) -> double Returns the maximum acceleration in m/s^2 of vehicles of this type.` getActionStepLength(self, typeID) `getActionStepLength(string) -> double Returns the action step length for vehicles of this type.` getApparentDecel(self, typeID) `getApparentDecel(string) -> double Returns the apparent deceleration in m/s^2 of vehicles of this type.` getColor(self, typeID) `getColor(string) -> (integer, integer, integer, integer) Returns the color of this type.` getDecel(self, typeID) `getDecel(string) -> double Returns the maximal comfortable deceleration in m/s^2 of vehicles of this type.` getEmergencyDecel(self, typeID) `getEmergencyDecel(string) -> double Returns the maximal physically possible deceleration in m/s^2 of vehicles of this type.` getEmissionClass(self, typeID) `getEmissionClass(string) -> string Returns the emission class of vehicles of this type.` getHeight(self, typeID) `getHeight(string) -> double Returns the height in m of vehicles of this type.` getImperfection(self, typeID) `getImperfection(string) -> double Returns the driver's imperfection for vehicles of this type.` getLateralAlignment(self, vehID) `getLateralAlignment(string) -> string Returns The preferred lateral alignment of the type` getLength(self, typeID) `getLength(string) -> double Returns the length in m of the vehicles of this type.` getMaxSpeed(self, typeID) `getMaxSpeed(string) -> double Returns the maximum speed in m/s of vehicles of this type.` getMaxSpeedLat(self, vehID) `getMaxSpeedLat(string) -> double Returns the maximum lateral speed in m/s of this type.` getMinGap(self, typeID) `getMinGap(string) -> double Returns the offset (gap to front vehicle if halting) of vehicles of this type.` getMinGapLat(self, vehID) `getMinGapLat(string) -> double Returns The desired lateral gap of this type at 50km/h in m` getPersonCapacity(self, typeID) `getPersonCapacity(string) -> int Returns the person capacity of this type` getShapeClass(self, typeID) `getShapeClass(string) -> string Returns the shape class of vehicles of this type.` getSpeedDeviation(self, typeID) `getSpeedDeviation(string) -> double Returns the maximum speed deviation of vehicles of this type.` getSpeedFactor(self, typeID) `getSpeedFactor(string) -> double Returns the speed factor of vehicles of this type.` getTau(self, typeID) `getTau(string) -> double Returns the driver's desired headway in s for vehicles of this type.` getVehicleClass(self, typeID) `getVehicleClass(string) -> string Returns the class of vehicles of this type.` getWidth(self, typeID) `getWidth(string) -> double Returns the width in m of vehicles of this type.` setAccel(self, typeID, accel) `setAccel(string, double) -> None Sets the maximum acceleration in m/s^2 of vehicles of this type.` setActionStepLength(self, typeID, actionStepLength, resetActionOffset=True) `setActionStepLength(string, double, bool) -> None Sets the action step length for vehicles of this type. If resetActionOffset == True (default), the next action point is scheduled immediately for all vehicles of the type. If resetActionOffset == False, the interval between the last and the next action point is updated to match the given value for all vehicles of the type, or if the latter is smaller than the time since the last action point, the next action follows immediately.` setApparentDecel(self, typeID, decel) `setApparentDecel(string, double) -> None Sets the apparent deceleration in m/s^2 of vehicles of this type.` setColor(self, typeID, color) `setColor(string, (integer, integer, integer, integer)) -> None Sets the color of this type.` setDecel(self, typeID, decel) `setDecel(string, double) -> None Sets the maximal comfortable deceleration in m/s^2 of vehicles of this type.` setEmergencyDecel(self, typeID, decel) `setEmergencyDecel(string, double) -> None Sets the maximal physically possible deceleration in m/s^2 of vehicles of this type.` setEmissionClass(self, typeID, clazz) `setEmissionClass(string, string) -> None Sets the emission class of vehicles of this type.` setHeight(self, typeID, height) `setHeight(string, double) -> None Sets the height in m of vehicles of this type.` setImperfection(self, typeID, imperfection) `setImperfection(string, double) -> None Sets the driver imperfection of vehicles of this type.` setLateralAlignment(self, typeID, latAlignment) `setLateralAlignment(string, string) -> None Sets the preferred lateral alignment of this type.` setLength(self, typeID, length) `setLength(string, double) -> None Sets the length in m of the vehicles of this type.` setMaxSpeed(self, typeID, speed) `setMaxSpeed(string, double) -> None Sets the maximum speed in m/s of vehicles of this type.` setMaxSpeedLat(self, typeID, speed) `setMaxSpeedLat(string, double) -> None Sets the maximum lateral speed of this type.` setMinGap(self, typeID, minGap) `setMinGap(string, double) -> None Sets the offset (gap to front vehicle if halting) of vehicles of this type.` setMinGapLat(self, typeID, minGapLat) `setMinGapLat(string, double) -> None Sets the minimum lateral gap at 50km/h of this type.` setShapeClass(self, typeID, clazz) `setShapeClass(string, string) -> None Sets the shape class of vehicles of this type.` setSpeedFactor(self, typeID, factor) `setSpeedFactor(string, double) -> None Sets the speed factor of vehicles of this type.` setTau(self, typeID, tau) `setTau(string, double) -> None Sets the driver's tau-parameter (reaction time or anticipation time depending on the car-following model) in s for vehicles of this type.` setVehicleClass(self, typeID, clazz) `setVehicleClass(string, string) -> None Sets the class of vehicles of this type.` setWidth(self, typeID, width) `setWidth(string, double) -> None Sets the width in m of vehicles of this type.` Methods inherited from traci.domain.Domain: getAllContextSubscriptionResults(self) getAllSubscriptionResults(self) `getAllSubscriptionResults() -> dict(string: dict(integer: <value_type>)) Returns the subscription results for the last time step and all objects of the domain. It is not possible to retrieve older subscription results than the ones from the last time step.` getContextSubscriptionResults(self, objectID) getIDCount(self) `getIDCount() -> integer Returns the number of currently loaded objects.` getIDList(self) `getIDList() -> list(string) Returns a list of all objects in the network.` getParameter(self, objID, param) `getParameter(string, string) -> string Returns the value of the given parameter for the given objID` getParameterWithKey(self, objID, param) `getParameterWithKey(string, string) -> (string, string) Returns the (key, value) tuple of the given parameter for the given objID` getSubscriptionResults(self, objectID) `getSubscriptionResults(string) -> dict(integer: <value_type>) Returns the subscription results for the last time step and the given object. If the object 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.` setParameter(self, objID, param, value) `setParameter(string, string, string) -> None Sets the value of the given parameter to value for the given objID` subscribe(self, objectID, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None) `subscribe(string, list(integer), double, double, map(string->tuple)) -> None Subscribe to one or more object values for the given interval.` subscribeContext(self, objectID, domain, dist, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None) `subscribeContext(string, int, double, list(integer), double, double) -> None Subscribe to objects of the given domain (specified as domain=traci.constants.CMD_GET_<DOMAIN>_VARIABLE), which are closer than dist to the object specified by objectID.` subscribeParameterWithKey(self, objID, key, begin=-1073741824.0, end=-1073741824.0) `subscribeParameterWithKey(string, string) -> None Subscribe for a generic parameter with the given key.` unsubscribe(self, objectID) `unsubscribe(string) -> None Unsubscribe from receiving object values.` unsubscribeContext(self, objectID, domain, dist) Data descriptors inherited from traci.domain.Domain: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class VehicleTypeDomain(VTypeDomain)
`` | `This class contains all functions which are specific to the vehicletype domain`
| Method resolution order: VehicleTypeDomain VTypeDomain traci.domain.Domain builtins.object Methods defined here: __init__(self) `Initialize self. See help(type(self)) for accurate signature.` copy(self, origTypeID, newTypeID) `copy(string, string) -> None Duplicates the vType with ID origTypeID. The newly created vType is assigned the ID newTypeID` getScale(self, typeID) `getScale(string) -> double Returns the traffic scaling factor` setScale(self, typeID, value) `setScale(string, double) -> None Sets the traffic scaling factor` setSpeedDeviation(self, typeID, deviation) `setSpeedDeviation(string, double) -> None Sets the maximum speed deviation of vehicles of this type.` Methods inherited from VTypeDomain: getAccel(self, typeID) `getAccel(string) -> double Returns the maximum acceleration in m/s^2 of vehicles of this type.` getActionStepLength(self, typeID) `getActionStepLength(string) -> double Returns the action step length for vehicles of this type.` getApparentDecel(self, typeID) `getApparentDecel(string) -> double Returns the apparent deceleration in m/s^2 of vehicles of this type.` getColor(self, typeID) `getColor(string) -> (integer, integer, integer, integer) Returns the color of this type.` getDecel(self, typeID) `getDecel(string) -> double Returns the maximal comfortable deceleration in m/s^2 of vehicles of this type.` getEmergencyDecel(self, typeID) `getEmergencyDecel(string) -> double Returns the maximal physically possible deceleration in m/s^2 of vehicles of this type.` getEmissionClass(self, typeID) `getEmissionClass(string) -> string Returns the emission class of vehicles of this type.` getHeight(self, typeID) `getHeight(string) -> double Returns the height in m of vehicles of this type.` getImperfection(self, typeID) `getImperfection(string) -> double Returns the driver's imperfection for vehicles of this type.` getLateralAlignment(self, vehID) `getLateralAlignment(string) -> string Returns The preferred lateral alignment of the type` getLength(self, typeID) `getLength(string) -> double Returns the length in m of the vehicles of this type.` getMaxSpeed(self, typeID) `getMaxSpeed(string) -> double Returns the maximum speed in m/s of vehicles of this type.` getMaxSpeedLat(self, vehID) `getMaxSpeedLat(string) -> double Returns the maximum lateral speed in m/s of this type.` getMinGap(self, typeID) `getMinGap(string) -> double Returns the offset (gap to front vehicle if halting) of vehicles of this type.` getMinGapLat(self, vehID) `getMinGapLat(string) -> double Returns The desired lateral gap of this type at 50km/h in m` getPersonCapacity(self, typeID) `getPersonCapacity(string) -> int Returns the person capacity of this type` getShapeClass(self, typeID) `getShapeClass(string) -> string Returns the shape class of vehicles of this type.` getSpeedDeviation(self, typeID) `getSpeedDeviation(string) -> double Returns the maximum speed deviation of vehicles of this type.` getSpeedFactor(self, typeID) `getSpeedFactor(string) -> double Returns the speed factor of vehicles of this type.` getTau(self, typeID) `getTau(string) -> double Returns the driver's desired headway in s for vehicles of this type.` getVehicleClass(self, typeID) `getVehicleClass(string) -> string Returns the class of vehicles of this type.` getWidth(self, typeID) `getWidth(string) -> double Returns the width in m of vehicles of this type.` setAccel(self, typeID, accel) `setAccel(string, double) -> None Sets the maximum acceleration in m/s^2 of vehicles of this type.` setActionStepLength(self, typeID, actionStepLength, resetActionOffset=True) `setActionStepLength(string, double, bool) -> None Sets the action step length for vehicles of this type. If resetActionOffset == True (default), the next action point is scheduled immediately for all vehicles of the type. If resetActionOffset == False, the interval between the last and the next action point is updated to match the given value for all vehicles of the type, or if the latter is smaller than the time since the last action point, the next action follows immediately.` setApparentDecel(self, typeID, decel) `setApparentDecel(string, double) -> None Sets the apparent deceleration in m/s^2 of vehicles of this type.` setColor(self, typeID, color) `setColor(string, (integer, integer, integer, integer)) -> None Sets the color of this type.` setDecel(self, typeID, decel) `setDecel(string, double) -> None Sets the maximal comfortable deceleration in m/s^2 of vehicles of this type.` setEmergencyDecel(self, typeID, decel) `setEmergencyDecel(string, double) -> None Sets the maximal physically possible deceleration in m/s^2 of vehicles of this type.` setEmissionClass(self, typeID, clazz) `setEmissionClass(string, string) -> None Sets the emission class of vehicles of this type.` setHeight(self, typeID, height) `setHeight(string, double) -> None Sets the height in m of vehicles of this type.` setImperfection(self, typeID, imperfection) `setImperfection(string, double) -> None Sets the driver imperfection of vehicles of this type.` setLateralAlignment(self, typeID, latAlignment) `setLateralAlignment(string, string) -> None Sets the preferred lateral alignment of this type.` setLength(self, typeID, length) `setLength(string, double) -> None Sets the length in m of the vehicles of this type.` setMaxSpeed(self, typeID, speed) `setMaxSpeed(string, double) -> None Sets the maximum speed in m/s of vehicles of this type.` setMaxSpeedLat(self, typeID, speed) `setMaxSpeedLat(string, double) -> None Sets the maximum lateral speed of this type.` setMinGap(self, typeID, minGap) `setMinGap(string, double) -> None Sets the offset (gap to front vehicle if halting) of vehicles of this type.` setMinGapLat(self, typeID, minGapLat) `setMinGapLat(string, double) -> None Sets the minimum lateral gap at 50km/h of this type.` setShapeClass(self, typeID, clazz) `setShapeClass(string, string) -> None Sets the shape class of vehicles of this type.` setSpeedFactor(self, typeID, factor) `setSpeedFactor(string, double) -> None Sets the speed factor of vehicles of this type.` setTau(self, typeID, tau) `setTau(string, double) -> None Sets the driver's tau-parameter (reaction time or anticipation time depending on the car-following model) in s for vehicles of this type.` setVehicleClass(self, typeID, clazz) `setVehicleClass(string, string) -> None Sets the class of vehicles of this type.` setWidth(self, typeID, width) `setWidth(string, double) -> None Sets the width in m of vehicles of this type.` Methods inherited from traci.domain.Domain: getAllContextSubscriptionResults(self) getAllSubscriptionResults(self) `getAllSubscriptionResults() -> dict(string: dict(integer: <value_type>)) Returns the subscription results for the last time step and all objects of the domain. It is not possible to retrieve older subscription results than the ones from the last time step.` getContextSubscriptionResults(self, objectID) getIDCount(self) `getIDCount() -> integer Returns the number of currently loaded objects.` getIDList(self) `getIDList() -> list(string) Returns a list of all objects in the network.` getParameter(self, objID, param) `getParameter(string, string) -> string Returns the value of the given parameter for the given objID` getParameterWithKey(self, objID, param) `getParameterWithKey(string, string) -> (string, string) Returns the (key, value) tuple of the given parameter for the given objID` getSubscriptionResults(self, objectID) `getSubscriptionResults(string) -> dict(integer: <value_type>) Returns the subscription results for the last time step and the given object. If the object 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.` setParameter(self, objID, param, value) `setParameter(string, string, string) -> None Sets the value of the given parameter to value for the given objID` subscribe(self, objectID, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None) `subscribe(string, list(integer), double, double, map(string->tuple)) -> None Subscribe to one or more object values for the given interval.` subscribeContext(self, objectID, domain, dist, varIDs=None, begin=-1073741824.0, end=-1073741824.0, parameters=None) `subscribeContext(string, int, double, list(integer), double, double) -> None Subscribe to objects of the given domain (specified as domain=traci.constants.CMD_GET_<DOMAIN>_VARIABLE), which are closer than dist to the object specified by objectID.` subscribeParameterWithKey(self, objID, key, begin=-1073741824.0, end=-1073741824.0) `subscribeParameterWithKey(string, string) -> None Subscribe for a generic parameter with the given key.` unsubscribe(self, objectID) `unsubscribe(string) -> None Unsubscribe from receiving object values.` unsubscribeContext(self, objectID, domain, dist) Data descriptors inherited from traci.domain.Domain: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`

Data
`` |  | absolute_import = _Feature((2, 5, 0, 'alpha', 1), (3, 0, 0, 'alpha', 0), 262144)