GNEStoppingPlace.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
/****************************************************************************/
// A abstract class to define common parameters of lane area in which vehicles can halt (GNE version)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "GNEAdditional.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEStoppingPlace : public GNEAdditional, public Parameterised {
 
public:
    GNEStoppingPlace(GNENet* net, SumoXMLTag tag);
 
    GNEStoppingPlace(const std::string& id, GNENet* net, const std::string& filename, SumoXMLTag tag, GNELane* lane,
                     const double startPos, const double endPos, const std::string& name, bool friendlyPosition,
                     const RGBColor& color, const Parameterised::Map& parameters);
 
    ~GNEStoppingPlace();
 
    GNEMoveOperation* getMoveOperation();
 
 
    virtual void writeAdditional(OutputDevice& device) const = 0;
 
    bool isAdditionalValid() const;
 
    std::string getAdditionalProblem() const;
 
    void fixAdditionalProblem();
 
 
 
    bool checkDrawMoveContour() const;
 
 
    virtual void updateGeometry() = 0;
 
    Position getPositionInView() const;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
 
 
    std::string getParentName() const;
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
 
    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    virtual std::string getAttribute(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual double getAttributeDouble(SumoXMLAttr key) const = 0;
 
    const Parameterised::Map& getACParametersMap() const;
 
    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    /* @brief method for checking if the key and their conrrespond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value associated to key key
     * @return true if the value is valid, false in other case
     */
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const;
 
    std::string getPopUpID() const;
 
    std::string getHierarchyName() const;
 
 
protected:
    double myStartPosition = 0;
 
    double myEndPosition = 0;
 
    bool myFriendlyPosition = false;
 
    RGBColor myColor = RGBColor::INVISIBLE;
 
    double mySize = 10;
 
    bool myForceSize = false;
 
    ReferencePosition myReferencePosition = ReferencePosition::CENTER;
 
    Position mySymbolPosition;
 
    GNEContour mySymbolContour;
 
 
    void writeStoppingPlaceAttributes(OutputDevice& device) const;
 
    /* @brief method for getting the stoppingPlace attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getStoppingPlaceAttribute(const Parameterised* parameterised, SumoXMLAttr key) const;
 
    /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getStoppingPlaceAttributeDouble(SumoXMLAttr key) const;
 
    /* @brief method for setting the stoppingPlace attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setStoppingPlaceAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    /* @brief method for check if new value for certain stoppingPlace attribute is valid
     * @param[in] key The attribute key
     * @param[in] value The new value
     */
    bool isStoppingPlaceValid(SumoXMLAttr key, const std::string& value) const;
 
    void setStoppingPlaceAttribute(Parameterised* parameterised, SumoXMLAttr key, const std::string& value);
 
 
    void setStoppingPlaceGeometry(double movingToSide);
 
    void drawLines(const GUIVisualizationSettings::Detail d, const std::vector<std::string>& lines,
                   const RGBColor& color) const;
 
    void drawSign(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const double exaggeration,
                  const RGBColor& baseColor, const RGBColor& signColor, const std::string& word) const;
 
    void calculateStoppingPlaceContour(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                       const double width, const double exaggeration, const bool movingGeometryPoints) const;
 
private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    double getStartGeometryPositionOverLane() const;
 
    double getEndGeometryPositionOverLane() const;
 
    void setMoveShape(const GNEMoveResult& moveResult);
 
    void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
 
    void adjustLenght(const double length, GNEUndoList* undoList);
 
    void setPosition(const Position& pos) = delete;
};
class GNEStoppingPlace : public GNEAdditional, public Parameterised {…};