SUMOVehicle.h

Go to the documentation of this file.
00001 /****************************************************************************/
00007 // Abstract base class for vehicle representations
00008 /****************************************************************************/
00009 // SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
00010 // Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
00011 /****************************************************************************/
00012 //
00013 //   This program is free software; you can redistribute it and/or modify
00014 //   it under the terms of the GNU General Public License as published by
00015 //   the Free Software Foundation; either version 2 of the License, or
00016 //   (at your option) any later version.
00017 //
00018 /****************************************************************************/
00019 #ifndef SUMOVehicle_h
00020 #define SUMOVehicle_h
00021 
00022 
00023 // ===========================================================================
00024 // included modules
00025 // ===========================================================================
00026 #ifdef _MSC_VER
00027 #include <windows_config.h>
00028 #else
00029 #include <config.h>
00030 #endif
00031 
00032 #include <vector>
00033 
00034 
00035 // ===========================================================================
00036 // class declarations
00037 // ===========================================================================
00038 class MSVehicleType;
00039 class MSRoute;
00040 class MSEdge;
00041 
00042 typedef std::vector<const MSEdge*> MSEdgeVector;
00043 
00044 
00045 // ===========================================================================
00046 // class definitions
00047 // ===========================================================================
00052 class SUMOVehicle {
00053 public:
00057     virtual const std::string& getID() const throw() = 0;
00058 
00062     virtual SUMOReal getPositionOnLane() const throw() = 0;
00063 
00067     virtual SUMOReal getMaxSpeed() const = 0;
00068 
00072     virtual SUMOReal getSpeed() const throw() = 0;
00073 
00077     virtual const MSVehicleType &getVehicleType() const = 0;
00078 
00080     virtual const MSRoute &getRoute() const = 0;
00081 
00089     virtual const MSEdge* succEdge(unsigned int nSuccs) const throw() = 0;
00090 
00095     virtual SUMOReal adaptMaxSpeed(SUMOReal referenceSpeed) = 0;
00096 
00098     virtual bool replaceRoute(const MSEdgeVector &edges, SUMOTime simTime, bool onInit=false) = 0;
00099 
00100 };
00101 
00102 
00103 #endif
00104 
00105 /****************************************************************************/