MSDetectorControl.h

Go to the documentation of this file.

/****************************************************************************/
// Detectors container; responsible for string and output generation
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSDetectorControl_h
#define MSDetectorControl_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <vector>
#include <utils/common/NamedObjectCont.h>
#include <utils/xml/SUMOXMLDefinitions.h>
#include <microsim/output/MSE2Collector.h>
#include <microsim/output/MS_E2_ZS_CollectorOverLanes.h>
#include <microsim/output/MSE3Collector.h>
#include <microsim/output/MSInductLoop.h>
#include <microsim/output/MSRouteProbe.h>

#ifdef HAVE_MESOSIM
#include <mesosim/MEInductLoop.h>
#endif


// ===========================================================================
// class declarations
// ===========================================================================
class MSMeanData;


// ===========================================================================
// class definitions
// ===========================================================================
class MSDetectorControl {
public:
    // well, well, friends are evil; one could think about overriding MSDetectorControl and introducing GUIDetectorControl...
    friend class GUINet;


    MSDetectorControl() throw();


    ~MSDetectorControl() throw();


    void close(SUMOTime step);


    void add(SumoXMLTag type, MSDetectorFileOutput* d, OutputDevice& device, int splInterval, SUMOTime begin=-1) throw(ProcessError);



    void add(SumoXMLTag type, MSDetectorFileOutput* d) throw(ProcessError);


    void add(MSMeanData* mn, OutputDevice& device,
             SUMOTime frequency, SUMOTime begin) throw();



    void addDetectorAndInterval(MSDetectorFileOutput* det,
                                OutputDevice* device,
                                SUMOTime interval, SUMOTime begin=-1) throw();



    const NamedObjectCont<MSDetectorFileOutput*> &getTypedDetectors(SumoXMLTag type) const throw();



    void updateDetectors(const SUMOTime step) throw();


    void writeOutput(SUMOTime step, bool closing) throw(IOError);


protected:

    typedef std::pair< MSDetectorFileOutput*, OutputDevice* > DetectorFilePair;

    typedef std::vector< DetectorFilePair > DetectorFileVec;

    typedef std::pair<SUMOTime, SUMOTime> IntervalsKey;

    typedef std::map< IntervalsKey, DetectorFileVec > Intervals;

    struct detectorEquals : public std::binary_function< DetectorFilePair, MSDetectorFileOutput*, bool > {
        bool operator()(const DetectorFilePair& pair, const MSDetectorFileOutput* det) const throw() {
            return pair.first == det;
        }
    };

protected:
    std::map<SumoXMLTag, NamedObjectCont< MSDetectorFileOutput*> > myDetectors;


    Intervals myIntervals;

    std::map<IntervalsKey, SUMOTime> myLastCalls;

    std::vector<MSMeanData*> myMeanData;

    NamedObjectCont< MSDetectorFileOutput*> myEmptyContainer;


private:
    MSDetectorControl(const MSDetectorControl&);

    MSDetectorControl& operator=(const MSDetectorControl&);


};


#endif

/****************************************************************************/