GNEDistributionFrame.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
/****************************************************************************/
// The Widget for edit distribution elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/frames/GNEFrame.h>
#include <utils/foxtools/MFXGroupBoxModule.h>
#include <utils/gui/images/GUIIcons.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEAttributesEditor;
class GNEDemandElement;
class MFXComboBoxIcon;
class MFXTextFieldIcon;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDistributionFrame {
 
public:
    // ===========================================================================
    // class declaration
    // ===========================================================================
 
    class DistributionValuesEditor;
    class DistributionSelector;
 
    // ===========================================================================
    // class DistributionEditor
    // ===========================================================================
 
    class DistributionEditor : public MFXGroupBoxModule {
        FXDECLARE(GNEDistributionFrame::DistributionEditor)
 
        
        friend class DistributionValuesEditor;
 
    public:
        DistributionEditor(GNEFrame* frameParent, SumoXMLTag distributionTag, GUIIcon icon);

        ~DistributionEditor();

        SumoXMLTag getDistributionTag() const;


        long onCmdCreateDistribution(FXObject*, FXSelector, void*);

        long onCmdDeleteDistribution(FXObject*, FXSelector, void*);

        long onUpdDeleteDistribution(FXObject* sender, FXSelector, void*);

 
    protected:
        FOX_CONSTRUCTOR(DistributionEditor)
 
    private:
        GNEFrame* myFrameParent;

        SumoXMLTag myDistributionTag;

        DistributionSelector* myDistributionSelector = nullptr;

        MFXButtonTooltip* myCreateDistributionButton = nullptr;

        MFXButtonTooltip* myDeleteDistributionButton = nullptr;

        DistributionEditor(const DistributionEditor&) = delete;

        DistributionEditor& operator=(const DistributionEditor& src) = delete;
    };
 
    // ===========================================================================
    // class DistributionSelector
    // ===========================================================================
 
    class DistributionSelector : public MFXGroupBoxModule {
        FXDECLARE(GNEDistributionFrame::DistributionSelector)
 
        
        friend class DistributionValuesEditor;
 
    public:
        DistributionSelector(GNEFrame* frameParent);

        ~DistributionSelector();

        void setDistribution(GNEDemandElement* distribution);

        GNEDemandElement* getCurrentDistribution() const;

        void refreshDistributionIDs();

        void refreshDistributionSelector();


        long onCmdSelectDistribution(FXObject*, FXSelector, void*);

        long onCmdUpdateDistribution(FXObject* sender, FXSelector, void*);

 
    protected:
        FOX_CONSTRUCTOR(DistributionSelector)

        std::map<std::string, GNEDemandElement*> fillDistributionComboBox();
 
    private:
        GNEFrame* myFrameParent;

        DistributionEditor* myDistributionEditor = nullptr;

        GNEAttributesEditor* myAttributesEditor = nullptr;

        DistributionValuesEditor* myDistributionValuesEditor = nullptr;

        MFXComboBoxIcon* myDistributionsComboBox = nullptr;

        GNEDemandElement* myCurrentDistribution = nullptr;

        DistributionSelector(const DistributionSelector&) = delete;

        DistributionSelector& operator=(const DistributionSelector& src) = delete;
    };
 
    // ===========================================================================
    // class DistributionRow
    // ===========================================================================
 
    class DistributionRow : protected FXHorizontalFrame {
        FXDECLARE(GNEDistributionFrame::DistributionRow)
 
    public:
        DistributionRow(DistributionValuesEditor* attributeEditorParent, GNEDemandElement* distributionReference);

        void destroy();

        GNEDemandElement* getDistributionReference() const;

        MFXButtonTooltip* getDeleteRowButton() const;


        long onCmdSetProbability(FXObject*, FXSelector, void*);

 
    protected:
        FOX_CONSTRUCTOR(DistributionRow)
 
    private:
        DistributionValuesEditor* myDistributionValuesEditorParent;

        GNEDemandElement* myDistributionReference = nullptr;

        MFXButtonTooltip* myDeleteRowButton = nullptr;

        FXLabel* myIconLabel = nullptr;

        MFXTextFieldIcon* myIDTextField = nullptr;

        MFXTextFieldIcon* myProbabilityTextField = nullptr;

        DistributionRow(const DistributionRow&) = delete;

        DistributionRow& operator=(const DistributionRow& src) = delete;
    };
 
    // ===========================================================================
    // class DistributionValuesEditor
    // ===========================================================================
 
    class DistributionValuesEditor : public MFXGroupBoxModule {
        FXDECLARE(GNEDistributionFrame::DistributionValuesEditor)
 
        
        friend class DistributionRow;
 
    public:
        DistributionValuesEditor(GNEFrame* frameParent, DistributionEditor* distributionEditor,
                                 DistributionSelector* distributionSelector,
                                 GNEAttributesEditor* attributesEditor);

        void showDistributionValuesEditor();

        void hideDistributionValuesEditor();

        void refreshRows();

        GNEFrame* getFrameParent() const;


        long onCmdAddRow(FXObject*, FXSelector, void*);

        long onCmdRemoveRow(FXObject* obj, FXSelector, void*);

 
    protected:
        FOX_CONSTRUCTOR(DistributionValuesEditor)

        void updateSumLabel();
 
    private:
        GNEFrame* myFrameParent;

        DistributionEditor* myDistributionEditor;

        DistributionSelector* myDistributionSelector;

        GNEAttributesEditor* myAttributesEditor;

        std::vector<DistributionRow*> myDistributionRows;

        FXHorizontalFrame* myBotFrame = nullptr;

        MFXButtonTooltip* myAddButton = nullptr;

        FXLabel* mySumLabel = nullptr;

        DistributionValuesEditor(const DistributionValuesEditor&) = delete;

        DistributionValuesEditor& operator=(const DistributionValuesEditor& src) = delete;
    };
};