GNEAdditionalFrame.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// The Widget for add additional elements
/****************************************************************************/
#ifndef GNEAdditionalFrame_h
#define GNEAdditionalFrame_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include "GNEFrame.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GNEAttributeCarrier;
class GNENetElement;
class GNEAdditional;

// ===========================================================================
// class definitions
// ===========================================================================
class GNEAdditionalFrame : public GNEFrame {

public:

    enum AddAdditionalResult {
        ADDADDITIONAL_INVALID_ARGUMENTS,    // Parameters of additionals are invalid
        ADDADDITIONAL_INVALID_PARENT,       // NetElement parent is invalid
        ADDADDITIONAL_SUCCESS               // additional was successfully created
    };

    class AdditionalAttributes;

    // ===========================================================================
    // class AdditionalSelector
    // ===========================================================================

    class AdditionalSelector : protected FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::AdditionalSelector)

    public:
        AdditionalSelector(GNEAdditionalFrame* additionalFrameParent);

        ~AdditionalSelector();

        SumoXMLTag getCurrentAdditionalType() const;

        void setCurrentAdditional(SumoXMLTag actualAdditionalType);

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

    protected:
        AdditionalSelector() {}

    private:
        GNEAdditionalFrame* myAdditionalFrameParent;

        FXComboBox* myAdditionalMatchBox;

        SumoXMLTag myCurrentAdditionalType;
    };

    // ===========================================================================
    // class AdditionalAttributeSingle
    // ===========================================================================

    class AdditionalAttributeSingle : protected FXHorizontalFrame {
        FXDECLARE(GNEAdditionalFrame::AdditionalAttributeSingle)

    public:
        AdditionalAttributeSingle(AdditionalAttributes* additionalAttributesParent);

        ~AdditionalAttributeSingle();

        void showParameter(SumoXMLAttr additionalAttr, std::string value);

        void hideParameter();

        SumoXMLAttr getAttr() const;

        std::string getValue() const;

        const std::string& isAttributeValid() const;

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

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

    protected:
        AdditionalAttributeSingle() {}

    private:
        AdditionalAttributes* myAdditionalAttributesParent;

        SumoXMLAttr myAdditionalAttr;

        FXLabel* myLabel;

        FXTextField* myTextFieldInt;

        FXTextField* myTextFieldReal;

        FXTextField* myTextFieldStrings;

        FXCheckButton* myBoolCheckButton;

        std::string myInvalidValue;
    };

    // ===========================================================================
    // class AdditionalAttributes
    // ===========================================================================

    class AdditionalAttributes : protected FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::AdditionalAttributes)

        
        friend class AdditionalAttributeSingle;

    public:
        AdditionalAttributes(GNEAdditionalFrame* additionalFrameParent);

        ~AdditionalAttributes();

        void clearAttributes();

        void addAttribute(SumoXMLAttr AdditionalAttributeSingle);

        void showAdditionalParameters();

        void hideAdditionalParameters();

        std::map<SumoXMLAttr, std::string> getAttributesAndValues() const;

        bool areValuesValid() const;

        void showWarningMessage(std::string extra = "") const;

        GNEAdditionalFrame* getAdditionalFrameParent() const;

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

    protected:
        AdditionalAttributes() {}

    private:
        GNEAdditionalFrame* myAdditionalFrameParent;

        std::vector<AdditionalAttributeSingle*> myVectorOfsingleAdditionalParameter;

    };

    // ===========================================================================
    // class NeteditAttributes
    // ===========================================================================

    class NeteditAttributes : protected FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::NeteditAttributes)

    public:
        enum additionalReferencePoint {
            GNE_ADDITIONALREFERENCEPOINT_LEFT,
            GNE_ADDITIONALREFERENCEPOINT_RIGHT,
            GNE_ADDITIONALREFERENCEPOINT_CENTER,
            GNE_ADDITIONALREFERENCEPOINT_INVALID
        };

        NeteditAttributes(GNEAdditionalFrame* additionalFrameParent);

        ~NeteditAttributes();

        void showNeteditAttributes(bool includeLengthAndReferencePoint);

        void hideNeteditAttributes();

        additionalReferencePoint getActualReferencePoint() const;

        double getLength() const;

        bool isBlockEnabled() const;

        bool isCurrentLengthValid() const;

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

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

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

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

    protected:
        NeteditAttributes() {}

    private:
        FXComboBox* myReferencePointMatchBox;

        FXButton* helpReferencePoint;

        additionalReferencePoint myActualAdditionalReferencePoint;

        FXLabel* myLengthLabel;

        FXTextField* myLengthTextField;

        FXLabel* myBlockLabel;

        FXCheckButton* myBlockMovementCheckButton;

        bool myCurrentLengthValid;
    };

    // ===========================================================================
    // class SelectorParentAdditional
    // ===========================================================================

    class SelectorParentAdditional : protected FXGroupBox {
    public:
        SelectorParentAdditional(GNEAdditionalFrame* additionalFrameParent);

        ~SelectorParentAdditional();

        std::string getIdSelected() const;

        void setIDSelected(const std::string& id);

        void showListOfAdditionalParents(SumoXMLTag additionalTypeParent);

        void hideListOfAdditionalParents();

        void refreshListOfAdditionalParents();

    private:
        GNEAdditionalFrame* myAdditionalFrameParent;

        SumoXMLTag myAdditionalTypeParent;

        FXLabel* myFirstAdditionalParentsLabel;

        FXList* myFirstAdditionalParentsList;
    };

    // ===========================================================================
    // class SelectorParentEdges
    // ===========================================================================

    class SelectorParentEdges : protected FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::SelectorParentEdges)

    public:
        SelectorParentEdges(GNEAdditionalFrame* additionalFrameParent);

        ~SelectorParentEdges();

        std::string getIdsSelected() const;

        void showList(std::string search = "");

        void hideList();

        void updateUseSelectedEdges();

        bool isUseSelectedEdgesEnable() const;

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

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

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

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

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

    protected:
        SelectorParentEdges() {}

    private:
        GNEAdditionalFrame* myAdditionalFrameParent;

        FXCheckButton* myUseSelectedEdgesCheckButton;

        FXList* myList;

        FXTextField* myEdgesSearch;

        FXButton* myClearEdgesSelection;

        FXButton* myInvertEdgesSelection;
    };

    // ===========================================================================
    // class SelectorParentLanes
    // ===========================================================================

    class SelectorParentLanes : protected FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::SelectorParentLanes)

    public:
        SelectorParentLanes(GNEAdditionalFrame* additionalFrameParent);

        ~SelectorParentLanes();

        std::string getIdsSelected() const;

        void showList(std::string search = "");

        void hideList();

        // @brief Update use selectedLanes
        void updateUseSelectedLanes();

        bool isUseSelectedLanesEnable() const;

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

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

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

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

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

    protected:
        SelectorParentLanes() {}

    private:
        GNEAdditionalFrame* myAdditionalFrameParent;

        FXCheckButton* myUseSelectedLanesCheckButton;

        FXList* myList;

        FXTextField* myLanesSearch;

        FXButton* clearLanesSelection;

        FXButton* invertLanesSelection;
    };

    GNEAdditionalFrame(FXHorizontalFrame* horizontalFrameParent, GNEViewNet* viewNet);

    ~GNEAdditionalFrame();

    AddAdditionalResult addAdditional(GNENetElement* netElement, GNEAdditional* additional);

    void removeAdditional(GNEAdditional* additional);

    void show();

    static std::string getIdsSelected(const FXList* list);

protected:
    AdditionalSelector* getAdditionalSelector() const;

    AdditionalAttributes* getAdditionalParameters() const;

    NeteditAttributes* getNeteditAttributes() const;

    SelectorParentAdditional* getAdditionalParentSelector() const;

    SelectorParentEdges* getEdgeParentsSelector() const;

    SelectorParentLanes* getLaneParentsSelector() const;

private:
    std::string generateID(GNENetElement* netElement) const;

    double setStartPosition(double positionOfTheMouseOverLane, double lengthOfAdditional);

    double setEndPosition(double laneLength, double positionOfTheMouseOverLane, double lengthOfAdditional);

    GNEAdditionalFrame::AdditionalSelector* myAdditionalSelector;

    GNEAdditionalFrame::AdditionalAttributes* myAdditionalParameters;

    GNEAdditionalFrame::NeteditAttributes* myNeteditParameters;

    GNEAdditionalFrame::SelectorParentAdditional* myFirstAdditionalParentSelector;

    GNEAdditionalFrame::SelectorParentEdges* myEdgeParentsSelector;

    GNEAdditionalFrame::SelectorParentLanes* myLaneParentsSelector;
};


#endif

/****************************************************************************/