ODMatrix.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2006-2026 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
/****************************************************************************/
// An O/D (origin/destination) matrix
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <iostream>
#include <sstream>
#include <fstream>
#include <vector>
#include <cstdlib>
#include <ctime>
#include <algorithm>
#include <set>
#include <string>
#include <utils/common/SUMOTime.h>
#include "ODCell.h"
#include "ODDistrictCont.h"
#include <utils/distribution/Distribution_Points.h>
#include <utils/importio/LineReader.h>
#include <utils/common/SUMOTime.h>
#include <utils/xml/SAXWeightsHandler.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class OptionsCont;
class OutputDevice;
class SUMOSAXHandler;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class ODMatrix : public SAXWeightsHandler::EdgeFloatTimeLineRetriever {
 
public:
    ODMatrix(const ODDistrictCont& dc, double scale);
 
 
    ~ODMatrix();
 
 
    bool add(double vehicleNumber, const std::pair<SUMOTime, SUMOTime>& beginEnd,
             const std::string& origin, const std::string& destination,
             const std::string& vehicleType,
             const bool originIsEdge = false, const bool destinationIsEdge = false,
             bool noScaling = false);
 
    bool add(const SUMOVehicleParameter& veh, bool originIsEdge = false, bool destinationIsEdgeconst = false);
 
    void writeDefaultAttrs(OutputDevice& dev, const bool noVtype,
                           const ODCell* const cell);
 
    void write(SUMOTime begin, const SUMOTime end,
               OutputDevice& dev, const bool uniform,
               const bool differSourceSink, const bool noVtype,
               const std::string& prefix, const bool stepLog,
               bool pedestrians, bool persontrips,
               const std::string& modes);
 
 
    void writeFlows(const SUMOTime begin, const SUMOTime end,
                    OutputDevice& dev, const bool noVtype,
                    const std::string& prefix,
                    bool asProbability = false,
                    bool asPoisson = false,
                    bool pedestrians = false, bool persontrips = false,
                    const std::string& modes = "");
 
 
    double getNumLoaded() const;
 
 
    double getNumWritten() const;
 
 
    double getNumDiscarded() const;
 
 
    void applyCurve(const Distribution_Points& ps);
 
 
    void readO(LineReader& lr, double scale,
               std::string vehType, bool matrixHasVehType);
 
    void readV(LineReader& lr, double scale,
               std::string vehType, bool matrixHasVehType);
 
    void loadMatrix(OptionsCont& oc);
 
    void loadRoutes(OptionsCont& oc, SUMOSAXHandler& handler);
 
    Distribution_Points parseTimeLine(const std::vector<std::string>& def, bool timelineDayInHours);
 
    const std::vector<ODCell*>& getCells() {
        return myContainer;
    }
 
    void sortByBeginTime();
 
    SUMOTime getBegin() const {
        return myBegin;
    }
 
    SUMOTime getEnd() const {
        return myEnd;
    }
 
    void addTazRelWeight(const std::string intervalID, const std::string& from, const std::string& to,
                         double val, double beg, double end);
 
protected:
    struct ODVehicle {
        std::string id;
        SUMOTime depart;
        ODCell* cell;
        std::string from;
        std::string to;
 
    };
 
 
    double computeDeparts(ODCell* cell,
                          int& vehName, std::vector<ODVehicle>& into,
                          const bool uniform, const bool differSourceSink,
                          const std::string& prefix);
 
 
    void applyCurve(const Distribution_Points& ps, ODCell* cell,
                    std::vector<ODCell*>& newCells);
 
 
private:
    std::string getNextNonCommentLine(LineReader& lr);
 
    SUMOTime parseSingleTime(const std::string& time);
 
    std::pair<SUMOTime, SUMOTime> readTime(LineReader& lr);
 
    double readFactor(LineReader& lr, double scale);
 
 
private:
    std::vector<ODCell*> myContainer;
 
    std::map<const std::pair<const std::string, const std::string>, std::vector<ODCell*> > myShortCut;
 
    const ODDistrictCont& myDistricts;
 
    std::set<std::string> myMissingDistricts;
 
    double myNumLoaded;
 
    double myNumWritten;
 
    double myNumDiscarded;
 
    SUMOTime myBegin, myEnd;
 
    std::string myVType;
 
    double myScale;
 
    class cell_by_begin_comparator {
    public:
        explicit cell_by_begin_comparator() { }
 
 
        int operator()(ODCell* p1, ODCell* p2) const {
            if (p1->begin == p2->begin) {
                if (p1->origin == p2->origin) {
                    return p1->destination < p2->destination;
                }
                return p1->origin < p2->origin;
            }
            return p1->begin < p2->begin;
        }
 
    };
 
 
    class descending_departure_comperator {
    public:
        descending_departure_comperator() { }
 
 
        bool operator()(const ODVehicle& p1, const ODVehicle& p2) const {
            if (p1.depart == p2.depart) {
                return p1.id > p2.id;
            }
            return p1.depart > p2.depart;
        }
 
    };
 
private:
    ODMatrix(const ODMatrix& s);
 
    ODMatrix& operator=(const ODMatrix& s) = delete;
 
};