Eclipse SUMO - Simulation of Urban MObility
TraCIServerAPI_Route.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2020 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 /****************************************************************************/
20 // APIs for getting/setting route values via TraCI
21 /****************************************************************************/
22 #include <config.h>
23 
24 #include <microsim/MSNet.h>
25 #include <microsim/MSRoute.h>
26 #include <microsim/MSEdge.h>
27 #include <libsumo/Route.h>
28 #include <libsumo/TraCIConstants.h>
29 #include "TraCIServerAPI_Route.h"
30 
31 
32 // ===========================================================================
33 // method definitions
34 // ===========================================================================
35 bool
37  tcpip::Storage& outputStorage) {
38  const int variable = inputStorage.readUnsignedByte();
39  const std::string id = inputStorage.readString();
41  try {
42  if (!libsumo::Route::handleVariable(id, variable, &server)) {
43  switch (variable) {
45  std::string paramName = "";
46  if (!server.readTypeCheckingString(inputStorage, paramName)) {
47  return server.writeErrorStatusCmd(libsumo::CMD_GET_ROUTE_VARIABLE, "Retrieval of a parameter requires its name.", outputStorage);
48  }
50  server.getWrapperStorage().writeString(libsumo::Route::getParameter(id, paramName));
51  break;
52  }
54  std::string paramName = "";
55  if (!server.readTypeCheckingString(inputStorage, paramName)) {
56  return server.writeErrorStatusCmd(libsumo::CMD_GET_ROUTE_VARIABLE, "Retrieval of a parameter requires its name.", outputStorage);
57  }
59  server.getWrapperStorage().writeInt(2);
61  server.getWrapperStorage().writeString(paramName);
63  server.getWrapperStorage().writeString(libsumo::Route::getParameter(id, paramName));
64  break;
65  }
66  default:
67  return server.writeErrorStatusCmd(libsumo::CMD_GET_ROUTE_VARIABLE, "Get Route Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
68  }
69  }
70  } catch (libsumo::TraCIException& e) {
71  return server.writeErrorStatusCmd(libsumo::CMD_GET_ROUTE_VARIABLE, e.what(), outputStorage);
72  }
74  server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
75  return true;
76 }
77 
78 
79 bool
81  tcpip::Storage& outputStorage) {
82  std::string warning = ""; // additional description for response
83  // variable
84  int variable = inputStorage.readUnsignedByte();
85  if (variable != libsumo::ADD && variable != libsumo::VAR_PARAMETER) {
86  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, "Change Route State: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
87  }
88  // id
89  std::string id = inputStorage.readString();
90 
91  try {
92  // process
93  switch (variable) {
94  case libsumo::ADD: {
95  std::vector<std::string> edgeIDs;
96  if (!server.readTypeCheckingStringList(inputStorage, edgeIDs)) {
97  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, "A string list is needed for adding a new route.", outputStorage);
98  }
99  libsumo::Route::add(id, edgeIDs);
100  }
101  break;
102  case libsumo::VAR_PARAMETER: {
103  if (inputStorage.readUnsignedByte() != libsumo::TYPE_COMPOUND) {
104  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, "A compound object is needed for setting a parameter.", outputStorage);
105  }
106  //read itemNo
107  inputStorage.readInt();
108  std::string name;
109  if (!server.readTypeCheckingString(inputStorage, name)) {
110  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, "The name of the parameter must be given as a string.", outputStorage);
111  }
112  std::string value;
113  if (!server.readTypeCheckingString(inputStorage, value)) {
114  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, "The value of the parameter must be given as a string.", outputStorage);
115  }
116  libsumo::Route::setParameter(id, name, value);
117  }
118  break;
119  default:
120  break;
121  }
122  } catch (libsumo::TraCIException& e) {
123  return server.writeErrorStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, e.what(), outputStorage);
124  }
125  server.writeStatusCmd(libsumo::CMD_SET_ROUTE_VARIABLE, libsumo::RTYPE_OK, warning, outputStorage);
126  return true;
127 }
128 
129 
130 /****************************************************************************/
std::string toHex(const T i, std::streamsize numDigits=0)
Definition: ToString.h:54
static bool processSet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value command (Command 0xc6: Change Route State)
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa6: Get Route 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.
bool readTypeCheckingString(tcpip::Storage &inputStorage, std::string &into)
Reads the value type and a string, verifying the type.
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 readTypeCheckingStringList(tcpip::Storage &inputStorage, std::vector< std::string > &into)
Reads the value type and a string list, verifying the type.
void writeResponseWithLength(tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)
virtual std::string readString()
Definition: storage.cpp:175
virtual void writeString(const std::string &s)
Definition: storage.cpp:192
virtual void writeInt(int)
Definition: storage.cpp:316
virtual int readUnsignedByte()
Definition: storage.cpp:150
virtual void writeUnsignedByte(int)
Definition: storage.cpp:160
virtual int readInt()
Definition: storage.cpp:306
TRACI_CONST int TYPE_COMPOUND
TRACI_CONST int CMD_GET_ROUTE_VARIABLE
TRACI_CONST int CMD_SET_ROUTE_VARIABLE
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int VAR_PARAMETER_WITH_KEY
TRACI_CONST int RESPONSE_GET_ROUTE_VARIABLE
TRACI_CONST int RTYPE_OK
TRACI_CONST int ADD
TRACI_CONST int TYPE_STRING