InternalTest.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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
/****************************************************************************/
// Class used for internal tests
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <map>
 
#include <utils/foxtools/fxheader.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class InternalTestStep;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class InternalTest : public FXObject {
 
public:
    class ViewPosition {
 
    public:
        ViewPosition();
 
        ViewPosition(const int xValue, const int yValue);
 
        ViewPosition(const std::string& xValue, const std::string& yValue);
 
        int getX() const;
 
        int getY() const;
 
    private:
        int myX = 0;
 
        int myY = 0;
    };
 
    struct ContextualMenu {
 
    public:
        ContextualMenu();
 
        ContextualMenu(const std::string& mainMenuValue, const std::string& subMenuAValue,
                       const std::string& subMenuBValue);
 
        int getMainMenuPosition() const;
 
        int getSubMenuAPosition() const;
 
        int getSubMenuBPosition() const;
 
    private:
        int myMainMenu = 0;
 
        int mySubMenuA = 0;
 
        int mySubMenuB = 0;
    };
 
    class Movement {
 
    public:
        Movement();
 
        Movement(const std::string& up, const std::string& down,
                 const std::string& left, const std::string& right);
 
        int getUp() const;
 
        int getDown() const;
 
        int getLeft() const;
 
        int getRight() const;
 
    private:
        int myUp = 0;
 
        int myDown = 0;
 
        int myLeft = 0;
 
        int myRight = 0;
    };
 
    InternalTest(const std::string& testFile);
 
    ~InternalTest();
 
 
    void addTestSteps(InternalTestStep* internalTestStep);
 
    InternalTestStep* getCurrentStep() const;
 
    InternalTestStep* setNextStep();
 
 
    bool isRunning() const;
 
    FXint getTime() const;
 
    const std::map<std::string, int>& getAttributesEnum() const;
 
    const std::map<std::string, InternalTest::ContextualMenu>& getContextualMenuOperations() const;
 
    const std::map<std::string, InternalTest::ViewPosition>& getViewPositions() const;
 
    const std::map<std::string, InternalTest::Movement>& getMovements() const;
 
    const InternalTest::ViewPosition& getLastMovedPosition() const;
 
    void updateLastMovedPosition(const int x, const int y);
 
    std::vector<InternalTest::ViewPosition> interpolateViewPositions(
        const InternalTest::ViewPosition& viewStartPosition,
        const int offsetStartX, const int offsetStartY,
        const InternalTest::ViewPosition& viewEndPosition,
        const int offsetEndX, const int offsetEndY) const;
 
protected:
    InternalTestStep* myInitialTestStep = nullptr;
 
    InternalTestStep* myLastTestStep = nullptr;
 
    InternalTestStep* myCurrentTestStep = nullptr;
 
    bool myRunning = false;
 
    std::map<std::string, int> myAttributesEnum;
 
    std::map<std::string, InternalTest::ContextualMenu> myContextualMenuOperations;
 
    std::map<std::string, InternalTest::ViewPosition> myViewPositions;
 
    std::map<std::string, InternalTest::Movement> myMovements;
 
    InternalTest::ViewPosition myLastMovedPosition;
 
    std::map<std::string, int> parseAttributesEnumFile(const std::string filePath) const;
 
    std::map<std::string, InternalTest::ContextualMenu> parseContextualMenuOperationsFile(const std::string filePath) const;
 
    std::map<std::string, InternalTest::ViewPosition> parseViewPositionsFile(const std::string filePath) const;
 
    std::map<std::string, InternalTest::Movement> parseMovementsFile(const std::string filePath) const;
 
    std::vector<std::string> cleanLines(const std::vector<std::pair<bool, std::string> >& linesRaw) const;
 
    bool startWith(const std::string& str, const std::string& prefix) const;
 
private:
    InternalTest() = delete;
 
    InternalTest(const InternalTest&) = delete;
 
    InternalTest& operator=(const InternalTest& src) = delete;
};