RONet.h

Go to the documentation of this file.

/****************************************************************************/
// The router's network representation
/****************************************************************************/
// 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 RONet_h
#define RONet_h


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

#include <string>
#include <set>
#include <fstream>
#include <deque>
#include <vector>
#include "ROEdge.h"
#include "RONode.h"
#include "ROVehicleCont.h"
#include "ROVehicle.h"
#include "RORouteDef.h"
#include <utils/common/SUMOVTypeParameter.h>
#include <utils/common/SUMOAbstractRouter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class RONode;
class RORouteDef;
class OptionsCont;
class OutputDevice;


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


    virtual ~RONet() throw();




    /* @brief Adds a read edge to the network
     *
     * If the edge is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The edge
     *  is deleted in this case and false is returned.
     *
     * @param[in] edge The edge to add
     * @return Whether the edge was added (if not, it was deleted, too)
     */
    virtual bool addEdge(ROEdge* edge) throw();


    ROEdge* getEdge(const std::string& name) const throw() {
        return myEdges.get(name);
    }


    /* @brief Adds a read node to the network
     *
     * If the node is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The node
     *  is deleted in this case
     *
     * @param[in] node The node to add
     */
    void addNode(RONode* node) throw();


    RONode* getNode(const std::string& id) const throw() {
        return myNodes.get(id);
    }





    /* @brief Adds a read vehicle type definition to the network
     *
     * If the vehicle type definition is already known (another one with
     *  the same id exists), false is returned, and the vehicle type
     *  is deleted.
     *
     * @param[in] def The vehicle type to add
     * @return Whether the vehicle type could be added
     */
    virtual bool addVehicleType(SUMOVTypeParameter* type) throw();


    SUMOVTypeParameter* getVehicleTypeSecure(const std::string& id) throw();


    /* @brief Adds a route definition to the network
     *
     * If the route definition is already known (another one with
     *  the same id exists), false is returned, but the route definition
     *  is not deleted.
     *
     * @param[in] def The route definition to add
     * @return Whether the route definition could be added
     * @todo Rename myRoutes to myRouteDefinitions
     */
    bool addRouteDef(RORouteDef* def) throw();


    RORouteDef* getRouteDef(const std::string& name) const throw() {
        return myRoutes.get(name);
    }


    /* @brief Adds a vehicle to the network
     *
     * If the vehicle is already known (another one with the same id
     *  exists), false is returned, but the vehicle is not deleted.
     *
     * Otherwise, the number of loaded routes ("myReadRouteNo") is increased.
     *
     * @param[in] id The id of the vehicle to add
     * @param[in] veh The vehicle to add
     * @return Whether the vehicle could be added
     */
    virtual bool addVehicle(const std::string& id, ROVehicle* veh) throw();
    // @}





    SUMOTime saveAndRemoveRoutesUntil(OptionsCont& options,
                                      SUMOAbstractRouter<ROEdge,ROVehicle> &router, SUMOTime time);


    virtual bool furtherStored();





    void openOutput(const std::string& filename, bool useAlternatives) throw(IOError);


    void closeOutput() throw();




    ROEdge* getRandomSource() throw();


    const ROEdge* getRandomSource() const throw();


    ROEdge* getRandomDestination() throw();


    const ROEdge* getRandomDestination() const throw();


    unsigned int getEdgeNo() const;

    const std::map<std::string, ROEdge*> &getEdgeMap() const;

    bool hasRestrictions() const;

    void setRestrictionFound();


protected:
    bool computeRoute(OptionsCont& options,
                      SUMOAbstractRouter<ROEdge,ROVehicle> &router, const ROVehicle* const veh);

    void checkSourceAndDestinations() const;

protected:
    std::set<std::string> myVehIDs;

    NamedObjectCont<RONode*> myNodes;

    NamedObjectCont<ROEdge*> myEdges;

    NamedObjectCont<SUMOVTypeParameter*> myVehicleTypes;

    NamedObjectCont<RORouteDef*> myRoutes;

    ROVehicleCont myVehicles;

    mutable std::vector<ROEdge*> mySourceEdges;

    mutable std::vector<ROEdge*> myDestinationEdges;

    OutputDevice* myRoutesOutput;

    OutputDevice* myRouteAlternativesOutput;

    unsigned int myReadRouteNo;

    unsigned int myDiscardedRouteNo;

    unsigned int myWrittenRouteNo;

    bool myHaveRestrictions;


private:
    RONet(const RONet& src);

    RONet& operator=(const RONet& src);

};


#endif

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