Eclipse SUMO - Simulation of Urban MObility
TraCIServerAPI_VariableSpeedSign.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 /****************************************************************************/
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>
26 #include <libsumo/TraCIConstants.h>
28 
29 
30 // ===========================================================================
31 // method definitions
32 // ===========================================================================
33 bool
35  tcpip::Storage& outputStorage) {
36  const int variable = inputStorage.readUnsignedByte();
37  const std::string id = inputStorage.readString();
39  try {
40  if (!libsumo::VariableSpeedSign::handleVariable(id, variable, &server)) {
41  switch (variable) {
43  std::string paramName = "";
44  if (!server.readTypeCheckingString(inputStorage, paramName)) {
45  return server.writeErrorStatusCmd(libsumo::CMD_GET_VARIABLESPEEDSIGN_VARIABLE, "Retrieval of a parameter requires its name.", outputStorage);
46  }
48  server.getWrapperStorage().writeString(libsumo::VariableSpeedSign::getParameter(id, paramName));
49  break;
50  }
52  std::string paramName = "";
53  if (!server.readTypeCheckingString(inputStorage, paramName)) {
54  return server.writeErrorStatusCmd(libsumo::CMD_GET_VARIABLESPEEDSIGN_VARIABLE, "Retrieval of a parameter requires its name.",
55  outputStorage);
56  }
58  server.getWrapperStorage().writeInt(2);
60  server.getWrapperStorage().writeString(paramName);
62  server.getWrapperStorage().writeString(libsumo::VariableSpeedSign::getParameter(id, paramName));
63  break;
64  }
65  default:
66  return server.writeErrorStatusCmd(libsumo::CMD_GET_VARIABLESPEEDSIGN_VARIABLE, "Get VariableSpeedSign Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
67  }
68  }
69  } catch (libsumo::TraCIException& e) {
70  return server.writeErrorStatusCmd(libsumo::CMD_GET_VARIABLESPEEDSIGN_VARIABLE, e.what(), outputStorage);
71  }
73  server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
74  return true;
75 }
76 
77 
78 bool
80  tcpip::Storage& outputStorage) {
81  std::string warning = ""; // additional description for response
82  // variable
83  int variable = inputStorage.readUnsignedByte();
84  if (variable != libsumo::VAR_PARAMETER) {
85  return server.writeErrorStatusCmd(libsumo::CMD_SET_VARIABLESPEEDSIGN_VARIABLE, "Change VariableSpeedSign State: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
86  }
87  // id
88  std::string id = inputStorage.readString();
89 
90  try {
91  // process
92  switch (variable) {
94  if (inputStorage.readUnsignedByte() != libsumo::TYPE_COMPOUND) {
95  return server.writeErrorStatusCmd(libsumo::CMD_SET_VARIABLESPEEDSIGN_VARIABLE, "A compound object is needed for setting a parameter.", outputStorage);
96  }
97  //read itemNo
98  inputStorage.readInt();
99  std::string name;
100  if (!server.readTypeCheckingString(inputStorage, name)) {
101  return server.writeErrorStatusCmd(libsumo::CMD_SET_VARIABLESPEEDSIGN_VARIABLE, "The name of the parameter must be given as a string.", outputStorage);
102  }
103  std::string value;
104  if (!server.readTypeCheckingString(inputStorage, value)) {
105  return server.writeErrorStatusCmd(libsumo::CMD_SET_VARIABLESPEEDSIGN_VARIABLE, "The value of the parameter must be given as a string.", outputStorage);
106  }
107  libsumo::VariableSpeedSign::setParameter(id, name, value);
108  }
109  break;
110  default:
111  break;
112  }
113  } catch (libsumo::TraCIException& e) {
114  return server.writeErrorStatusCmd(libsumo::CMD_SET_VARIABLESPEEDSIGN_VARIABLE, e.what(), outputStorage);
115  }
117  return true;
118 }
119 
120 
121 /****************************************************************************/
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 VariableSpeedSign State)
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa6: Get VariableSpeedSign 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.
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 RESPONSE_GET_VARIABLESPEEDSIGN_VARIABLE
TRACI_CONST int TYPE_COMPOUND
TRACI_CONST int CMD_SET_VARIABLESPEEDSIGN_VARIABLE
TRACI_CONST int CMD_GET_VARIABLESPEEDSIGN_VARIABLE
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int VAR_PARAMETER_WITH_KEY
TRACI_CONST int RTYPE_OK
TRACI_CONST int TYPE_STRING