GNERouteProbe.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2017 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
//
/****************************************************************************/
//
/****************************************************************************/
#ifndef GNERouteProbe_h
#define GNERouteProbe_h


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

#include "GNEAdditional.h"


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

public:
    GNERouteProbe(const std::string& id, GNEViewNet* viewNet, GNEEdge* edge, double frequency, const std::string& filename, double begin);

    ~GNERouteProbe();

    void writeAdditional(OutputDevice& device) const;

    const std::string& getFilename() const;

    double getFrequency() const;

    double getBegin() const;

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

    void setFrequency(double frequency);

    void setBegin(double begin);


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

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

    void updateGeometry();

    Position getPositionInView() const;

    const std::string& getParentName() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) 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
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @brief method for checking if the key and their correspond 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
     */
    bool isValid(SumoXMLAttr key, const std::string& value);

protected:
    GNEEdge* myEdge;

    double myFrequency;

    std::string myFilename;

    double myBegin;

    Position myRouteProbeLogoOffset;

    int myNumberOfLanes;

    int myRelativePositionY;

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

    GNERouteProbe(const GNERouteProbe&);

    GNERouteProbe& operator=(const GNERouteProbe&);
};

#endif

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