GNEParametersDialog.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
/****************************************************************************/
// Dialog for edit parameters
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/dialogs/elements/GNEVehicleTypeDialog.h>
#include <utils/xml/SUMOSAXHandler.h>
 
#include "GNEDialog.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEAttributeCarrier;
class GNEAttributesEditorType;
class GNEViewNet;
class NBLoadedSUMOTLDef;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEParametersDialog : public GNEDialog {
    FXDECLARE(GNEParametersDialog)
 
public:
 
    // ===========================================================================
    // class ParametersValues
    // ===========================================================================
 
    class ParametersValues : protected FXGroupBox {
        FXDECLARE(GNEParametersDialog::ParametersValues)
 
        
        class ParameterRow;
 
    public:
        ParametersValues(FXHorizontalFrame* frame, const std::string& name);
 
        ~ParametersValues();
 
        void setParameters(const Parameterised::Map& newParameters);
 
        void setParameters(const std::vector<std::pair<std::string, std::string> >& newParameters);
 
        void addParameter(std::pair<std::string, std::string> newParameter);
 
        void clearParameters();
 
        const std::vector<ParameterRow*> getParameterRows() const;
 
        bool keyExist(const std::string& key) const;
 
        long onPaint(FXObject* o, FXSelector f, void* p);
 
        long onCmdSetAttribute(FXObject*, FXSelector, void*);
 
        long onCmdButtonPress(FXObject*, FXSelector, void*);
 
 
    protected:
        FOX_CONSTRUCTOR(ParametersValues)
 
    private:
        class ParameterRow {
 
        public:
            ParameterRow(ParametersValues* ParametersValues, FXVerticalFrame* verticalFrameParent);
 
            ~ParameterRow();
 
            void disableRow();
 
            void enableRow(const std::string& parameter, const std::string& value) const;
 
            void toggleAddButton();
 
            bool isButtonInAddMode() const;
 
            void copyValues(const ParameterRow& other);
 
            FXTextField* keyField;
 
            FXTextField* valueField;
 
            FXButton* button;
        private:
            FXHorizontalFrame* horizontalFrame;
        };
 
        FXLabel* myKeyLabel;
 
        FXVerticalFrame* myVerticalFrameRow;
 
        std::vector<ParameterRow*> myParameterRows;
    };
 
    // ===========================================================================
    // class ParametersOperations
    // ===========================================================================
 
    class ParametersOperations : protected FXGroupBox {
        FXDECLARE(GNEParametersDialog::ParametersOperations)
 
    public:
        ParametersOperations(FXHorizontalFrame* frame, GNEParametersDialog* ParameterDialogParent);
 
        ~ParametersOperations();
 
        long onCmdLoadParameters(FXObject*, FXSelector, void*);
 
        long onCmdSaveParameters(FXObject*, FXSelector, void*);
 
        long onCmdClearParameters(FXObject*, FXSelector, void*);
 
        long onCmdSortParameters(FXObject*, FXSelector, void*);
 
        long onCmdHelpParameter(FXObject*, FXSelector, void*);
 
 
    protected:
        FOX_CONSTRUCTOR(ParametersOperations)
 
    private:
        class GNEParameterHandler : public SUMOSAXHandler {
 
        public:
            GNEParameterHandler(ParametersOperations* ParametersOperationsParent, const std::string& file);
 
            ~GNEParameterHandler();
 
 
            void myStartElement(int element, const SUMOSAXAttributes& attrs);
 
        private:
            ParametersOperations* myParametersOperationsParent;
        };
 
        GNEParametersDialog* myParameterDialogParent;
 
        FXButton* mySortButton;
 
        FXButton* myClearButton;
 
        FXButton* myLoadButton;
 
        FXButton* mySaveButton;
 
        FXButton* myHelpButton;
    };
 
    GNEParametersDialog(GNEApplicationWindow* applicationWindow, const Parameterised::Map& parameters);
 
    ~GNEParametersDialog();
 
    void runInternalTest(const InternalTestStep::DialogArgument* dialogArgument);
 
    std::vector<std::pair<std::string, std::string> > getEditedParameters() const;
 
 
    long onCmdAccept(FXObject*, FXSelector, void*);
 
    long onCmdReset(FXObject*, FXSelector, void*);
 
 
protected:
    FOX_CONSTRUCTOR(GNEParametersDialog)
 
    
    const Parameterised::Map myOriginalParameters;
 
    ParametersValues* myParametersValues = nullptr;
 
    ParametersOperations* myParametersOperations = nullptr;
 
private:
    GNEParametersDialog(const GNEParametersDialog&) = delete;
 
    GNEParametersDialog& operator=(const GNEParametersDialog&) = delete;
};