TraCITestClient.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A test execution class
/****************************************************************************/
#pragma once
#include <config.h>
#include <string>
#include <sstream>
#include <vector>
 
#include <foreign/tcpip/socket.h>
#include <utils/traci/TraCIAPI.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class TraCITestClient : public TraCIAPI {
public:
    TraCITestClient(std::string outputFileName = "testclient_result.out");
 
 
    ~TraCITestClient();
 
 
    int run(std::string fileName, int port, std::string host = "localhost");
 
 
protected:
 
    void commandSimulationStep(double time);
 
 
    void commandClose();
 
 
    void commandSetOrder(int order);
 
 
    void commandGetVariable(int domID, int varID, const std::string& objID, tcpip::Storage* addData = 0);
 
 
    void commandSetValue(int domID, int varID, const std::string& objID, std::ifstream& defFile);
 
 
    void commandSubscribeObjectVariable(int domID, const std::string& objID, double beginTime, double endTime, int varNo, std::ifstream& defFile);
 
 
    void commandSubscribeContextVariable(int domID, const std::string& objID, double beginTime, double endTime, int domain, double range, int varNo, std::ifstream& defFile);
 
 
 
private:
 
    void writeResult();
 
 
    void errorMsg(std::stringstream& msg);
 
 
 
 
    bool validateSimulationStep2(tcpip::Storage& inMsg);
 
 
    bool validateSubscription(tcpip::Storage& inMsg);
 
 
 
 
    int setValueTypeDependant(tcpip::Storage& into, std::ifstream& defFile, std::stringstream& msg);
 
 
    void readAndReportTypeDependent(tcpip::Storage& inMsg, int valueDataType);
 
 
    void testAPI();
 
    inline std::string joinToString(const std::vector<std::string>& s, const std::string& between) {
        std::ostringstream oss;
        bool connect = false;
        for (const std::string& it : s) {
            if (connect) {
                oss << between;
            } else {
                connect = true;
            }
            oss << it;
        }
        return oss.str();
    }
 
    inline std::string joinToString(const std::map<std::string, std::string>& m) {
        std::ostringstream oss;
        bool connect = false;
        for (const auto& it : m) {
            if (connect) {
                oss << " ";
            } else {
                connect = true;
            }
            oss << it.first << ":" << it.second;
        }
        return oss.str();
    }
 
    inline std::string joinToString(const std::vector<double>& v, const std::string& between) {
        std::ostringstream oss;
        bool connect = false;
        for (double it : v) {
            if (connect) {
                oss << between;
            } else {
                connect = true;
            }
            oss << it;
        }
        return oss.str();
    }
 
private:
    std::string outputFileName;
 
    std::stringstream answerLog;
 
};