Eclipse SUMO - Simulation of Urban MObility
TraCIServerAPI_LaneArea.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2014-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 areal detector values via TraCI
22 /****************************************************************************/
23 #include <config.h>
24 
26 #include <libsumo/LaneArea.h>
27 #include <libsumo/TraCIConstants.h>
28 #include <libsumo/StorageHelper.h>
29 #include "TraCIServer.h"
31 
32 
33 // ===========================================================================
34 // method definitions
35 // ===========================================================================
36 bool
38  tcpip::Storage& outputStorage) {
39  const int variable = inputStorage.readUnsignedByte();
40  const std::string id = inputStorage.readString();
42  try {
43  if (!libsumo::LaneArea::handleVariable(id, variable, &server, &inputStorage)) {
44  return server.writeErrorStatusCmd(libsumo::CMD_GET_LANEAREA_VARIABLE, "Get Lane Area Detector Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
45  }
46  } catch (libsumo::TraCIException& e) {
47  return server.writeErrorStatusCmd(libsumo::CMD_GET_LANEAREA_VARIABLE, e.what(), outputStorage);
48  }
50  server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
51  return true;
52 }
53 
54 
55 bool
57  tcpip::Storage& outputStorage) {
58  std::string warning = ""; // additional description for response
59  // variable
60  int variable = inputStorage.readUnsignedByte();
61  if (variable != libsumo::VAR_PARAMETER
62  ) {
63  return server.writeErrorStatusCmd(libsumo::CMD_SET_LANEAREA_VARIABLE, "Set Lane Area Detector Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
64  }
65  // id
66  std::string id = inputStorage.readString();
67  // process
68  try {
69  switch (variable) {
71  StoHelp::readCompound(inputStorage, 2, "A compound object of size 2 is needed for setting a parameter.");
72  const std::string name = StoHelp::readTypedString(inputStorage, "The name of the parameter must be given as a string.");
73  const std::string value = StoHelp::readTypedString(inputStorage, "The value of the parameter must be given as a string.");
74  libsumo::LaneArea::setParameter(id, name, value);
75  break;
76  }
77  default:
78  break;
79  }
80  } catch (libsumo::TraCIException& e) {
81  return server.writeErrorStatusCmd(libsumo::CMD_SET_LANEAREA_VARIABLE, e.what(), outputStorage);
82  }
84  return true;
85 }
86 
87 
88 /****************************************************************************/
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 0xa1: Get AreaDetector Variable)
static bool processSet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value command (Command 0xcd: Set AreaDetector 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.
void writeResponseWithLength(tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)
static int readCompound(tcpip::Storage &ret, int expectedSize=-1, const std::string &error="")
Definition: StorageHelper.h:85
static std::string readTypedString(tcpip::Storage &ret, const std::string &error="")
Definition: StorageHelper.h:71
An error which allows to continue.
Definition: TraCIDefs.h:130
virtual std::string readString()
Definition: storage.cpp:180
virtual int readUnsignedByte()
Definition: storage.cpp:155
TRACI_CONST int RESPONSE_GET_LANEAREA_VARIABLE
TRACI_CONST int CMD_GET_LANEAREA_VARIABLE
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int CMD_SET_LANEAREA_VARIABLE
TRACI_CONST int RTYPE_OK