GNECalibrator.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 GNECalibrator_h
#define GNECalibrator_h


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

#include "GNEAdditional.h"
#include "GNECalibratorRoute.h"
#include "GNECalibratorFlow.h"
#include "GNECalibratorVehicleType.h"

// ===========================================================================
// class declaration
// ===========================================================================

class GNERouteProbe;

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

    GNECalibrator(const std::string& id, GNELane* lane, GNEViewNet* viewNet, double pos, double frequency, const std::string& output,
                  const std::vector<GNECalibratorRoute>& calibratorRoutes, const std::vector<GNECalibratorFlow>& calibratorFlows,
                  const std::vector<GNECalibratorVehicleType>& calibratorVehicleTypes);

    ~GNECalibrator();

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

    void openAdditionalDialog();

    void addCalibratorVehicleType(const GNECalibratorVehicleType& vehicleType);

    void addCalibratorFlow(const GNECalibratorFlow& flow);

    void addCalibratorRoute(const GNECalibratorRoute& route);

    const std::vector<GNECalibratorVehicleType>& getCalibratorVehicleTypes() const;

    const std::vector<GNECalibratorFlow>& getCalibratorFlows() const;

    const std::vector<GNECalibratorRoute>& getCalibratorRoutes() const;

    void setCalibratorVehicleTypes(const std::vector<GNECalibratorVehicleType>& calibratorVehicleType);

    void setCalibratorFlows(const std::vector<GNECalibratorFlow>& calibratorFlows);

    void setCalibratorRoutes(const std::vector<GNECalibratorRoute>& calibratorRoutes);

    std::string generateVehicleTypeID() const;

    std::string generateFlowID() const;

    std::string generateRouteID() const;

    bool vehicleTypeExists(std::string vehicleTypeID) const;

    bool flowExists(std::string flowID) const;

    bool routeExists(std::string routeID) const;

    const GNECalibratorVehicleType& getCalibratorVehicleType(const std::string& vehicleTypeID);

    const GNECalibratorFlow& getCalibratorFlow(const std::string& flowID);

    const GNECalibratorRoute& getCalibratorRoute(const std::string& routeID);


    void moveGeometry(const Position& newPosition);

    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:
    double myPositionOverLane;

    double myFrequency;

    std::string myOutput;

    GNERouteProbe* myRouteProbe;

    std::vector<GNECalibratorRoute> myCalibratorRoutes;

    std::vector<GNECalibratorFlow> myCalibratorFlows;

    std::vector<GNECalibratorVehicleType> myCalibratorVehicleTypes;

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

    GNECalibrator(const GNECalibrator&);

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

#endif
/****************************************************************************/