SUMOVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// Abstract base class for vehicle representations
/****************************************************************************/
// 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 SUMOVehicle_h
#define SUMOVehicle_h


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

#include <vector>
#include <utils/common/SUMOTime.h>
#include <utils/common/SUMOAbstractRouter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSVehicleType;
class MSRoute;
class MSEdge;
class MSLane;
class MSDevice;
class SUMOVehicleParameter;
class MSPerson;

typedef std::vector<const MSEdge*> MSEdgeVector;


// ===========================================================================
// class definitions
// ===========================================================================
class SUMOVehicle {
public:
    virtual ~SUMOVehicle() throw() {}

    virtual const std::string& getID() const throw() = 0;

    virtual SUMOReal getPositionOnLane() const throw() = 0;

    virtual SUMOReal getMaxSpeed() const = 0;

    virtual SUMOReal getSpeed() const throw() = 0;

    virtual const MSVehicleType& getVehicleType() const = 0;

    virtual const MSRoute& getRoute() const = 0;

    virtual const MSEdge* succEdge(unsigned int nSuccs) const throw() = 0;

    virtual SUMOReal adaptMaxSpeed(SUMOReal referenceSpeed) = 0;

    virtual bool replaceRouteEdges(const MSEdgeVector& edges, bool onInit=false) = 0;

    virtual bool replaceRoute(const MSRoute* route, bool onInit=false) = 0;

    virtual void reroute(SUMOTime t, SUMOAbstractRouter<MSEdge, SUMOVehicle> &router, bool withTaz=false) throw() = 0;

    virtual SUMOReal getPreDawdleAcceleration() const throw() = 0;

    virtual const MSEdge* getEdge() const = 0;

    virtual const SUMOVehicleParameter& getParameter() const throw() = 0;

    virtual void onDepart() throw() = 0;

    virtual bool isOnRoad() const throw() = 0;

    virtual SUMOTime getDeparture() const throw() = 0;

    virtual unsigned int getNumberReroutes() const throw() = 0;

    virtual const std::vector<MSDevice*> &getDevices() const = 0;

    virtual void addPerson(MSPerson* person) throw() = 0;

    virtual bool isStopped() const = 0;


};


#endif

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