RORouteDef.h

Go to the documentation of this file.

/****************************************************************************/
// Base class for a vehicle's route definition
/****************************************************************************/
// 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_h
#define RORouteDef_h


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

#include <string>
#include <iostream>
#include <utils/common/Named.h>
#include "ReferencedItem.h"
#include <utils/common/SUMOAbstractRouter.h>
#include <utils/common/RGBColor.h>


// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
class RORoute;
class OptionsCont;
class ROVehicle;
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class RORouteDef : public ReferencedItem, public Named {
public:
    RORouteDef(const std::string& id, const RGBColor* const color) ;


    virtual ~RORouteDef() ;


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

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

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

    const RGBColor* getColor() const {
        return myColor;
    }


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

protected:
    const RGBColor* copyColorIfGiven() const ;

protected:
    const RGBColor* const myColor;


private:
    RORouteDef(const RORouteDef& src);

    RORouteDef& operator=(const RORouteDef& src);

};


#endif

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