GNEDetector.h

Go to the documentation of this file.

/****************************************************************************/
// A abstract class to define common parameters of detectors
/****************************************************************************/
// 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 GNEDetector_h
#define GNEDetector_h


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

#include "GNEAdditional.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GNEAdditional;
class GNEViewNet;

// ===========================================================================
// class definitions
// ===========================================================================
class GNEDetector : public GNEAdditional {
public:
    GNEDetector(const std::string& id, GNEViewNet* viewNet, SumoXMLTag tag, GUIIcon icon, GNELane* lane, double pos, double freq, const std::string& filename, bool friendlyPos);

    ~GNEDetector();

    virtual void writeAdditional(OutputDevice& device, bool volatileOptionsEnabled) const = 0;

    virtual bool isDetectorPositionFixed() const = 0;

    double getFrequency() const;

    const std::string& getFilename() const;

    void setFrequency(const double freq);

    void setFilename(const std::string& filename);

    double getAbsolutePositionOverLane() const;


    void moveGeometry(const Position& newPosition);

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

    virtual void updateGeometry() = 0;

    Position getPositionInView() const;


    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;

protected:
    double myPositionOverLane;

    double myFreq;

    std::string myFilename;

    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

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