GNEPythonTool.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
/****************************************************************************/
// Python tools used in netedit
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/fxheader.h>
#include <utils/options/OptionsCont.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEApplicationWindow;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEPythonTool {
 
public:
    GNEPythonTool(GNEApplicationWindow* applicationWindow, const std::string& toolPath,
                  const std::string& templateStr, FXMenuPane* menu);
 
    virtual ~GNEPythonTool();
 
    const std::string& getToolName() const;
 
    OptionsCont& getToolsOptions();
 
    FXMenuCommand* getMenuCommand() const;
 
    virtual void setCurrentValues();
 
    virtual void postProcessing();
 
    virtual std::string getCommand() const;
 
    const std::string getDefaultValue(const std::string& name) const;
 
    bool loadConfiguration(const std::string& file);
 
    void saveConfiguration(const std::string& file) const;
 
protected:
    GNEApplicationWindow* myApplicationWindow = nullptr;
 
    FXMenuCommand* myMenuCommand = nullptr;
 
    OptionsCont myPythonToolsOptions;
 
    OptionsCont myPythonToolsOptionsOriginal;
 
    const std::string myToolPath;
 
    const std::string myPythonToolName;
 
    std::string getCommandPath() const;
 
private:
    GNEPythonTool(const GNEPythonTool&) = delete;
 
    GNEPythonTool& operator=(const GNEPythonTool&) = delete;
};