ROVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// A vehicle as used by router
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2002-2014 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 ROVehicle_h
#define ROVehicle_h


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

#include <string>
#include <iostream>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOTime.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOVTypeParameter.h>


// ===========================================================================
// class declarations
// ===========================================================================
class RORouteDef;
class OutputDevice;
class ROEdge;
class RONet;


// ===========================================================================
// class definitions
// ===========================================================================
class ROVehicle {
public:
    ROVehicle(const SUMOVehicleParameter& pars,
              RORouteDef* route, const SUMOVTypeParameter* type,
              const RONet* net);


    virtual ~ROVehicle();


    RORouteDef* getRouteDefinition() const {
        return myRoute;
    }


    const SUMOVTypeParameter* getType() const {
        return myType;
    }


    const std::string& getID() const {
        return myParameter.id;
    }


    SUMOTime getDepartureTime() const {
        return MAX2(0, myParameter.depart);
    }

    SUMOTime getDepart() const {
        return myParameter.depart;
    }

    const std::vector<const ROEdge*>& getStopEdges() const {
        return myStopEdges;
    }

    SUMOReal getMaxSpeed() const;


    inline SUMOVehicleClass getVClass() const {
        return getType() != 0 ? getType()->vehicleClass : SVC_IGNORING;
    }

    inline SUMOReal getChosenSpeedFactor() const {
        return SUMOReal(2. * getType()->speedDev + 1.) * getType()->speedFactor;
    }


    void saveAllAsXML(OutputDevice& os, OutputDevice* const altos,
                      OutputDevice* const typeos, bool withExitTimes) const;

    inline void setRoutingSuccess(const bool val) {
        myRoutingSuccess = val;
    }

    inline bool getRoutingSuccess() const {
        return myRoutingSuccess;
    }
private:
    void addStop(const SUMOVehicleParameter::Stop& stopPar, const RONet* net);


protected:
    SUMOVehicleParameter myParameter;

    const SUMOVTypeParameter* const myType;

    RORouteDef* const myRoute;

    std::vector<const ROEdge*> myStopEdges;

    bool myRoutingSuccess;


private:
    ROVehicle(const ROVehicle& src);

    ROVehicle& operator=(const ROVehicle& src);

};


#endif

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