Line data    Source code

       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              : /****************************************************************************/
      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           12 : TraCIServerAPI_Calibrator::processSet(TraCIServer& server, tcpip::Storage& inputStorage,
      36              :                                       tcpip::Storage& outputStorage) {
      37           12 :     std::string warning = ""; // additional description for response
      38              :     // variable
      39           12 :     int variable = inputStorage.readUnsignedByte();
      40           12 :     if (variable != libsumo::CMD_SET_FLOW && variable != libsumo::VAR_PARAMETER) {
      41            0 :         return server.writeErrorStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, "Change Calibrator State: unsupported variable " + toHex(variable, 2) + " specified", outputStorage);
      42              :     }
      43              :     // id
      44           12 :     std::string id = inputStorage.readString();
      45              : 
      46              :     try {
      47              :         // process
      48           12 :         switch (variable) {
      49              :             case libsumo::CMD_SET_FLOW: {
      50            6 :                 StoHelp::readCompound(inputStorage, 8, "A compound object of size 8 is needed for setting calibrator flow.");
      51            6 :                 const double begin = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the begin time as the first (double) value.");
      52            6 :                 const double end = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the end time as the second (double) value.");
      53            6 :                 const double vehsPerHour = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the number of vehicles per hour as the third (double) value.");
      54            6 :                 const double speed = StoHelp::readTypedDouble(inputStorage, "Setting flow requires the speed as the fourth (double) value.");
      55            6 :                 const std::string typeID = StoHelp::readTypedString(inputStorage, "Setting flow requires the type id as the fifth (string) value.");
      56            6 :                 const std::string routeID = StoHelp::readTypedString(inputStorage, "Setting flow requires the route id as the sixth (string) value.");
      57            6 :                 const std::string departLane = StoHelp::readTypedString(inputStorage, "Setting flow requires the departLane as the seventh (string) value.");
      58            6 :                 const std::string departSpeed = StoHelp::readTypedString(inputStorage, "Setting flow requires the departSpeed as the eigth (string) value.");
      59            6 :                 libsumo::Calibrator::setFlow(id, begin, end, vehsPerHour, speed, typeID, routeID, departLane, departSpeed);
      60              :                 break;
      61              :             }
      62              :             case libsumo::VAR_PARAMETER: {
      63            6 :                 StoHelp::readCompound(inputStorage, 2, "A compound object of size 2 is needed for setting a parameter.");
      64            6 :                 const std::string name = StoHelp::readTypedString(inputStorage, "The name of the parameter must be given as a string.");
      65            6 :                 const std::string value = StoHelp::readTypedString(inputStorage, "The value of the parameter must be given as a string.");
      66            6 :                 libsumo::Calibrator::setParameter(id, name, value);
      67              :                 break;
      68              :             }
      69              :             default:
      70              :                 break;
      71              :         }
      72            0 :     } catch (libsumo::TraCIException& e) {
      73            0 :         return server.writeErrorStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, e.what(), outputStorage);
      74            0 :     }
      75           12 :     server.writeStatusCmd(libsumo::CMD_SET_CALIBRATOR_VARIABLE, libsumo::RTYPE_OK, warning, outputStorage);
      76              :     return true;
      77              : }
      78              : 
      79              : 
      80              : /****************************************************************************/