traci._calibrator

  1# -*- coding: utf-8 -*-
  2# Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
  3# Copyright (C) 2008-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    _calibrator.py
 15# @author  Jakob Erdmann
 16# @date    2020-03-16
 17
 18from __future__ import absolute_import
 19from . import constants as tc
 20from .domain import Domain
 21
 22
 23class CalibratorDomain(Domain):
 24
 25    def __init__(self):
 26        Domain.__init__(self, "calibrator", tc.CMD_GET_CALIBRATOR_VARIABLE, tc.CMD_SET_CALIBRATOR_VARIABLE,
 27                        tc.CMD_SUBSCRIBE_CALIBRATOR_VARIABLE, tc.RESPONSE_SUBSCRIBE_CALIBRATOR_VARIABLE,
 28                        tc.CMD_SUBSCRIBE_CALIBRATOR_CONTEXT, tc.RESPONSE_SUBSCRIBE_CALIBRATOR_CONTEXT)
 29
 30    def getEdgeID(self, calibratorID):
 31        """getEdgeID(string) -> string
 32        Returns the edge of this calibrator
 33        """
 34        return self._getUniversal(tc.VAR_ROAD_ID, calibratorID)
 35
 36    def getLaneID(self, calibratorID):
 37        """getLaneID(string) -> string
 38        Returns the lane of this calibrator (if it applies to a single lane)
 39        """
 40        return self._getUniversal(tc.VAR_LANE_ID, calibratorID)
 41
 42    def getVehsPerHour(self, calibratorID):
 43        """getVehsPerHour(string) -> double
 44        Returns the number of vehicles per hour in the current calibration interval
 45        """
 46        return self._getUniversal(tc.VAR_VEHSPERHOUR, calibratorID)
 47
 48    def getSpeed(self, calibratorID):
 49        """getSpeed(string) -> double
 50        Returns the target speed of the current calibration interval
 51        """
 52        return self._getUniversal(tc.VAR_SPEED, calibratorID)
 53
 54    def getTypeID(self, calibratorID):
 55        """getTypeID(string) -> string
 56        Returns the type id for the current calibration interval
 57        """
 58        return self._getUniversal(tc.VAR_TYPE, calibratorID)
 59
 60    def getBegin(self, calibratorID):
 61        """getBegin(string) -> double
 62        Returns the begin time of the current calibration interval
 63        """
 64        return self._getUniversal(tc.VAR_BEGIN, calibratorID)
 65
 66    def getEnd(self, calibratorID):
 67        """getEnd(string) -> double
 68        Returns the end time of the current calibration interval
 69        """
 70        return self._getUniversal(tc.VAR_END, calibratorID)
 71
 72    def getRouteID(self, calibratorID):
 73        """getRouteID(string) -> string
 74        Returns the route id for the current calibration interval
 75        """
 76        return self._getUniversal(tc.VAR_ROUTE_ID, calibratorID)
 77
 78    def getRouteProbeID(self, calibratorID):
 79        """getRouteProbeID(string) -> string
 80        Returns the routeProbe id for this calibrator
 81        """
 82        return self._getUniversal(tc.VAR_ROUTE_PROBE, calibratorID)
 83
 84    def getVTypes(self, calibratorID):
 85        """getVTypes(string) -> tuple(string)
 86
 87        Returns a tuple of all types to which the calibrator applies (in a type filter is active)
 88        """
 89        return self._getUniversal(tc.VAR_VTYPES, calibratorID)
 90
 91    def getPassed(self, calibratorID):
 92        """getPassed(string) -> double
 93        Returns the number of passed vehicles in the current calibration interval
 94        """
 95        return self._getUniversal(tc.VAR_PASSED, calibratorID)
 96
 97    def getInserted(self, calibratorID):
 98        """getInserted(string) -> double
 99        Returns the number of inserted vehicles in the current calibration interval
100        """
101        return self._getUniversal(tc.VAR_INSERTED, calibratorID)
102
103    def getRemoved(self, calibratorID):
104        """getRemoved(string) -> double
105        Returns the number of removed vehicles in the current calibration interval
106        """
107        return self._getUniversal(tc.VAR_REMOVED, calibratorID)
108
109    def setFlow(self, calibratorID, begin, end, vehsPerHour, speed, typeID,
110                routeID, departLane="first", departSpeed="max"):
111        """setFlow(string, double, double, double, double, string, string, string, string) -> None
112        Update or add a calibrator interval
113        """
114        self._setCmd(tc.CMD_SET_FLOW, calibratorID, "tddddssss", 8, begin, end,
115                     vehsPerHour, speed, typeID, routeID, departLane, departSpeed)