GNEAdditionalFrame.h

Go to the documentation of this file.

/****************************************************************************/
/****************************************************************************/
// 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:

    // ===========================================================================
    // class singleAdditionalParameter
    // ===========================================================================

    class singleAdditionalParameter : public FXMatrix {
        FXDECLARE(GNEAdditionalFrame::singleAdditionalParameter)

    public:
        singleAdditionalParameter(FXComposite* parent);

        ~singleAdditionalParameter();

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

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

        void showParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, SUMOReal value, bool isTime = false);

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

        void hideParameter();

        SumoXMLTag getTag() const;

        SumoXMLAttr getAttr() const;

        std::string getValue() const;

        bool isCurrentValueValid() const;

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

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

    protected:
        singleAdditionalParameter() {}

    private:
        SumoXMLTag myAdditionalTag;

        SumoXMLAttr myAdditionalAttr;

        FXLabel* myLabel;

        FXTextField* myTextField;

        FXSpinner* myTimeSpinDial;

        FXMenuCheck* myMenuCheck;

        bool myCurrentValueValid;
    };

    // ===========================================================================
    // class singleAdditionalParameterList
    // ===========================================================================

    class singleAdditionalParameterList : public FXMatrix {
        FXDECLARE(GNEAdditionalFrame::singleAdditionalParameterList)

    public:
        singleAdditionalParameterList(FXComposite* parent);

        ~singleAdditionalParameterList();

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

        void showListParameter(SumoXMLTag additionalTag, SumoXMLAttr additionalAttr, std::vector<SUMOReal> 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:
        singleAdditionalParameterList() {}

    private:
        SumoXMLTag myAdditionalTag;

        SumoXMLAttr myAdditionalAttr;

        std::vector<FXLabel*> myLabels;

        std::vector<FXTextField*> myTextFields;

        FXButton* add;

        FXButton* remove;

        int numberOfVisibleTextfields;

        int myMaxNumberOfValuesInParameterList;
    };

    // ===========================================================================
    // class additionalParameters
    // ===========================================================================

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

    public:
        additionalParameters(FXComposite* parent);

        ~additionalParameters();

        void clearAttributes();

        void addAttribute(SumoXMLTag additionalTag, SumoXMLAttr additionalAttribute);

        void showAdditionalParameters();

        void hideAdditionalParameters();

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

        bool isValuesValid() const;

        int getNumberOfAddedAttributes() const;

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

    protected:
        additionalParameters() {}

    private:
        SumoXMLTag myAdditionalTag;

        std::vector<singleAdditionalParameter*> myVectorOfsingleAdditionalParameter;

        int myIndexParameter;

        std::vector<singleAdditionalParameterList*> myVectorOfsingleAdditionalParameterList;

        int myIndexParameterList;

        int maxNumberOfParameters;

        int maxNumberOfListParameters;

        FXButton* helpAdditional;
    };

    // ===========================================================================
    // class editorParameters
    // ===========================================================================

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

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

        editorParameters(FXComposite* parent);

        ~editorParameters();

        void showLengthField();

        void hideLengthField();

        void showReferencePoint();

        void hideReferencePoint();

        additionalReferencePoint getActualReferencePoint();

        SUMOReal getLenght();

        bool isBlockEnabled();

        bool isForcePositionEnabled();

        bool isCurrentLenghtValid() const;

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

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

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

    protected:
        editorParameters() {}

    private:
        FXComboBox* myReferencePointMatchBox;

        FXButton* helpReferencePoint;

        additionalReferencePoint myActualAdditionalReferencePoint;

        FXLabel* myLengthLabel;

        FXTextField* myLengthTextField;

        FXMenuCheck* myCheckForcePosition;

        FXMenuCheck* myCheckBlock;

        bool myCurrentLengthValid;
    };

    // ===========================================================================
    // class additionalParentSelector
    // ===========================================================================

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

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

        ~additionalParentSelector();

        std::string getIdSelected() const;

        void showListOfAdditionals(SumoXMLTag type, bool uniqueSelection);

        void hideListOfAdditionals();

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

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

    protected:
        additionalParentSelector() {}

    private:

        FXList* myList;

        FXLabel* mySetLabel;

        bool myUniqueSelection;

        FXButton* myHelpAdditionalParentSelector;

        GNEViewNet* myViewNet;
    };

    // ===========================================================================
    // class edgeParentsSelector
    // ===========================================================================

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

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

        ~edgeParentsSelector();

        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:
        edgeParentsSelector() {}

    private:
        FXMenuCheck* myUseSelectedEdges;

        FXList* myList;

        FXTextField* myEdgesSearch;

        FXButton* myHelpedgeParentsSelector;

        FXButton* myClearEdgesSelection;

        FXButton* myInvertEdgesSelection;

        GNEViewNet* myViewNet;
    };

    // ===========================================================================
    // class laneParentsSelector
    // ===========================================================================

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

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

        ~laneParentsSelector();

        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:
        laneParentsSelector() {}

    private:
        FXMenuCheck* myUseSelectedLanes;

        FXList* myList;

        FXTextField* myLanesSearch;

        FXButton* helpLanes;

        FXButton* clearLanesSelection;

        FXButton* invertLanesSelection;

        GNEViewNet* myViewNet;
    };

    GNEAdditionalFrame(FXHorizontalFrame* horizontalFrameParent, GNEViewNet* viewNet);

    ~GNEAdditionalFrame();

    bool addAdditional(GNENetElement* netElement, GUISUMOAbstractView* parent);

    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;

    SUMOReal setStartPosition(SUMOReal positionOfTheMouseOverLane, SUMOReal lenghtOfAdditional);

    SUMOReal setEndPosition(SUMOReal laneLenght, SUMOReal positionOfTheMouseOverLane, SUMOReal lenghtOfAdditional);

    FXGroupBox* myGroupBoxForMyAdditionalMatchBox;

    FXComboBox* myAdditionalMatchBox;

    GNEAdditionalFrame::additionalParameters* myadditionalParameters;

    GNEAdditionalFrame::editorParameters* myEditorParameters;

    GNEAdditionalFrame::additionalParentSelector* myAdditionalParentSelector;

    GNEAdditionalFrame::edgeParentsSelector* myedgeParentsSelector;

    GNEAdditionalFrame::laneParentsSelector* mylaneParentsSelector;

    SumoXMLTag myActualAdditionalType;
};


#endif

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