MSDetectorFileOutput.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// Base of value-generating classes (detectors)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <set>
 
#include <utils/common/Named.h>
#include <utils/common/Parameterised.h>
#include <utils/common/SUMOTime.h>
#include <microsim/MSNet.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class SUMOSAXAttributes;
class GUIDetectorWrapper;
class SUMOTrafficObject;
class MSTransportable;
class MSEdge;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
enum DetectorUsage {
    DU_USER_DEFINED,
    DU_SUMO_INTERNAL,
    DU_TL_CONTROL
};
 
class MSDetectorFileOutput : public Named, public Parameterised {
public:
    MSDetectorFileOutput(const std::string& id, const std::string& vTypes, const std::string& nextEdges = "", const int detectPersons = 0);
 
    virtual ~MSDetectorFileOutput() { }
 
 
 
    virtual void writeXMLOutput(OutputDevice& dev,
                                SUMOTime startTime, SUMOTime stopTime) = 0;
 
 
    virtual void writeXMLDetectorProlog(OutputDevice& dev) const = 0;
 
 
    virtual void reset() { }
 
 
    virtual void detectorUpdate(const SUMOTime step) {
        UNUSED_PARAMETER(step);
    }
 
 
    virtual GUIDetectorWrapper* buildDetectorGUIRepresentation() {
        return 0;
    }
 
 
    bool vehicleApplies(const SUMOTrafficObject& veh) const;
 
    bool personApplies(const MSTransportable& p, int dir) const;
 
 
    bool isTyped() const {
        return !myVehicleTypes.empty();
    }
 
    const std::set<std::string>& getVehicleTypes() const {
        return myVehicleTypes;
    }
 
    inline bool detectsPersons() const {
        return myDetectPersons != 0;
    }
 
    virtual void clearState(SUMOTime /*step*/) {};
 
    virtual void saveState(OutputDevice& /*out*/) const {}
 
    virtual void loadState(const SUMOSAXAttributes& /*attrs*/, const SUMOTime /*offset*/) {}
 
protected:
    std::set<std::string> myVehicleTypes;
 
    std::vector<const MSEdge*> myNextEdges;
 
    const int myDetectPersons;
 
private:
    MSDetectorFileOutput(const MSDetectorFileOutput&);
 
    MSDetectorFileOutput& operator=(const MSDetectorFileOutput&);
 
 
};