SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TraCIServerAPI_VehicleType.cpp
Go to the documentation of this file.
1 /****************************************************************************/
10 // APIs for getting/setting vehicle type values via TraCI
11 /****************************************************************************/
12 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
13 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
14 /****************************************************************************/
15 //
16 // This file is part of SUMO.
17 // SUMO is free software: you can redistribute it and/or modify
18 // it under the terms of the GNU General Public License as published by
19 // the Free Software Foundation, either version 3 of the License, or
20 // (at your option) any later version.
21 //
22 /****************************************************************************/
23 
24 
25 // ===========================================================================
26 // included modules
27 // ===========================================================================
28 #ifdef _MSC_VER
29 #include <windows_config.h>
30 #else
31 #include <config.h>
32 #endif
33 
34 #ifndef NO_TRACI
35 
36 #include <limits>
37 #include <microsim/MSNet.h>
38 #include <microsim/MSVehicleType.h>
39 #include "TraCIConstants.h"
40 #include "TraCIServerAPI_VehicleType.h"
41 
42 #ifdef CHECK_MEMORY_LEAKS
43 #include <foreign/nvwa/debug_new.h>
44 #endif // CHECK_MEMORY_LEAKS
45 
46 
47 // ===========================================================================
48 // method definitions
49 // ===========================================================================
50 bool
51 TraCIServerAPI_VehicleType::processGet(TraCIServer& server, tcpip::Storage& inputStorage,
52  tcpip::Storage& outputStorage) {
53  // variable & id
54  int variable = inputStorage.readUnsignedByte();
55  std::string id = inputStorage.readString();
56  // check variable
57  if (variable != ID_LIST && variable != VAR_LENGTH && variable != VAR_MAXSPEED && variable != VAR_ACCEL && variable != VAR_DECEL
58  && variable != VAR_TAU && variable != VAR_VEHICLECLASS && variable != VAR_EMISSIONCLASS && variable != VAR_SHAPECLASS
59  && variable != VAR_SPEED_FACTOR && variable != VAR_SPEED_DEVIATION && variable != VAR_IMPERFECTION
60  && variable != VAR_MINGAP && variable != VAR_WIDTH && variable != VAR_COLOR && variable != ID_COUNT) {
61  return server.writeErrorStatusCmd(CMD_GET_VEHICLETYPE_VARIABLE, "Get Vehicle Type Variable: unsupported variable specified", outputStorage);
62  }
63  // begin response building
64  tcpip::Storage tempMsg;
65  // response-code, variableID, objectID
66  tempMsg.writeUnsignedByte(RESPONSE_GET_VEHICLETYPE_VARIABLE);
67  tempMsg.writeUnsignedByte(variable);
68  tempMsg.writeString(id);
69  // process request
70  if (variable == ID_LIST) {
71  std::vector<std::string> ids;
72  MSNet::getInstance()->getVehicleControl().insertVTypeIDs(ids);
73  tempMsg.writeUnsignedByte(TYPE_STRINGLIST);
74  tempMsg.writeStringList(ids);
75  } else if (variable == ID_COUNT) {
76  std::vector<std::string> ids;
77  MSNet::getInstance()->getVehicleControl().insertVTypeIDs(ids);
78  tempMsg.writeUnsignedByte(TYPE_INTEGER);
79  tempMsg.writeInt((int) ids.size());
80  } else {
81  MSVehicleType* v = MSNet::getInstance()->getVehicleControl().getVType(id);
82  if (v == 0) {
83  return server.writeErrorStatusCmd(CMD_GET_VEHICLETYPE_VARIABLE, "Vehicle type '" + id + "' is not known", outputStorage);
84  }
85  getVariable(variable, *v, tempMsg);
86  }
87  server.writeStatusCmd(CMD_GET_VEHICLETYPE_VARIABLE, RTYPE_OK, "", outputStorage);
88  server.writeResponseWithLength(outputStorage, tempMsg);
89  return true;
90 }
91 
92 bool
93 TraCIServerAPI_VehicleType::getVariable(const int variable, const MSVehicleType& v, tcpip::Storage& tempMsg) {
94  switch (variable) {
95  case VAR_LENGTH:
96  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
97  tempMsg.writeDouble(v.getLength());
98  break;
99  case VAR_MINGAP:
100  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
101  tempMsg.writeDouble(v.getMinGap());
102  break;
103  case VAR_MAXSPEED:
104  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
105  tempMsg.writeDouble(v.getMaxSpeed());
106  break;
107  case VAR_ACCEL:
108  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
109  tempMsg.writeDouble(v.getCarFollowModel().getMaxAccel());
110  break;
111  case VAR_DECEL:
112  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
113  tempMsg.writeDouble(v.getCarFollowModel().getMaxDecel());
114  break;
115  case VAR_IMPERFECTION:
116  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
117  tempMsg.writeDouble(v.getCarFollowModel().getImperfection());
118  break;
119  case VAR_TAU:
120  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
121  tempMsg.writeDouble(v.getCarFollowModel().getHeadwayTime());
122  break;
123  case VAR_SPEED_FACTOR:
124  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
125  tempMsg.writeDouble(v.getSpeedFactor());
126  break;
127  case VAR_SPEED_DEVIATION:
128  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
129  tempMsg.writeDouble(v.getSpeedDeviation());
130  break;
131  case VAR_VEHICLECLASS:
132  tempMsg.writeUnsignedByte(TYPE_STRING);
133  tempMsg.writeString(toString(v.getVehicleClass()));
134  break;
135  case VAR_EMISSIONCLASS:
136  tempMsg.writeUnsignedByte(TYPE_STRING);
137  tempMsg.writeString(getVehicleEmissionTypeName(v.getEmissionClass()));
138  break;
139  case VAR_SHAPECLASS:
140  tempMsg.writeUnsignedByte(TYPE_STRING);
141  tempMsg.writeString(getVehicleShapeName(v.getGuiShape()));
142  break;
143  case VAR_WIDTH:
144  tempMsg.writeUnsignedByte(TYPE_DOUBLE);
145  tempMsg.writeDouble(v.getWidth());
146  break;
147  case VAR_COLOR:
148  tempMsg.writeUnsignedByte(TYPE_COLOR);
149  tempMsg.writeUnsignedByte(v.getColor().red());
150  tempMsg.writeUnsignedByte(v.getColor().green());
151  tempMsg.writeUnsignedByte(v.getColor().blue());
152  tempMsg.writeUnsignedByte(v.getColor().alpha());
153  break;
154  default:
155  break;
156  }
157  return true;
158 }
159 
160 bool
161 TraCIServerAPI_VehicleType::processSet(TraCIServer& server, tcpip::Storage& inputStorage,
162  tcpip::Storage& outputStorage) {
163  std::string warning = ""; // additional description for response
164  // variable
165  int variable = inputStorage.readUnsignedByte();
166  if (variable != VAR_LENGTH && variable != VAR_MAXSPEED && variable != VAR_VEHICLECLASS
167  && variable != VAR_SPEED_FACTOR && variable != VAR_SPEED_DEVIATION && variable != VAR_EMISSIONCLASS
168  && variable != VAR_WIDTH && variable != VAR_MINGAP && variable != VAR_SHAPECLASS
169  && variable != VAR_ACCEL && variable != VAR_DECEL && variable != VAR_IMPERFECTION
170  && variable != VAR_TAU && variable != VAR_COLOR
171  ) {
172  return server.writeErrorStatusCmd(CMD_SET_VEHICLETYPE_VARIABLE, "Change Vehicle Type State: unsupported variable specified", outputStorage);
173  }
174  // id
175  std::string id = inputStorage.readString();
176  MSVehicleType* v = MSNet::getInstance()->getVehicleControl().getVType(id);
177  if (v == 0) {
178  return server.writeErrorStatusCmd(CMD_SET_VEHICLETYPE_VARIABLE, "Vehicle type '" + id + "' is not known", outputStorage);
179  }
180  // process
181  try {
182  if (setVariable(CMD_SET_VEHICLETYPE_VARIABLE, variable, *v, server, inputStorage, outputStorage)) {
183  server.writeStatusCmd(CMD_SET_VEHICLETYPE_VARIABLE, RTYPE_OK, warning, outputStorage);
184  return true;
185  }
186  } catch (ProcessError& e) {
187  return server.writeErrorStatusCmd(CMD_SET_VEHICLETYPE_VARIABLE, e.what(), outputStorage);
188  }
189  return false;
190 }
191 
192 
193 bool
194 TraCIServerAPI_VehicleType::setVariable(const int cmd, const int variable,
195  MSVehicleType& v, TraCIServer& server,
196  tcpip::Storage& inputStorage, tcpip::Storage& outputStorage) {
197  switch (variable) {
198  case VAR_LENGTH: {
199  double value = 0;
200  if (!server.readTypeCheckingDouble(inputStorage, value)) {
201  return server.writeErrorStatusCmd(cmd, "Setting length requires a double.", outputStorage);
202  }
203  if (value == 0.0 || fabs(value) == std::numeric_limits<double>::infinity()) {
204  return server.writeErrorStatusCmd(cmd, "Invalid length.", outputStorage);
205  }
206  v.setLength(value);
207  }
208  break;
209  case VAR_MAXSPEED: {
210  double value = 0;
211  if (!server.readTypeCheckingDouble(inputStorage, value)) {
212  return server.writeErrorStatusCmd(cmd, "Setting maximum speed requires a double.", outputStorage);
213  }
214  if (value == 0.0 || fabs(value) == std::numeric_limits<double>::infinity()) {
215  return server.writeErrorStatusCmd(cmd, "Invalid maximum speed.", outputStorage);
216  }
217  v.setMaxSpeed(value);
218  }
219  break;
220  case VAR_VEHICLECLASS: {
221  std::string vclass;
222  if (!server.readTypeCheckingString(inputStorage, vclass)) {
223  return server.writeErrorStatusCmd(cmd, "Setting vehicle class requires a string.", outputStorage);
224  }
225  v.setVClass(getVehicleClassID(vclass));
226  }
227  break;
228  case VAR_SPEED_FACTOR: {
229  double value = 0;
230  if (!server.readTypeCheckingDouble(inputStorage, value)) {
231  return server.writeErrorStatusCmd(cmd, "Setting speed factor requires a double.", outputStorage);
232  }
233  v.setSpeedFactor(value);
234  }
235  break;
236  case VAR_SPEED_DEVIATION: {
237  double value = 0;
238  if (!server.readTypeCheckingDouble(inputStorage, value)) {
239  return server.writeErrorStatusCmd(cmd, "Setting speed deviation requires a double.", outputStorage);
240  }
241  v.setSpeedDeviation(value);
242  }
243  break;
244  case VAR_EMISSIONCLASS: {
245  std::string eclass;
246  if (!server.readTypeCheckingString(inputStorage, eclass)) {
247  return server.writeErrorStatusCmd(cmd, "Setting emission class requires a string.", outputStorage);
248  }
249  v.setEmissionClass(getVehicleEmissionTypeID(eclass));
250  }
251  break;
252  case VAR_WIDTH: {
253  double value = 0;
254  if (!server.readTypeCheckingDouble(inputStorage, value)) {
255  return server.writeErrorStatusCmd(cmd, "Setting width requires a double.", outputStorage);
256  }
257  v.setWidth(value);
258  }
259  break;
260  case VAR_MINGAP: {
261  double value = 0;
262  if (!server.readTypeCheckingDouble(inputStorage, value)) {
263  return server.writeErrorStatusCmd(cmd, "Setting minimum gap requires a double.", outputStorage);
264  }
265  v.setMinGap(value);
266  }
267  break;
268  case VAR_SHAPECLASS: {
269  std::string sclass;
270  if (!server.readTypeCheckingString(inputStorage, sclass)) {
271  return server.writeErrorStatusCmd(cmd, "Setting vehicle shape requires a string.", outputStorage);
272  }
273  v.setShape(getVehicleShapeID(sclass));
274  }
275  break;
276  case VAR_ACCEL: {
277  double value = 0;
278  if (!server.readTypeCheckingDouble(inputStorage, value)) {
279  return server.writeErrorStatusCmd(cmd, "Setting acceleration requires a double.", outputStorage);
280  }
281  v.getCarFollowModel().setMaxAccel(value);
282  }
283  break;
284  case VAR_DECEL: {
285  double value = 0;
286  if (!server.readTypeCheckingDouble(inputStorage, value)) {
287  return server.writeErrorStatusCmd(cmd, "Setting deceleration requires a double.", outputStorage);
288  }
289  v.getCarFollowModel().setMaxDecel(value);
290  }
291  break;
292  case VAR_IMPERFECTION: {
293  double value = 0;
294  if (!server.readTypeCheckingDouble(inputStorage, value)) {
295  return server.writeErrorStatusCmd(cmd, "Setting driver imperfection requires a double.", outputStorage);
296  }
297  v.getCarFollowModel().setImperfection(value);
298  }
299  break;
300  case VAR_TAU: {
301  double value = 0;
302  if (!server.readTypeCheckingDouble(inputStorage, value)) {
303  return server.writeErrorStatusCmd(cmd, "Setting headway time requires a double.", outputStorage);
304  }
305  v.getCarFollowModel().setHeadwayTime(value);
306  }
307  break;
308  case VAR_COLOR: {
309  RGBColor col;
310  if (!server.readTypeCheckingColor(inputStorage, col)) {
311  return server.writeErrorStatusCmd(cmd, "The color must be given using the according type.", outputStorage);
312  }
313  v.setColor(col);
314  }
315  break;
316  default:
317  break;
318  }
319  return true;
320 }
321 
322 #endif
323 
324 
325 /****************************************************************************/