RORouteDef_Alternatives.h

Go to the documentation of this file.

/****************************************************************************/
// A route with alternative routes
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef RORouteDef_Alternatives_h
#define RORouteDef_Alternatives_h


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

#include <string>
#include <vector>
#include "RORouteDef.h"
#include <utils/common/RGBColor.h>


// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;


// ===========================================================================
// class definitions
// ===========================================================================
class RORouteDef_Alternatives : public RORouteDef {
public:
    RORouteDef_Alternatives(const std::string& id, unsigned int lastUsed, const SUMOReal beta,
                            const SUMOReal gawronA, const SUMOReal logitGamma, const int maxRoutes,
                            const bool keepRoutes, const bool skipRouteCalculation) ;

    virtual ~RORouteDef_Alternatives() ;

    virtual void addLoadedAlternative(RORoute* alternative);

    RORoute* buildCurrentRoute(SUMOAbstractRouter<ROEdge, ROVehicle> &router, SUMOTime begin,
                               const ROVehicle& veh) const;

    void addAlternative(SUMOAbstractRouter<ROEdge, ROVehicle> &router,
                        const ROVehicle* const, RORoute* current, SUMOTime begin);

    RORouteDef* copy(const std::string& id) const;

    void invalidateLast();

    void removeLast();

    virtual OutputDevice& writeXMLDefinition(SUMOAbstractRouter<ROEdge, ROVehicle> &router,
            OutputDevice& dev, const ROVehicle* const veh,
            bool asAlternatives, bool withExitTimes) const;

private:
    int findRoute(RORoute* opt) const;

    SUMOReal getThetaForCLogit() const;

    void calculateLogitProbabilities();

    SUMOReal gawronF(SUMOReal pdr, SUMOReal pds, SUMOReal x);

    SUMOReal gawronG(SUMOReal a, SUMOReal x);

private:
    mutable bool myNewRoute;

    mutable int myLastUsed;

    typedef std::vector<RORoute*> AlternativesVector;

    AlternativesVector myAlternatives;

    const SUMOReal myBeta;

    const SUMOReal myGawronA;

    const SUMOReal myLogitGamma;

    std::map<const RORoute*, SUMOReal> myCommonalities;

    const int myMaxRouteNumber;

    const bool myKeepRoutes;

    const bool mySkipRouteCalculation;


private:
    RORouteDef_Alternatives(const RORouteDef_Alternatives& src);

    RORouteDef_Alternatives& operator=(const RORouteDef_Alternatives& src);

};


#endif

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