MSRouteProbe.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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
/****************************************************************************/
// Writes route distributions at a certain edge
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <microsim/output/MSDetectorFileOutput.h>
#include <microsim/MSMoveReminder.h>
#include <utils/distribution/RandomDistributor.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class MSRoute;
class MSVehicle;
class OutputDevice;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSRouteProbe : public MSDetectorFileOutput, public MSMoveReminder {
public:
    MSRouteProbe(const std::string& id, const MSEdge* edge,
                 const std::string& distID, const std::string& lastID,
                 const std::string& vTypes);
 
 
    virtual ~MSRouteProbe();
 
 
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0) override;
 
 
 
    void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime) override;
 
 
    void writeXMLDetectorProlog(OutputDevice& dev) const override;
 
    /* @brief sample a route from the routeDistribution
     * @param[in] last Retrieve route from the previous (complete) collection interval
     */
    ConstMSRoutePtr sampleRoute(bool last = true) const;
 
    const MSEdge* getEdge() {
        return myEdge;
    }
 
    void clearState(SUMOTime step) override;
 
private:
    void initDistributions();
 
private:
    std::string myDistID;
    std::string myLastID;
 
    RandomDistributor<ConstMSRoutePtr>* myLastRouteDistribution;
 
    RandomDistributor<ConstMSRoutePtr>* myCurrentRouteDistribution;
 
    const MSEdge* myEdge;
 
 
private:
    MSRouteProbe(const MSRouteProbe&);
 
    MSRouteProbe& operator=(const MSRouteProbe&);
 
 
};