METriggeredCalibrator.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
/****************************************************************************/
// Calibrates the flow on a segment to a specified one
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <microsim/trigger/MSCalibrator.h>
#include <mesosim/MESegment.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class METriggeredCalibrator : public MSCalibrator {
public:
    METriggeredCalibrator(const std::string& id,
                          MSEdge* const edge, const double pos,
                          const std::string& aXMLFilename,
                          const std::string& outputFilename,
                          const SUMOTime freq, const double length,
                          const MSRouteProbe* probe,
                          const double invalidJamThreshold,
                          const std::string& vTypes);
 
    virtual ~METriggeredCalibrator();
 
 
    SUMOTime execute(SUMOTime currentTime);
 
protected:
 
    bool tryEmit(MESegment* s, MEVehicle* vehicle);
 
    inline int passed() const {
        // calibrator measures at start of segment
        return myEdgeMeanData.nVehEntered + myEdgeMeanData.nVehDeparted - myEdgeMeanData.nVehVaporized;
    }
 
    bool invalidJam() const;
 
    int remainingVehicleCapacity() const;
 
    void reset();
 
    void updateMeanData() {}
 
    inline int maximumInflow() const {
        return (int)std::ceil((double)myFrequency / (double)mySegment->getMinimumHeadwayTime());
    }
 
private:
    MESegment* mySegment;
 
};