Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
TraCIServerAPI_ParkingArea.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-2025 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 parking area values via TraCI
19/****************************************************************************/
20#include <config.h>
21
22#include <microsim/MSNet.h>
23#include <microsim/MSEdge.h>
25#include <libsumo/ParkingArea.h>
28
29
30// ===========================================================================
31// method definitions
32// ===========================================================================
33bool
35 tcpip::Storage& outputStorage) {
36 const int variable = inputStorage.readUnsignedByte();
37 const std::string id = inputStorage.readString();
39 try {
40 if (!libsumo::ParkingArea::handleVariable(id, variable, &server, &inputStorage)) {
41 return server.writeErrorStatusCmd(libsumo::CMD_GET_PARKINGAREA_VARIABLE, "Get ParkingArea Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
42 }
43 } catch (libsumo::TraCIException& e) {
44 return server.writeErrorStatusCmd(libsumo::CMD_GET_PARKINGAREA_VARIABLE, e.what(), outputStorage);
45 }
47 server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
48 return true;
49}
50
51
52bool
54 tcpip::Storage& outputStorage) {
55 std::string warning = ""; // additional description for response
56 // variable
57 int variable = inputStorage.readUnsignedByte();
58 if (variable != libsumo::VAR_PARAMETER &&
59 variable != libsumo::VAR_ACCESS_BADGE) {
60 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, "Change ParkingArea 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 if (inputStorage.readUnsignedByte() != libsumo::TYPE_COMPOUND) {
70 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, "A compound object is needed for setting a parameter.", outputStorage);
71 }
72 //read itemNo
73 inputStorage.readInt();
74 std::string name;
75 if (!server.readTypeCheckingString(inputStorage, name)) {
76 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, "The name of the parameter must be given as a string.", outputStorage);
77 }
78 std::string value;
79 if (!server.readTypeCheckingString(inputStorage, value)) {
80 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, "The value of the parameter must be given as a string.", outputStorage);
81 }
82 libsumo::ParkingArea::setParameter(id, name, value);
83 break;
84 }
86 std::vector<std::string> badges;
87 if (!server.readTypeCheckingStringList(inputStorage, badges)) {
88 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, "A string list is needed to update the ParkingArea access badges.", outputStorage);
89 }
90 libsumo::ParkingArea::setAcceptedBadges(id, badges);
91 break;
92 }
93 default:
94 break;
95 }
96 } catch (libsumo::TraCIException& e) {
97 return server.writeErrorStatusCmd(libsumo::CMD_SET_PARKINGAREA_VARIABLE, e.what(), outputStorage);
98 }
100 return true;
101}
102
103
104/****************************************************************************/
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 ParkingArea State)
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa6: Get ParkingArea 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)
An error which allows to continue.
Definition TraCIDefs.h:145
virtual std::string readString()
Definition storage.cpp:180
virtual int readUnsignedByte()
Definition storage.cpp:155
virtual int readInt()
Definition storage.cpp:311
TRACI_CONST int VAR_ACCESS_BADGE
TRACI_CONST int CMD_GET_PARKINGAREA_VARIABLE
TRACI_CONST int TYPE_COMPOUND
TRACI_CONST int VAR_PARAMETER
TRACI_CONST int CMD_SET_PARKINGAREA_VARIABLE
TRACI_CONST int RESPONSE_GET_PARKINGAREA_VARIABLE
TRACI_CONST int RTYPE_OK