Eclipse SUMO - Simulation of Urban MObility
LaneArea.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3// Copyright (C) 2017-2023 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/****************************************************************************/
18// C++ TraCI client API implementation
19/****************************************************************************/
20#pragma once
21#include <string>
22#include <vector>
23#include <libsumo/TraCIDefs.h>
24
25
26// ===========================================================================
27// class declarations
28// ===========================================================================
29#ifndef LIBTRACI
30class MSE2Collector;
31#endif
32
33
34// ===========================================================================
35// class definitions
36// ===========================================================================
41namespace LIBSUMO_NAMESPACE {
42class LaneArea {
43public:
44 static int getJamLengthVehicle(const std::string& detID);
45 static double getJamLengthMeters(const std::string& detID);
46 static double getLastStepMeanSpeed(const std::string& detID);
47 static std::vector<std::string> getLastStepVehicleIDs(const std::string& detID);
48 static double getLastStepOccupancy(const std::string& detID);
49 static double getPosition(const std::string& detID);
50 static std::string getLaneID(const std::string& detID);
51 static double getLength(const std::string& detID);
52 static int getLastStepVehicleNumber(const std::string& detID);
53 static int getLastStepHaltingNumber(const std::string& detID);
54
55 static double getIntervalOccupancy(const std::string& detID);
56 static double getIntervalMeanSpeed(const std::string& detID);
57 static double getIntervalMaxJamLengthInMeters(const std::string& detID);
58 static int getIntervalVehicleNumber(const std::string& detID);
59
60 static double getLastIntervalOccupancy(const std::string& detID);
61 static double getLastIntervalMeanSpeed(const std::string& detID);
62 static double getLastIntervalMaxJamLengthInMeters(const std::string& detID);
63 static int getLastIntervalVehicleNumber(const std::string& detID);
64
65 static void overrideVehicleNumber(const std::string& detID, int num);
66
69
70#ifndef LIBTRACI
71#ifndef SWIG
75 static NamedRTree* getTree();
76 static void cleanup();
77
82 static void storeShape(const std::string& id, PositionVector& shape);
83
84 static std::shared_ptr<VariableWrapper> makeWrapper();
85
86 static bool handleVariable(const std::string& objID, const int variable, VariableWrapper* wrapper, tcpip::Storage* paramData);
87
88private:
89 static MSE2Collector* getDetector(const std::string& detID);
90
91private:
92private:
96#endif
97#endif
98
99private:
101 LaneArea() = delete;
102
103};
104}
#define LIBSUMO_ID_PARAMETER_API
Definition: TraCIDefs.h:116
#define LIBSUMO_SUBSCRIPTION_API
Definition: TraCIDefs.h:62
LaneArea()=delete
invalidated standard constructor
static std::shared_ptr< VariableWrapper > makeWrapper()
LIBSUMO_ID_PARAMETER_API static LIBSUMO_SUBSCRIPTION_API NamedRTree * getTree()
Returns a tree filled with inductive loop instances.
static SubscriptionResults mySubscriptionResults
Definition: LaneArea.h:94
static ContextSubscriptionResults myContextSubscriptionResults
Definition: LaneArea.h:95
static double getLastStepOccupancy(const std::string &detID)
static bool handleVariable(const std::string &objID, const int variable, VariableWrapper *wrapper, tcpip::Storage *paramData)
static double getLastIntervalMeanSpeed(const std::string &detID)
static double getLength(const std::string &detID)
static int getLastStepVehicleNumber(const std::string &detID)
static int getLastIntervalVehicleNumber(const std::string &detID)
static double getLastIntervalOccupancy(const std::string &detID)
static void storeShape(const std::string &id, PositionVector &shape)
Saves the shape of the requested object in the given container.
static double getJamLengthMeters(const std::string &detID)
static std::vector< std::string > getLastStepVehicleIDs(const std::string &detID)
static int getLastStepHaltingNumber(const std::string &detID)
static NamedRTree * myTree
Definition: LaneArea.h:93
static int getJamLengthVehicle(const std::string &detID)
static double getIntervalMeanSpeed(const std::string &detID)
static std::string getLaneID(const std::string &detID)
static double getPosition(const std::string &detID)
static double getLastStepMeanSpeed(const std::string &detID)
static double getLastIntervalMaxJamLengthInMeters(const std::string &detID)
static int getIntervalVehicleNumber(const std::string &detID)
static void overrideVehicleNumber(const std::string &detID, int num)
static MSE2Collector * getDetector(const std::string &detID)
static double getIntervalMaxJamLengthInMeters(const std::string &detID)
static double getIntervalOccupancy(const std::string &detID)
An areal detector corresponding to a sequence of consecutive lanes.
Definition: MSE2Collector.h:79
A RT-tree for efficient storing of SUMO's Named objects.
Definition: NamedRTree.h:61
A list of positions.
std::map< std::string, libsumo::SubscriptionResults > ContextSubscriptionResults
Definition: TraCIDefs.h:338
std::map< std::string, libsumo::TraCIResults > SubscriptionResults
{object->{variable->value}}
Definition: TraCIDefs.h:337