Eclipse SUMO - Simulation of Urban MObility
TraCIServerAPI_BusStop.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 // Copyright (C) 2001-2024 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 // APIs for getting/setting busstop values via TraCI
19 /****************************************************************************/
20 #include <config.h>
21 
22 #include <microsim/MSNet.h>
23 #include <microsim/MSEdge.h>
25 #include <libsumo/BusStop.h>
26 #include <libsumo/TraCIConstants.h>
27 #include <libsumo/StorageHelper.h>
28 #include "TraCIServerAPI_BusStop.h"
29 
30 
31 // ===========================================================================
32 // method definitions
33 // ===========================================================================
34 bool
36  tcpip::Storage& outputStorage) {
37  const int variable = inputStorage.readUnsignedByte();
38  const std::string id = inputStorage.readString();
40  try {
41  if (!libsumo::BusStop::handleVariable(id, variable, &server, &inputStorage)) {
42  return server.writeErrorStatusCmd(libsumo::CMD_GET_BUSSTOP_VARIABLE, "Get BusStop Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
43  }
44  } catch (libsumo::TraCIException& e) {
45  return server.writeErrorStatusCmd(libsumo::CMD_GET_BUSSTOP_VARIABLE, e.what(), outputStorage);
46  }
48  server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
49  return true;
50 }
51 
52 
53 bool
55  tcpip::Storage& outputStorage) {
56  std::string warning = ""; // additional description for response
57  // variable
58  int variable = inputStorage.readUnsignedByte();
59  if (variable != libsumo::VAR_PARAMETER) {
60  return server.writeErrorStatusCmd(libsumo::CMD_SET_BUSSTOP_VARIABLE, "Change BusStop State: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
61  }
62  // id
63  std::string id = inputStorage.readString();
64 
65  try {
66  // process
67  switch (variable) {
69  // read and check item number
70  StoHelp::readCompound(inputStorage, 2, "A compound object of size 2 is needed for setting a parameter.");
71  const std::string name = StoHelp::readTypedString(inputStorage, "The name of the parameter must be given as a string.");
72  const std::string value = StoHelp::readTypedString(inputStorage, "The value of the parameter must be given as a string.");
73  libsumo::BusStop::setParameter(id, name, value);
74  break;
75  }
76  default:
77  break;
78  }
79  } catch (libsumo::TraCIException& e) {
80  return server.writeErrorStatusCmd(libsumo::CMD_SET_BUSSTOP_VARIABLE, e.what(), outputStorage);
81  }
83  return true;
84 }
85 
86 
87 /****************************************************************************/
std::string toHex(const T i, std::streamsize numDigits=0)
Definition: ToString.h:56
static bool processSet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value command (Command 0xc6: Change BusStop State)
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa6: Get BusStop 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:144
virtual std::string readString()
Definition: storage.cpp:180
virtual int readUnsignedByte()
Definition: storage.cpp:155
TRACI_CONST int CMD_GET_BUSSTOP_VARIABLE
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int RESPONSE_GET_BUSSTOP_VARIABLE
TRACI_CONST int RTYPE_OK
TRACI_CONST int CMD_SET_BUSSTOP_VARIABLE