Eclipse SUMO - Simulation of Urban MObility
TraCIServerAPI_InductionLoop.cpp
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3// Copyright (C) 2009-2022 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/****************************************************************************/
21// APIs for getting/setting induction loop values via TraCI
22/****************************************************************************/
23#include <config.h>
24
25#include <microsim/MSNet.h>
31
32
33// ===========================================================================
34// method definitions
35// ===========================================================================
36bool
38 tcpip::Storage& outputStorage) {
39 const int variable = inputStorage.readUnsignedByte();
40 const std::string id = inputStorage.readString();
42 try {
43 if (!libsumo::InductionLoop::handleVariable(id, variable, &server, &inputStorage)) {
44 switch (variable) {
46 std::vector<libsumo::TraCIVehicleData> vd = libsumo::InductionLoop::getVehicleData(id);
47 tcpip::Storage tempContent;
48 int cnt = 0;
49 StoHelp::writeTypedInt(tempContent, (int)vd.size());
50 ++cnt;
51 for (const libsumo::TraCIVehicleData& svd : vd) {
52 StoHelp::writeTypedString(tempContent, svd.id);
53 ++cnt;
54 StoHelp::writeTypedDouble(tempContent, svd.length);
55 ++cnt;
56 StoHelp::writeTypedDouble(tempContent, svd.entryTime);
57 ++cnt;
58 StoHelp::writeTypedDouble(tempContent, svd.leaveTime);
59 ++cnt;
60 StoHelp::writeTypedString(tempContent, svd.typeID);
61 ++cnt;
62 }
64 server.getWrapperStorage().writeStorage(tempContent);
65 break;
66 }
67 default:
69 "Get Induction Loop Variable: unsupported variable " + toHex(variable, 2)
70 + " specified", outputStorage);
71 }
72 }
73 } catch (libsumo::TraCIException& e) {
74 return server.writeErrorStatusCmd(libsumo::CMD_GET_INDUCTIONLOOP_VARIABLE, e.what(), outputStorage);
75 }
77 server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
78 return true;
79}
80
81
82bool
84 tcpip::Storage& outputStorage) {
85 std::string warning = ""; // additional description for response
86 // variable
87 int variable = inputStorage.readUnsignedByte();
88 if (variable != libsumo::VAR_PARAMETER
90 ) {
91 return server.writeErrorStatusCmd(libsumo::CMD_SET_INDUCTIONLOOP_VARIABLE, "Set Induction Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
92 }
93 // id
94 std::string id = inputStorage.readString();
95 // process
96 try {
97 switch (variable) {
99 double time = -1;
100 if (!server.readTypeCheckingDouble(inputStorage, time)) {
101 return server.writeErrorStatusCmd(libsumo::CMD_SET_INDUCTIONLOOP_VARIABLE, "Setting time since last detection requires a double.", outputStorage);
102 }
103 libsumo::InductionLoop::overrideTimeSinceDetection(id, time);
104 break;
105 }
107 StoHelp::readCompound(inputStorage, 2, "A compound object of size 2 is needed for setting a parameter.");
108 const std::string name = StoHelp::readTypedString(inputStorage, "The name of the parameter must be given as a string.");
109 const std::string value = StoHelp::readTypedString(inputStorage, "The value of the parameter must be given as a string.");
110 libsumo::InductionLoop::setParameter(id, name, value);
111 break;
112 }
113 default:
114 break;
115 }
116 } catch (libsumo::TraCIException& e) {
117 return server.writeErrorStatusCmd(libsumo::CMD_SET_INDUCTIONLOOP_VARIABLE, e.what(), outputStorage);
118 }
120 return true;
121}
122
123
124/****************************************************************************/
std::string toHex(const T i, std::streamsize numDigits=0)
Definition: ToString.h:56
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa0: Get Induction Loop Variable)
static bool processSet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value command (Command 0xc0: Set Induction Loop Variable)
TraCI server used to control sumo by a remote TraCI client.
Definition: TraCIServer.h:59
void writeStatusCmd(int commandId, int status, const std::string &description, tcpip::Storage &outputStorage)
Writes a status command to the given storage.
tcpip::Storage & getWrapperStorage()
void initWrapper(const int domainID, const int variable, const std::string &objID)
bool writeErrorStatusCmd(int commandId, const std::string &description, tcpip::Storage &outputStorage)
Writes a status command to the given storage with status = RTYPE_ERR.
bool readTypeCheckingDouble(tcpip::Storage &inputStorage, double &into)
Reads the value type and a double, verifying the type.
void writeResponseWithLength(tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)
static void writeTypedDouble(tcpip::Storage &content, double value)
static int readCompound(tcpip::Storage &ret, int expectedSize=-1, const std::string &error="")
Definition: StorageHelper.h:85
static void writeCompound(tcpip::Storage &content, int size)
static std::string readTypedString(tcpip::Storage &ret, const std::string &error="")
Definition: StorageHelper.h:71
static void writeTypedInt(tcpip::Storage &content, int value)
static void writeTypedString(tcpip::Storage &content, const std::string &value)
An error which allows to continue.
Definition: TraCIDefs.h:138
virtual std::string readString()
Definition: storage.cpp:180
virtual int readUnsignedByte()
Definition: storage.cpp:155
StorageType::size_type size() const
Definition: storage.h:119
virtual void writeStorage(tcpip::Storage &store)
Definition: storage.cpp:388
TRACI_CONST int LAST_STEP_VEHICLE_DATA
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int RESPONSE_GET_INDUCTIONLOOP_VARIABLE
TRACI_CONST int CMD_SET_INDUCTIONLOOP_VARIABLE
TRACI_CONST int VAR_VIRTUAL_DETECTION
TRACI_CONST int RTYPE_OK
TRACI_CONST int CMD_GET_INDUCTIONLOOP_VARIABLE
mirrors MSInductLoop::VehicleData
Definition: TraCIDefs.h:379