MSBaseVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// A base class for vehicle implementations
/****************************************************************************/
// 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 MSBaseVehicle_h
#define MSBaseVehicle_h


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

#include <iostream>
#include <cassert>
#include <vector>
#include <utils/common/SUMOVehicle.h>
#include <utils/common/StdDefs.h>
#include "MSRoute.h"
#include "MSMoveReminder.h"


// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicleParameter;
class MSVehicleType;


// ===========================================================================
// class definitions
// ===========================================================================
class MSBaseVehicle : public SUMOVehicle {
public:
    MSBaseVehicle(SUMOVehicleParameter* pars, const MSRoute* route, const MSVehicleType* type) ;


    virtual ~MSBaseVehicle() ;


    const std::string& getID() const ;

    const SUMOVehicleParameter& getParameter() const ;


    const MSRoute& getRoute() const ;


    const MSVehicleType& getVehicleType() const ;


    SUMOReal getMaxSpeed() const;


    SUMOReal adaptMaxSpeed(SUMOReal referenceSpeed);


    const MSEdge* succEdge(unsigned int nSuccs) const ;

    const MSEdge* getEdge() const;


    virtual bool isOnRoad() const {
        return true;
    }


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


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


    virtual SUMOReal getPreDawdleAcceleration() const ;

    void onDepart() ;

    SUMOTime getDeparture() const ;

    unsigned int getNumberReroutes() const ;

    const std::vector<MSDevice*> &getDevices() const {
        return myDevices;
    }

    virtual void addPerson(MSPerson* person) ;

    virtual bool isStopped() const;

    bool hasValidRoute(std::string& msg) const ;

    void addReminder(MSMoveReminder* rem) ;

    void removeReminder(MSMoveReminder* rem) ;

    virtual void activateReminders(const MSMoveReminder::Notification reason) ;

protected:
    void calculateArrivalPos() ;

protected:
    const SUMOVehicleParameter* myParameter;

    const MSRoute* myRoute;

    const MSVehicleType* myType;

    MSRouteIterator myCurrEdge;

    SUMOReal myIndividualMaxSpeed;

    bool myHasIndividualMaxSpeed;

    SUMOReal myReferenceSpeed;


    typedef std::vector< std::pair<MSMoveReminder*, SUMOReal> > MoveReminderCont;

    MoveReminderCont myMoveReminders;

    std::vector<MSDevice*> myDevices;

    SUMOTime myDeparture;

    SUMOReal myArrivalPos;

    unsigned int myNumberReroutes;

};

#endif

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