traci._lanearea

  1# -*- coding: utf-8 -*-
  2# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
  3# Copyright (C) 2011-2026 German Aerospace Center (DLR) and others.
  4# This program and the accompanying materials are made available under the
  5# terms of the Eclipse Public License 2.0 which is available at
  6# https://www.eclipse.org/legal/epl-2.0/
  7# This Source Code may also be made available under the following Secondary
  8# Licenses when the conditions for such availability set forth in the Eclipse
  9# Public License 2.0 are satisfied: GNU General Public License, version 2
 10# or later which is available at
 11# https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
 12# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 13
 14# @file    _lanearea.py
 15# @author  Mario Krumnow
 16# @author  Laura Bieker
 17# @date    2011-03-16
 18
 19from __future__ import absolute_import
 20from . import constants as tc
 21from .domain import Domain
 22
 23
 24class LaneAreaDomain(Domain):
 25
 26    def __init__(self, name="lanearea", deprecatedFor=None):
 27        Domain.__init__(self, name, tc.CMD_GET_LANEAREA_VARIABLE, tc.CMD_SET_LANEAREA_VARIABLE,
 28                        tc.CMD_SUBSCRIBE_LANEAREA_VARIABLE, tc.RESPONSE_SUBSCRIBE_LANEAREA_VARIABLE,
 29                        tc.CMD_SUBSCRIBE_LANEAREA_CONTEXT, tc.RESPONSE_SUBSCRIBE_LANEAREA_CONTEXT,
 30                        {}, deprecatedFor,
 31                        subscriptionDefault=(tc.LAST_STEP_VEHICLE_NUMBER,))
 32
 33    def getJamLengthVehicle(self, detID):
 34        """getJamLengthVehicle(string) -> integer
 35
 36        Returns the jam length in vehicles within the last simulation step.
 37        """
 38        return self._getUniversal(tc.JAM_LENGTH_VEHICLE, detID)
 39
 40    def getJamLengthMeters(self, detID):
 41        """getJamLengthMeters(string) -> double
 42
 43        Returns the jam length in meters within the last simulation step.
 44        """
 45        return self._getUniversal(tc.JAM_LENGTH_METERS, detID)
 46
 47    def getLastStepMeanSpeed(self, detID):
 48        """getLastStepMeanSpeed(string) -> double
 49
 50        Returns the current mean speed in m/s of vehicles that were on the named e2.
 51        """
 52        return self._getUniversal(tc.LAST_STEP_MEAN_SPEED, detID)
 53
 54    def getLastStepVehicleIDs(self, detID):
 55        """getLastStepVehicleIDs(string) -> tuple(string)
 56
 57        Returns the tuple of ids of vehicles that were on the named detector in the last simulation step.
 58        """
 59        return self._getUniversal(tc.LAST_STEP_VEHICLE_ID_LIST, detID)
 60
 61    def getLastStepOccupancy(self, detID):
 62        """getLastStepOccupancy(string) -> double
 63
 64        Returns the percentage of space the detector was occupied by a vehicle [%]
 65        """
 66        return self._getUniversal(tc.LAST_STEP_OCCUPANCY, detID)
 67
 68    def getPosition(self, detID):
 69        """getPosition(string) -> double
 70
 71        Returns the starting position of the detector measured from the beginning of the lane in meters.
 72        """
 73        return self._getUniversal(tc.VAR_POSITION, detID)
 74
 75    def getLaneID(self, detID):
 76        """getLaneID(string) -> string
 77
 78        Returns the id of the lane the detector is on.
 79        """
 80        return self._getUniversal(tc.VAR_LANE_ID, detID)
 81
 82    def getLength(self, detID):
 83        """getLength(string) -> double
 84
 85        Returns the length of the detector
 86        """
 87        return self._getUniversal(tc.VAR_LENGTH, detID)
 88
 89    def getLastStepVehicleNumber(self, detID):
 90        """getLastStepVehicleNumber(string) -> integer
 91
 92        Returns the number of vehicles that were on the named detector within the last simulation step.
 93        """
 94        return self._getUniversal(tc.LAST_STEP_VEHICLE_NUMBER, detID)
 95
 96    def getLastStepHaltingNumber(self, detID):
 97        """getLastStepHaltingNumber(string) -> integer
 98
 99        Returns the number of vehicles which were halting during the last time step.
100        """
101        return self._getUniversal(tc.LAST_STEP_VEHICLE_HALTING_NUMBER, detID)
102
103    def getIntervalOccupancy(self, detID):
104        """getIntervalOccupancy(string) -> double
105
106        Returns the mean occupancy during the current interval
107        """
108        return self._getUniversal(tc.VAR_INTERVAL_OCCUPANCY, detID)
109
110    def getIntervalMeanSpeed(self, detID):
111        """getIntervalMeanSpeed(string) -> double
112
113        Returns the mean speed during the current interval
114        """
115        return self._getUniversal(tc.VAR_INTERVAL_SPEED, detID)
116
117    def getIntervalMeanTimeLoss(self, detID):
118        """getIntervalMeanTimeLoss(string) -> double
119
120        Returns the mean timeLoss per vehicle during the current interval
121        """
122        return self._getUniversal(tc.VAR_INTERVAL_TIMELOSS, detID)
123
124    def getIntervalMaxJamLengthInMeters(self, detID):
125        """getIntervalMaxJamLengthInMeters(string) -> double
126
127        Returns the max jam length during the current interval
128        """
129        return self._getUniversal(tc.VAR_INTERVAL_MAX_JAM_LENGTH_METERS, detID)
130
131    def getIntervalVehicleNumber(self, detID):
132        """getIntervalVehicleNumber(string) -> int
133
134        Returns the number of seen vehicles during the current interval
135        """
136        return self._getUniversal(tc.VAR_INTERVAL_NUMBER, detID)
137
138    def getLastIntervalOccupancy(self, detID):
139        """getLastIntervalOccupancy(string) -> double
140
141        Returns the mean occupancy during the previous interval
142        """
143        return self._getUniversal(tc.VAR_LAST_INTERVAL_OCCUPANCY, detID)
144
145    def getLastIntervalMeanSpeed(self, detID):
146        """getLastIntervalMeanSpeed(string) -> double
147
148        Returns the mean speed during the previous interval
149        """
150        return self._getUniversal(tc.VAR_LAST_INTERVAL_SPEED, detID)
151
152    def getLastIntervalMeanTimeLoss(self, detID):
153        """getLastIntervalMeanTimeLoss(string) -> double
154
155        Returns the mean timeLoss per vehicle during the previous interval
156        """
157        return self._getUniversal(tc.VAR_LAST_INTERVAL_TIMELOSS, detID)
158
159    def getLastIntervalMaxJamLengthInMeters(self, detID):
160        """getLastIntervalMaxJamLengthInMeters(string) -> double
161
162        Returns the max jam length during the previous interval
163        """
164        return self._getUniversal(tc.VAR_LAST_INTERVAL_MAX_JAM_LENGTH_METERS, detID)
165
166    def getLastIntervalVehicleNumber(self, detID):
167        """getLastIntervalVehicleNumber(string) -> int
168
169        Returns the number of seen vehicles during the previous interval
170        """
171        return self._getUniversal(tc.VAR_LAST_INTERVAL_NUMBER, detID)
172
173    def overrideVehicleNumber(self, detID, vehNum):
174        """overrideVehicleNumber(string, integer) -> None
175        Persistently overrides the number of vehicles on the detector.
176        Setting a negative value resets the override.
177        """
178        return self._setCmd(tc.VAR_VIRTUAL_DETECTION, detID, "i", vehNum)