GNEAdditionalFrame.h

Go to the documentation of this file.

/****************************************************************************/
// The Widget for add additional elements
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GNEAdditionalFrame_h
#define GNEAdditionalFrame_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include "GNEFrame.h"

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

// ===========================================================================
// class definitions
// ===========================================================================
class GNEAdditionalFrame : public GNEFrame {
    FXDECLARE(GNEAdditionalFrame)

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 AdditionalAttributeSingle
    // ===========================================================================

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

    public:
        AdditionalAttributeSingle(FXComposite* parent);

        ~AdditionalAttributeSingle();

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

        void showParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, int value);

        void showParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, double value);

        void showParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, bool value);

        void hideParameter();

        SumoXMLTag getTag() const;

        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:
        SumoXMLTag myAdditionalTag;

        SumoXMLAttr myAdditionalAttr;

        FXLabel* myLabel;

        FXTextField* myTextFieldInt;

        FXTextField* myTextFieldReal;

        FXTextField* myTextFieldStrings;

        FXCheckButton* myBoolCheckButton;

        std::string myInvalidValue;
    };

    // ===========================================================================
    // class AdditionalAttributeList
    // ===========================================================================

    class AdditionalAttributeList : public FXVerticalFrame {
        FXDECLARE(GNEAdditionalFrame::AdditionalAttributeList)

    public:
        AdditionalAttributeList(FXComposite* parent);

        ~AdditionalAttributeList();

        void showListParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, std::vector<int> value);

        void showListParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, std::vector<double> value, bool isTime = false);

        void showListParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, std::vector<bool> value);

        void showListParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, std::vector<std::string> value);

        void hideParameter();

        SumoXMLTag getTag() const;

        SumoXMLAttr getAttr() const;

        std::string getListValues();

        bool isCurrentListValid() const;

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

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

    protected:
        AdditionalAttributeList() {}

    private:
        SumoXMLTag myAdditionalTag;

        SumoXMLAttr myAdditionalAttr;

        std::vector<FXHorizontalFrame*>myHorizontalFrames;

        std::vector<FXLabel*> myLabels;

        std::vector<FXTextField*> myTextFields;

        FXHorizontalFrame* myHorizontalFrameButtons;

        FXButton* myAddButton;

        FXButton* myRemoveButton;

        int myNumberOfVisibleTextfields;

        int myMaxNumberOfValuesInParameterList;
    };

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

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

    public:
        AdditionalAttributes(GNEViewNet* viewNet, FXComposite* parent);

        ~AdditionalAttributes();

        void clearAttributes();

        void addAttribute(SumoXMLTag additionalTag, SumoXMLAttr AdditionalAttributeSingle);

        void showAdditionalParameters();

        void hideAdditionalParameters();

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

        bool areValuesValid() const;

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

        int getNumberOfAddedAttributes() const;

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

    protected:
        AdditionalAttributes() {}

    private:
        GNEViewNet* myViewNet;

        SumoXMLTag myAdditionalTag;

        std::vector<AdditionalAttributeSingle*> myVectorOfsingleAdditionalParameter;

        int myIndexParameter;

        std::vector<AdditionalAttributeList*> myVectorOfsingleAdditionalParameterList;

        int myIndexParameterList;

        int maxNumberOfParameters;

        int maxNumberOfListParameters;

        FXButton* helpAdditional;
    };

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

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

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

        NeteditAttributes(FXComposite* parent);

        ~NeteditAttributes();

        void showLengthFieldAndReferecePoint();

        void hideLengthFieldAndReferecePoint();

        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 : public FXGroupBox {
        FXDECLARE(GNEAdditionalFrame::SelectorParentAdditional)

    public:
        SelectorParentAdditional(FXComposite* parent, GNEViewNet* viewNet);

        ~SelectorParentAdditional();

        std::string getIdSelected() const;

        void showListOfAdditionals(SumoXMLTag type, bool uniqueSelection);

        void hideListOfAdditionals();

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

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

    protected:
        SelectorParentAdditional() {}

    private:

        FXList* myList;

        FXLabel* mySetLabel;

        bool myUniqueSelection;

        FXButton* myHelpAdditionalParentSelector;

        GNEViewNet* myViewNet;
    };

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

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

    public:
        SelectorParentEdges(FXComposite* parent, GNEViewNet* viewNet);

        ~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*);

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

    protected:
        SelectorParentEdges() {}

    private:
        FXCheckButton* myUseSelectedEdgesCheckButton;

        FXList* myList;

        FXTextField* myEdgesSearch;

        FXButton* myHelpedgeParentsSelector;

        FXButton* myClearEdgesSelection;

        FXButton* myInvertEdgesSelection;

        GNEViewNet* myViewNet;
    };

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

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

    public:
        SelectorParentLanes(FXComposite* parent, GNEViewNet* viewNet);

        ~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*);

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

    protected:
        SelectorParentLanes() {}

    private:
        FXCheckButton* myUseSelectedLanesCheckButton;

        FXList* myList;

        FXTextField* myLanesSearch;

        FXButton* helpLanes;

        FXButton* clearLanesSelection;

        FXButton* invertLanesSelection;

        GNEViewNet* myViewNet;
    };

    GNEAdditionalFrame(FXHorizontalFrame* horizontalFrameParent, GNEViewNet* viewNet);

    ~GNEAdditionalFrame();

    AddAdditionalResult addAdditional(GNENetElement* netElement, GUISUMOAbstractView* abstractViewParent);

    void removeAdditional(GNEAdditional* additional);

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

    void show();

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

protected:
    GNEAdditionalFrame() {}

private:
    void setParametersOfAdditional(SumoXMLTag actualAdditionalType);

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

    double setStartPosition(double positionOfTheMouseOverLane, double lengthOfAdditional);

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

    FXGroupBox* myGroupBoxForMyAdditionalMatchBox;

    FXComboBox* myAdditionalMatchBox;

    GNEAdditionalFrame::AdditionalAttributes* myadditionalParameters;

    GNEAdditionalFrame::NeteditAttributes* myEditorParameters;

    GNEAdditionalFrame::SelectorParentAdditional* myAdditionalParentSelector;

    GNEAdditionalFrame::SelectorParentEdges* myedgeParentsSelector;

    GNEAdditionalFrame::SelectorParentLanes* mylaneParentsSelector;

    SumoXMLTag myActualAdditionalType;
};


#endif

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