GNEDetector.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
/****************************************************************************/
// A abstract class to define common parameters of detectors placed over lanes
/****************************************************************************/
#ifndef GNEDetector_h
#define GNEDetector_h


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

#include "GNEAdditional.h"

// ===========================================================================
// class definitions
// ===========================================================================
class GNEDetector : public GNEAdditional {

public:
    GNEDetector(const std::string& id, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, GNELane* lane, double pos, double freq, const std::string& filename, const std::string& vehicleTypes, const std::string& name, bool friendlyPos, bool blockMovement);

    GNEDetector(GNEAdditional* additionalParent, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, GNELane* lane, double pos, double freq, const std::string& filename, const std::string& name, bool friendlyPos, bool blockMovement);

    ~GNEDetector();

    virtual bool isDetectorPositionFixed() const = 0;

    GNELane* getLane() const;

    double getPositionOverLane() const;


    void moveGeometry(const Position& oldPos, const Position& offset);

    void commitGeometryMoving(const Position& oldPos, GNEUndoList* undoList);

    virtual void updateGeometry(bool updateGrid) = 0;

    Position getPositionInView() const;


    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 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 asociated to key key
     * @return true if the value is valid, false in other case
     */
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;

    std::string getPopUpID() const;

    std::string getHierarchyName() const;

protected:
    GNELane* myLane;

    double myPositionOverLane;

    double myFreq;

    std::string myFilename;

    std::string myVehicleTypes;

    bool myFriendlyPosition;

private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;

    const Position& getPosition() const = delete;

    void setPosition(const Position& pos) = delete;
};

#endif

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