Line data    Source code

       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             : /****************************************************************************/
      14             : /// @file    TraCIServerAPI_Calibrator.cpp
      15             : /// @author  Jakob Erdmann
      16             : /// @date    16.03.2020
      17             : ///
      18             : // APIs for getting/setting Calibrator values via TraCI
      19             : /****************************************************************************/
      20             : #include <config.h>
      21             : 
      22             : #include <microsim/MSNet.h>
      23             : #include <microsim/MSEdge.h>
      24             : #include <microsim/trigger/MSCalibrator.h>
      25             : #include <libsumo/Calibrator.h>
      26             : #include <libsumo/TraCIConstants.h>
      27             : #include <libsumo/StorageHelper.h>
      28             : #include "TraCIServerAPI_Calibrator.h"
      29             : 
      30             : 
      31             : // ===========================================================================
      32             : // method definitions
      33             : // ===========================================================================
      34             : bool
      35         212 : TraCIServerAPI_Calibrator::processGet(TraCIServer& server, tcpip::Storage& inputStorage,
      36             :                                       tcpip::Storage& outputStorage) {
      37         212 :     const int variable = inputStorage.readUnsignedByte();
      38         212 :     const std::string id = inputStorage.readString();
      39         212 :     server.initWrapper(libsumo::RESPONSE_GET_CALIBRATOR_VARIABLE, variable, id);
      40             :     try {
      41         212 :         if (!libsumo::Calibrator::handleVariable(id, variable, &server, &inputStorage)) {
      42           0 :             return server.writeErrorStatusCmd(libsumo::CMD_GET_CALIBRATOR_VARIABLE, "Get Calibrator Variable: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
      43             :         }
      44           0 :     } catch (libsumo::TraCIException& e) {
      45           0 :         return server.writeErrorStatusCmd(libsumo::CMD_GET_CALIBRATOR_VARIABLE, e.what(), outputStorage);
      46           0 :     }
      47         212 :     server.writeStatusCmd(libsumo::CMD_GET_CALIBRATOR_VARIABLE, libsumo::RTYPE_OK, "", outputStorage);
      48         212 :     server.writeResponseWithLength(outputStorage, server.getWrapperStorage());
      49             :     return true;
      50             : }
      51             : 
      52             : 
      53             : bool
      54          16 : TraCIServerAPI_Calibrator::processSet(TraCIServer& server, tcpip::Storage& inputStorage,
      55             :                                       tcpip::Storage& outputStorage) {
      56          16 :     std::string warning = ""; // additional description for response
      57             :     // variable
      58          16 :     int variable = inputStorage.readUnsignedByte();
      59          16 :     if (variable != libsumo::CMD_SET_FLOW && variable != libsumo::VAR_PARAMETER) {
      60           0 :         return server.writeErrorStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, "Change Calibrator State: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
      61             :     }
      62             :     // id
      63          16 :     std::string id = inputStorage.readString();
      64             : 
      65             :     try {
      66             :         // process
      67          16 :         switch (variable) {
      68             :             case libsumo::CMD_SET_FLOW: {
      69           8 :                 StoHelp::readCompound(inputStorage, 8, "A compound object of size 8 is needed for setting calibrator flow.");
      70           8 :                 const double begin = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the begin time as the first (double) value.");
      71           8 :                 const double end = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the end time as the second (double) value.");
      72           8 :                 const double vehsPerHour = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the number of vehicles per hour as the third (double) value.");
      73           8 :                 const double speed = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the speed as the fourth (double) value.");
      74           8 :                 const std::string typeID = StoHelp::readTypedString(inputStorage, "Setting flow requires the type id as the fifth (string) value.");
      75           8 :                 const std::string routeID = StoHelp::readTypedString(inputStorage, "Setting flow requires the route id as the sixth (string) value.");
      76           8 :                 const std::string departLane = StoHelp::readTypedString(inputStorage, "Setting flow requires the departLane as the seventh (string) value.");
      77           8 :                 const std::string departSpeed = StoHelp::readTypedString(inputStorage, "Setting flow requires the departSpeed as the eigth (string) value.");
      78           8 :                 libsumo::Calibrator::setFlow(id, begin, end, vehsPerHour, speed, typeID, routeID, departLane, departSpeed);
      79             :                 break;
      80             :             }
      81             :             case libsumo::VAR_PARAMETER: {
      82           8 :                 StoHelp::readCompound(inputStorage, 2, "A compound object of size 2 is needed for setting a parameter.");
      83           8 :                 const std::string name = StoHelp::readTypedString(inputStorage, "The name of the parameter must be given as a string.");
      84           8 :                 const std::string value = StoHelp::readTypedString(inputStorage, "The value of the parameter must be given as a string.");
      85           8 :                 libsumo::Calibrator::setParameter(id, name, value);
      86             :                 break;
      87             :             }
      88             :             default:
      89             :                 break;
      90             :         }
      91           0 :     } catch (libsumo::TraCIException& e) {
      92           0 :         return server.writeErrorStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, e.what(), outputStorage);
      93           0 :     }
      94          16 :     server.writeStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, libsumo::RTYPE_OK, warning, outputStorage);
      95             :     return true;
      96             : }
      97             : 
      98             : 
      99             : /****************************************************************************/