NLTriggerBuilder.h

Go to the documentation of this file.

/****************************************************************************/
// Builds trigger objects for microsim
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 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 NLTriggerBuilder_h
#define NLTriggerBuilder_h


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

#include <string>
#include <vector>


// ===========================================================================
// class declarations
// ===========================================================================
class MSTrigger;
class MSNet;
class MSLaneSpeedTrigger;
class MSEmitter;
class NLHandler;
class MSTriggeredRerouter;
class MSLane;
class MSEdge;
class MSBusStop;
class MSCalibrator;

#ifdef HAVE_MESOSIM
class METriggeredCalibrator;
#endif


// ===========================================================================
// class definitions
// ===========================================================================
class NLTriggerBuilder {
public:
    NLTriggerBuilder() throw();


    virtual ~NLTriggerBuilder() throw();


    void setHandler(NLHandler *handler) throw();


    void buildTrigger(MSNet &net, const SUMOSAXAttributes &attrs,
                      const std::string &base) throw(InvalidArgument);


    void buildVaporizer(const SUMOSAXAttributes &attrs) throw();




    void parseAndBuildLaneSpeedTrigger(MSNet &net, const SUMOSAXAttributes &attrs,
                                       const std::string &base) throw(InvalidArgument);


    void parseAndBuildLaneEmitTrigger(MSNet &net, const SUMOSAXAttributes &attrs,
                                      const std::string &base) throw(InvalidArgument);


    void parseAndBuildRerouter(MSNet &net, const SUMOSAXAttributes &attrs,
                               const std::string &base) throw(InvalidArgument);


    void parseAndBuildBusStop(MSNet &net, const SUMOSAXAttributes &attrs) throw(InvalidArgument);


    void parseAndBuildCalibrator(MSNet &net, const SUMOSAXAttributes &attrs,
                                 const std::string &base) throw(InvalidArgument);


protected:


    virtual MSLaneSpeedTrigger* buildLaneSpeedTrigger(MSNet &net,
            const std::string &id, const std::vector<MSLane*> &destLanes,
            const std::string &file) throw(ProcessError);


    virtual void buildLaneEmitTrigger(MSNet &net,
                                      const std::string &id, MSLane *destLane, SUMOReal pos,
                                      const std::string &file) throw();


    virtual void buildBusStop(MSNet &net,
                              const std::string &id, const std::vector<std::string> &lines,
                              MSLane *lane, SUMOReal frompos, SUMOReal topos) throw();


    virtual void buildLaneCalibrator(MSNet &net,
                                     const std::string &id, MSLane *destLane, SUMOReal pos,
                                     const std::string &file) throw();


#ifdef HAVE_MESOSIM

    METriggeredCalibrator* buildCalibrator(MSNet &net,
                                           const std::string &id, const MSEdge *edge, SUMOReal pos,
                                           const std::string &file, const std::string &outfile,
                                           const SUMOTime freq) throw();
#endif


    virtual void buildRerouter(MSNet &net,
                               const std::string &id, std::vector<MSEdge*> &edges,
                               SUMOReal prob, const std::string &file, bool off) throw();


protected:

    std::string getFileName(const SUMOSAXAttributes &attrs,
                            const std::string &base,
                            const bool allowEmpty=false) throw(InvalidArgument);


    MSLane *getLane(const SUMOSAXAttributes &attrs,
                    const std::string &tt, const std::string &tid) throw(InvalidArgument);


    SUMOReal getPosition(const SUMOSAXAttributes &attrs,
                         MSLane *lane, const std::string &tt, const std::string &tid) throw(InvalidArgument);


protected:
    bool myHaveInformedAboutDeprecatedTriggerDefinition;

    bool myHaveInformedAboutDeprecatedEmitter;

    NLHandler* myHandler;

};


#endif

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