MSDetectorControl.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
/****************************************************************************/
// Detectors container; responsible for string and output generation
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <utils/common/NamedObjectCont.h>
#include <utils/xml/SUMOXMLDefinitions.h>
#include <microsim/output/MSE2Collector.h>
#include <microsim/output/MSE3Collector.h>
#include <microsim/output/MSInductLoop.h>
#include <microsim/output/MSRouteProbe.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSMeanData;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDetectorControl {
public:
    MSDetectorControl();
 
 
    ~MSDetectorControl();
 
 
    void close(SUMOTime step);
 
 
    void add(SumoXMLTag type, MSDetectorFileOutput* d, const std::string& device, SUMOTime interval, SUMOTime begin = -1);
 
 
 
    void add(SumoXMLTag type, MSDetectorFileOutput* d);
 
 
    void add(MSMeanData* mn, const std::string& device,
             SUMOTime frequency, SUMOTime begin);
 
 
 
    void addDetectorAndInterval(MSDetectorFileOutput* det,
                                OutputDevice* device,
                                SUMOTime interval, SUMOTime begin = -1);
 
 
 
    const std::vector<SumoXMLTag> getAvailableTypes() const;
 
 
    const NamedObjectCont<MSDetectorFileOutput*>& getTypedDetectors(SumoXMLTag type) const;
 
    const std::map<std::string, std::vector<MSMeanData*> >& getMeanData() const {
        return myMeanData;
    }
 
    void updateDetectors(const SUMOTime step);
 
 
    void writeOutput(SUMOTime step, bool closing);
 
    void clearState(SUMOTime step);
 
protected:
 
    typedef std::pair< MSDetectorFileOutput*, OutputDevice* > DetectorFilePair;
 
    typedef std::vector< DetectorFilePair > DetectorFileVec;
 
    typedef std::pair<SUMOTime, SUMOTime> IntervalsKey;
 
    typedef std::map< IntervalsKey, DetectorFileVec > Intervals;
 
protected:
    std::map<SumoXMLTag, NamedObjectCont< MSDetectorFileOutput*> > myDetectors;
 
    Intervals myIntervals;
 
    std::map<IntervalsKey, SUMOTime> myLastCalls;
 
    std::map<std::string, std::vector<MSMeanData*> > myMeanData;
 
    NamedObjectCont< MSDetectorFileOutput*> myEmptyContainer;
 
 
private:
    MSDetectorControl(const MSDetectorControl&);
 
    MSDetectorControl& operator=(const MSDetectorControl&);
 
 
};