MSEdge Class Reference

#include <MSEdge.h>

Inheritance diagram for MSEdge:

---

Detailed Description

A road/street connecting two junctions.

A single connection between two junctions. Holds lanes which are reponsible for vehicle movements.

Definition at line 62 of file MSEdge.h.

Static edge container
typedef std::map< std::string, MSEdge * >	DictType
	definition of the static dictionary type
static DictType	myDict
	Static dictionary to associate string-ids with objects.
static std::vector< MSEdge * >	myEdges
	Static list of edges.
Public Types
typedef std::map< const MSEdge *, std::vector< MSLane * > * >	AllowedLanesCont
	Suceeding edges (keys) and allowed lanes to reach these edges (values).
typedef std::map < SUMOVehicleClass, AllowedLanesCont >	ClassedAllowedLanesCont
	Map from vehicle types to lanes that may be used to reach one of the next edges.
enum	EdgeBasicFunction {   EDGEFUNCTION_UNKNOWN = -1, EDGEFUNCTION_NORMAL = 0, EDGEFUNCTION_CONNECTOR = 1, EDGEFUNCTION_INTERNAL = 2,   EDGEFUNCTION_DISTRICT = 3 }
	Defines possible edge types. More...
Public Member Functions
virtual void	changeLanes (SUMOTime t) throw ()
	Performs lane changing on this edge.
void	closeBuilding ()
SUMOReal	getCurrentTravelTime () const throw ()
	Computes and returns the current travel time for this edge.
void	initialize (MSLane *departLane, std::vector< MSLane * > *lanes, EdgeBasicFunction function) throw ()
	Initialize the edge.
	MSEdge (const std::string &id, unsigned int numericalID) throw ()
	Constructor.
bool	prohibits (const SUMOVehicle *const vehicle) const throw ()
	Returns whether the vehicle (class) is not allowed on the edge.
void	rebuildAllowedLanes () throw ()
virtual	~MSEdge () throw ()
	Destructor.
Access to succeeding/predecessing edges
void	addFollower (MSEdge *edge) throw ()
	Returns the list of edges which may be reached from this edge.
const MSEdge *const	getFollower (unsigned int n) const throw ()
	Returns the n-th of the following edges.
const std::vector< MSEdge * > &	getIncomingEdges () const throw ()
	Returns the list of edges from which this edge may be reached.
unsigned int	getNoFollowing () const throw ()
	Returns the number of edges that may be reached from this edge.
Access to the edge's lanes
const std::vector< MSLane * > *	allowedLanes (SUMOVehicleClass vclass=SVC_UNKNOWN) const throw ()
	Get the allowed lanes for the given vehicle class.
const std::vector< MSLane * > *	allowedLanes (const MSEdge &destination, SUMOVehicleClass vclass=SVC_UNKNOWN) const throw ()
	Get the allowed lanes to reach the destination-edge.
const std::vector< MSLane * > &	getLanes () const throw ()
	Returns this edge's lanes.
MSLane *const	leftLane (const MSLane *const lane) const throw ()
	Returns the lane left to the one given, 0 if the given lane is leftmost.
MSLane *const	rightLane (const MSLane *const lane) const throw ()
	Returns the lane right to the one given, 0 if the given lane is rightmost.
Access to vaporizing interface
SUMOTime	decVaporization (SUMOTime t) throw (ProcessError)
	Disables vaporization.
SUMOTime	incVaporization (SUMOTime t) throw (ProcessError)
	Enables vaporization.
bool	isVaporizing () const throw ()
	Returns whether vehicles on this edge shall be vaporized.
Methods releated to vehicle emission
bool	emit (MSVehicle &v, SUMOTime time) const throw (ProcessError)
	Emits the given vehicle.
MSLane *	getDepartLane (const MSVehicle &v) const throw ()
	Finds a depart lane for the given vehicle.
MSLane *	getFreeLane (const SUMOVehicleClass vclass) const throw ()
	Finds the emptiest lane allowing the vehicle class.
SUMOTime	getLastFailedEmissionTime () const throw ()
	Returns the last time a vehicle could not be inserted.
void	setLastFailedEmissionTime (SUMOTime time) const throw ()
	Sets the last time a vehicle could not be inserted.
Access to other edge attributes
const std::string &	getID () const throw ()
	Returns the id of the edge.
unsigned int	getNumericalID () const throw ()
	Returns the numerical id of the edge.
EdgeBasicFunction	getPurpose () const throw ()
	Returns the edge type (EdgeBasicFunction).
Static Public Member Functions
static void	clear () throw ()
	Clears the dictionary.
static MSEdge *	dictionary (size_t index) throw ()
	Returns the MSEdge at the index.
static MSEdge *	dictionary (const std::string &id) throw ()
	Returns the MSEdge associated to the key id if exists, otherwise returns 0.
static bool	dictionary (const std::string &id, MSEdge *edge) throw ()
	Inserts edge into the static dictionary Returns true if the key id isn't already in the dictionary. Otherwise returns false.
static size_t	dictSize () throw ()
	Returns the number of edges.
static void	insertIDs (std::vector< std::string > &into) throw ()
	Inserts IDs of all known edges into the given vector.
Static parser helper
static void	parseEdgesList (const std::vector< std::string > &desc, std::vector< const MSEdge * > &into, const std::string &rid) throw (ProcessError)
	Parses the given string vector assuming it edge ids.
static void	parseEdgesList (const std::string &desc, std::vector< const MSEdge * > &into, const std::string &rid) throw (ProcessError)
	Parses the given string assuming it contains a list of edge ids divided by spaces.
Protected Member Functions
const std::vector< MSLane * > *	allowedLanes (const MSEdge *destination, SUMOVehicleClass vclass=SVC_UNKNOWN) const throw ()
	Get the allowed lanes to reach the destination-edge.
Protected Attributes
MSLane *	myDepartLane
	Lane from which vehicles will depart, usually the rightmost.
EdgeBasicFunction	myFunction
	the purpose of the edge
std::string	myID
	Unique ID.
MSLaneChanger *	myLaneChanger
	This member will do the lane-change.
std::vector< MSLane * > *	myLanes
	Container for the edge's lane; should be sorted: (right-hand-traffic) the more left the lane, the higher the container-index.
SUMOTime	myLastFailedEmissionTime
	The time of last emission failure.
unsigned int	myNumericalID
	This edge's numerical id.
std::vector< MSEdge * >	myPredeccesors
	The preceeding edges.
std::vector< MSEdge * >	mySuccessors
	The succeeding edges.
int	myVaporizationRequests
	Vaporizer counter.
Storages for allowed lanes (depending on vehicle classes)
AllowedLanesCont	myAllowed
	Associative container from destination-edge to allowed-lanes.
ClassedAllowedLanesCont	myClassedAllowed
	From vehicle class to lanes allowed to be used by it.
bool	myHaveClassConstraints
	Whether any class constraints exist for this edge.
Private Member Functions
	MSEdge (const MSEdge &)
	Invalidated copy constructor.
MSEdge &	operator= (const MSEdge &)
	assignment operator.
Data Structures
class	by_id_sorter
	Sorts edges by their ids. More...

---

Member Typedef Documentation

typedef std::map< const MSEdge*, std::vector<MSLane*>* > MSEdge::AllowedLanesCont

Suceeding edges (keys) and allowed lanes to reach these edges (values).

Definition at line 86 of file MSEdge.h.

typedef std::map< SUMOVehicleClass, AllowedLanesCont > MSEdge::ClassedAllowedLanesCont

Map from vehicle types to lanes that may be used to reach one of the next edges.

Definition at line 89 of file MSEdge.h.

typedef std::map< std::string, MSEdge* > MSEdge::DictType [protected]

definition of the static dictionary type

Definition at line 499 of file MSEdge.h.

---

Member Enumeration Documentation

enum MSEdge::EdgeBasicFunction

Defines possible edge types.

For different purposes, it is necessary to know whether the edge is a normal street or something special.

Enumerator:

EDGEFUNCTION_UNKNOWN	The purpose of the edge is not known.
EDGEFUNCTION_NORMAL	The edge is a normal street.
EDGEFUNCTION_CONNECTOR	The edge is a macroscopic connector (source/sink).
EDGEFUNCTION_INTERNAL	The edge is an internal edge.
EDGEFUNCTION_DISTRICT	The edge is a district edge.

Definition at line 71 of file MSEdge.h.

                           {
        EDGEFUNCTION_UNKNOWN = -1,
        EDGEFUNCTION_NORMAL = 0,
        EDGEFUNCTION_CONNECTOR = 1,
        EDGEFUNCTION_INTERNAL = 2,
        EDGEFUNCTION_DISTRICT = 3
    };

---

Constructor & Destructor Documentation

MSEdge::MSEdge	(	const std::string &	id,
		unsigned int	numericalID
	)			throw ()

Constructor.

After calling this constructor, the edge is not yet initialised completely. A call to "initialize" with proper values is needed for this.

Parameters:

[in]	id	The id of the edge
[in]	numericalID	The numerical id (index) of the edge

Definition at line 60 of file MSEdge.cpp.

        : myID(id), myNumericalID(numericalID), myLanes(0),
        myLaneChanger(0), myVaporizationRequests(0), myLastFailedEmissionTime(-1) {}

MSEdge::~MSEdge

(

)

throw () [virtual]

Destructor.

Definition at line 65 of file MSEdge.cpp.

References myAllowed, myClassedAllowed, myLaneChanger, and myLanes.

                        {
    delete myLaneChanger;
    for (AllowedLanesCont::iterator i1=myAllowed.begin(); i1!=myAllowed.end(); i1++) {
        delete(*i1).second;
    }
    for (ClassedAllowedLanesCont::iterator i2=myClassedAllowed.begin(); i2!=myClassedAllowed.end(); i2++) {
        for (AllowedLanesCont::iterator i1=(*i2).second.begin(); i1!=(*i2).second.end(); i1++) {
            delete(*i1).second;
        }
    }
    delete myLanes;
    // Note: Lanes are delete using MSLane::clear();
}

MSEdge::MSEdge

(

const MSEdge &

)

[private]

Invalidated copy constructor.

---

Member Function Documentation

void MSEdge::addFollower

(

MSEdge *

edge

)

throw () [inline]

Returns the list of edges which may be reached from this edge.

Returns:

Edges reachable from this edge

Definition at line 213 of file MSEdge.h.

References mySuccessors.

Referenced by NLHandler::addDistrict(), and NLHandler::addDistrictEdge().

                                           {
        mySuccessors.push_back(edge);
    }

const std::vector< MSLane * > * MSEdge::allowedLanes	(	const MSEdge *	destination,
		SUMOVehicleClass	vclass = SVC_UNKNOWN
	)			const throw () [protected]

Get the allowed lanes to reach the destination-edge.

If there is no such edge, get 0. Then you are on the wrong edge.

Parameters:

[in]	destination	The edge to reach
[in]	vclass	The vehicle class for which this information shall be returned

Returns:

The lanes that may be used to reach the given edge, 0 if no such lanes exist

Definition at line 199 of file MSEdge.cpp.

References myAllowed, myClassedAllowed, myHaveClassConstraints, and SVC_UNKNOWN.

                                                                                     {
    if (myHaveClassConstraints&&vclass!=SVC_UNKNOWN) {
        ClassedAllowedLanesCont::const_iterator i = myClassedAllowed.find(vclass);
        if (i!=myClassedAllowed.end()) {
            const AllowedLanesCont &c = (*i).second;
            AllowedLanesCont::const_iterator j = (*i).second.find(destination);
            if (j==c.end()) {
                // Destination-edge not found.
                return 0;
            }
            return (*j).second;
        }
    }
    AllowedLanesCont::const_iterator it = myAllowed.find(destination);
    if (it!=myAllowed.end()) {
        return it->second;
    } else {
        // Destination-edge not found.
        return 0;
    }
}

const std::vector< MSLane * > * MSEdge::allowedLanes

(

SUMOVehicleClass

vclass = SVC_UNKNOWN

)

const throw ()

Get the allowed lanes for the given vehicle class.

If there is no such edge, get 0. Then you are on the wrong edge.

Parameters:

[in]

vclass

The vehicle class for which this information shall be returned

Returns:

The lanes that may be used by the given vclass

Definition at line 193 of file MSEdge.cpp.

References allowedLanes().

                                                          {
    return allowedLanes(0, vclass);
}

const std::vector< MSLane * > * MSEdge::allowedLanes	(	const MSEdge &	destination,
		SUMOVehicleClass	vclass = SVC_UNKNOWN
	)			const throw ()

Get the allowed lanes to reach the destination-edge.

If there is no such edge, get 0. Then you are on the wrong edge.

Parameters:

[in]	destination	The edge to reach
[in]	vclass	The vehicle class for which this information shall be returned

Returns:

The lanes that may be used to reach the given edge, 0 if no such lanes exist

Definition at line 187 of file MSEdge.cpp.

Referenced by allowedLanes(), getDepartLane(), getFreeLane(), MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes(), and MSLane::succLinkSec().

                                                                                     {
    return allowedLanes(&destination, vclass);
}

void MSEdge::changeLanes

(

SUMOTime

t

)

throw () [virtual]

Performs lane changing on this edge.

Definition at line 327 of file MSEdge.cpp.

References EDGEFUNCTION_INTERNAL, MSLaneChanger::laneChange(), myFunction, and myLaneChanger.

Referenced by MSEdgeControl::changeLanes().

                                      {
    if (myFunction==EDGEFUNCTION_INTERNAL) {
        return;
    }
    assert(myLaneChanger != 0);
    myLaneChanger->laneChange(t);
}

void MSEdge::clear

(

)

throw () [static]

Clears the dictionary.

Definition at line 442 of file MSEdge.cpp.

References myDict.

Referenced by MSNet::clearAll().

                      {
    for (DictType::iterator i=myDict.begin(); i!=myDict.end(); ++i) {
        delete(*i).second;
    }
    myDict.clear();
}

void MSEdge::closeBuilding

(

)

Todo:

Has to be called after all edges were built and all connections were set...; Still, is not very nice

Definition at line 94 of file MSEdge.cpp.

References MSLane::getEdge(), myAllowed, myLanes, myPredeccesors, mySuccessors, and rebuildAllowedLanes().

                      {
    myAllowed[0] = new std::vector<MSLane*>();
    for (std::vector<MSLane*>::iterator i=myLanes->begin(); i!=myLanes->end(); ++i) {
        myAllowed[0]->push_back(*i);
        const MSLinkCont &lc = (*i)->getLinkCont();
        for (MSLinkCont::const_iterator j=lc.begin(); j!=lc.end(); ++j) {
            MSLane *toL = (*j)->getLane();
            if (toL!=0) {
                MSEdge &to = toL->getEdge();
                //
                if (std::find(mySuccessors.begin(), mySuccessors.end(), &to)==mySuccessors.end()) {
                    mySuccessors.push_back(&to);
                }
                if (std::find(to.myPredeccesors.begin(), to.myPredeccesors.end(), this)==to.myPredeccesors.end()) {
                    to.myPredeccesors.push_back(this);
                }
                //
                if (myAllowed.find(&to)==myAllowed.end()) {
                    myAllowed[&to] = new std::vector<MSLane*>();
                }
                myAllowed[&to]->push_back(*i);
            }
        }
    }
    std::sort(mySuccessors.begin(), mySuccessors.end(), by_id_sorter());
    rebuildAllowedLanes();
}

SUMOTime MSEdge::decVaporization

(

SUMOTime

t

)

throw (ProcessError)

Disables vaporization.

The internal vaporization counter is decreased what disables the vaporization if it was only once enabled. Called from the event handler.

Parameters:

[in]

t

The current time (unused)

Returns:

Time to next call (always 0)

Exceptions:

ProcessError

not thrown by this method, just derived

Definition at line 231 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

                                                    {
    --myVaporizationRequests;
    return 0;
}

MSEdge * MSEdge::dictionary

(

size_t

index

)

throw () [static]

Returns the MSEdge at the index.

Definition at line 429 of file MSEdge.cpp.

References myEdges.

                                    {
    assert(myEdges.size()>id);
    return myEdges[id];
}

MSEdge * MSEdge::dictionary

(

const std::string &

id

)

throw () [static]

Returns the MSEdge associated to the key id if exists, otherwise returns 0.

Definition at line 418 of file MSEdge.cpp.

References myDict.

                                              {
    DictType::iterator it = myDict.find(id);
    if (it == myDict.end()) {
        // id not in myDict.
        return 0;
    }
    return it->second;
}

bool MSEdge::dictionary	(	const std::string &	id,
		MSEdge *	edge
	)			throw () [static]

Inserts edge into the static dictionary Returns true if the key id isn't already in the dictionary. Otherwise returns false.

Definition at line 402 of file MSEdge.cpp.

References myDict, and myEdges.

Referenced by NLHandler::addDistrict(), NLHandler::addDistrictEdge(), NLBuilder::EdgeFloatTimeLineRetriever_EdgeTravelTime::addEdgeWeight(), NLBuilder::EdgeFloatTimeLineRetriever_EdgeEffort::addEdgeWeight(), MSVehicleTransfer::addVeh(), NLEdgeControlBuilder::beginEdgeParsing(), NLDetectorBuilder::buildRouteProbe(), NLTriggerBuilder::buildVaporizer(), MSDevice_Routing::buildVehicleDevices(), MSVehicleTransfer::checkEmissions(), traci::TraCIServer::commandChangeRoute(), traci::TraCIServer::commandChangeTarget(), traci::TraCIServer::commandDistanceRequest(), traci::TraCIServer::commandStopNode(), traci::TraCIServer::convertCartesianToRoadMap(), traci::TraCIServer::convertRoadMapToCartesian(), GUINet::getEdgeBoundary(), traci::TraCIServer::handleRoadMapDomain(), traci::TraCIServer::handleVehicleDomain(), GUISelectionLoader::loadSelection(), MSTriggeredRerouter::myStartElement(), MSRouteHandler::myStartElement(), NLTriggerBuilder::parseAndBuildRerouter(), parseEdgesList(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_Edge::processSet(), and MSVehicle::reroute().

                                                           {
    DictType::iterator it = myDict.find(id);
    if (it == myDict.end()) {
        // id not in myDict.
        myDict[id] = ptr;
        while (myEdges.size()<ptr->getNumericalID()+1) {
            myEdges.push_back(0);
        }
        myEdges[ptr->getNumericalID()] = ptr;
        return true;
    }
    return false;
}

size_t MSEdge::dictSize

(

)

throw () [static]

Returns the number of edges.

Definition at line 436 of file MSEdge.cpp.

References myDict.

Referenced by traci::TraCIServer::commandChangeTarget(), traci::TraCIServer::commandDistanceRequest(), MSDevice_Routing::enterLaneAtEmit(), GUIEdge::fill(), traci::TraCIServer::handleRoadMapDomain(), MSDevice_Routing::onTryEmit(), traci::TraCIServer::postProcessSimulationStep(), TraCIServerAPI_Vehicle::processSet(), MSTriggeredRerouter::reroute(), and MSDevice_Routing::wrappedRerouteCommandExecute().

                         {
    return myDict.size();
}

bool MSEdge::emit	(	MSVehicle &	v,
		SUMOTime	time
	)			const throw (ProcessError)

Emits the given vehicle.

The procedure for choosing the proper lane is determined, first. In dependance to this, the proper emission lane is chosen.

Emission itself is done by calling the chose lane's "emit" method.

Parameters:

[in]	v	The vehicle to emit
[in]	time	The current simulation time

Returns:

Whether the vehicle could be emitted

See also:

MSLane::emit

Definition at line 280 of file MSEdge.cpp.

References DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, SUMOVehicleParameter::departPos, SUMOVehicleParameter::departPosProcedure, MSLane::emit(), getDepartLane(), getLanes(), isVaporizing(), RandHelper::rand(), and SUMOReal.

Referenced by MSEmitter::childCheckEmit(), MSCalibrator::childCheckEmit(), and MSEmitControl::tryEmit().

                                                                  {
    // when vaporizing, no vehicles are emitted...
    if (isVaporizing()) {
        return false;
    }
    const SUMOVehicleParameter &pars = v.getParameter();
#ifdef HAVE_MESOSIM
    if (MSGlobals::gUseMesoSim) {
        SUMOReal pos = 0.0;
        switch (pars.departPosProcedure) {
        case DEPART_POS_GIVEN:
            if (pars.departPos >= 0.) {
                pos = pars.departPos;
            } else {
                pos = pars.departPos + getLanes()[0]->getLength();
            }
            break;
        case DEPART_POS_RANDOM:
        case DEPART_POS_RANDOM_FREE:
            pos = RandHelper::rand(getLanes()[0]->getLength());
            break;
        default:
            break;
        }
        bool result = false;
        bool insertToNet = false;
        MESegment* segment = MSGlobals::gMesoNet->getSegmentForEdge(*this, pos);
        if (pars.departPosProcedure == DEPART_POS_FREE) {
            while (segment != 0 && !result) {
                result = segment->initialise(&v, time, insertToNet);
                segment = segment->getNextSegment();
            }
        } else {
            result = segment->initialise(&v, time, insertToNet);
        }
        if (insertToNet) {
            MSGlobals::gMesoNet->addCar(&v);
        }
        return result;
    }
#endif
    MSLane* emitLane = getDepartLane(v);
    return emitLane != 0 && /*emitLane->getVehLenSum() + v.getLength() < emitLane->getLength() && */emitLane->emit(v);
}

SUMOReal MSEdge::getCurrentTravelTime

(

)

const throw ()

Computes and returns the current travel time for this edge.

The mean travel time of all lanes is summed and divided by the number of lanes. If the result is zero, 1000000. (a very large number) is returned, otherwise the edge's length divided by this speed.

Returns:

The current effort (travel time) to pass the edge

Definition at line 357 of file MSEdge.cpp.

References myLanes, and SUMOReal.

Referenced by TraCIServerAPI_Edge::processGet().

                                           {
    SUMOReal v = 0;
#ifdef HAVE_MESOSIM
    if (MSGlobals::gUseMesoSim) {
        MESegment *first = MSGlobals::gMesoNet->getSegmentForEdge(*this);
        unsigned segments = 0;
        do {
            v += first->getMeanSpeed();
            first = first->getNextSegment();
            segments++;
        } while (first!=0);
        v /= (SUMOReal) segments;
    } else {
#endif
        for (std::vector<MSLane*>::iterator i=myLanes->begin(); i!=myLanes->end(); ++i) {
            v += (*i)->getMeanSpeed();
        }
        v /= (SUMOReal) myLanes->size();
#ifdef HAVE_MESOSIM
    }
#endif
    if (v!=0) {
        return (*myLanes)[0]->getLength() / v;
    } else {
        return 1000000.;
    }
}

MSLane * MSEdge::getDepartLane

(

const MSVehicle &

v

)

const throw ()

Finds a depart lane for the given vehicle.

Depending on the depart lane procedure a depart lane is chosen. Repeated calls with the same vehicle may return different results if the procedure is "random" or "free". In case no appropriate lane was found, 0 is returned.

Parameters:

[in]

v

The vehicle to get the depart lane for

Returns:

a possible depart lane

See also:

MSLane::emit

Definition at line 255 of file MSEdge.cpp.

References allowedLanes(), MSLane::allowsVehicleClass(), DEPART_LANE_DEFAULT, DEPART_LANE_DEPARTLANE, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, SUMOVehicleParameter::departLane, SUMOVehicleParameter::departLaneProcedure, getFreeLane(), RandHelper::getRandomFrom(), myDepartLane, and myLanes.

Referenced by emit().

                                                      {
    const SUMOVehicleParameter &pars = v.getParameter();
    switch (pars.departLaneProcedure) {
    case DEPART_LANE_GIVEN:
        if ((int) myLanes->size() <= pars.departLane || !(*myLanes)[pars.departLane]->allowsVehicleClass(v.getVehicleType().getVehicleClass())) {
            return 0;
        }
        return (*myLanes)[pars.departLane];
    case DEPART_LANE_RANDOM:
        return RandHelper::getRandomFrom(*allowedLanes(v.getVehicleType().getVehicleClass()));
    case DEPART_LANE_FREE:
        return getFreeLane(v.getVehicleType().getVehicleClass());
    case DEPART_LANE_DEPARTLANE:
    case DEPART_LANE_DEFAULT:
    default:
        break;
    }
    if (!myDepartLane->allowsVehicleClass(v.getVehicleType().getVehicleClass())) {
        return 0;
    }
    return myDepartLane;
}

const MSEdge* const MSEdge::getFollower

(

unsigned int

n

)

const throw () [inline]

Returns the n-th of the following edges.

Parameters:

[in]

n

The index within following edges of the edge to return

Returns:

The n-th of the following edges

Definition at line 237 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

                                                                   {
        return mySuccessors[n];
    }

MSLane * MSEdge::getFreeLane

(

const SUMOVehicleClass

vclass

)

const throw ()

Finds the emptiest lane allowing the vehicle class.

The emptiest lane is the one with the fewest vehicles on. If there is more than one, the first according to its index in the lane container is chosen.

Parameters:

[in]

vclass

The vehicle class to look for

Returns:

the least occupied lane

See also:

MSLane::emit

Definition at line 238 of file MSEdge.cpp.

References allowedLanes(), and MSLane::getVehicleNumber().

Referenced by MSVehicleTransfer::checkEmissions(), and getDepartLane().

                                                               {
    const std::vector<MSLane*>* lanes = allowedLanes(vclass);
    MSLane* res = 0;
    if (lanes != 0) {
        unsigned int noCars = INT_MAX;
        for (std::vector<MSLane*>::const_iterator i=lanes->begin(); i!=lanes->end(); ++i) {
            if ((*i)->getVehicleNumber()<noCars) {
                res = (*i);
                noCars = (*i)->getVehicleNumber();
            }
        }
    }
    return res;
}

const std::string& MSEdge::getID

(

)

const throw () [inline]

Returns the id of the edge.

Returns:

This edge's id

Definition at line 183 of file MSEdge.h.

References myID.

Referenced by MSVehicleTransfer::checkEmissions(), traci::TraCIServer::commandGetTLStatus(), GUIEdge::getMicrosimID(), traci::TraCIServer::handleRoadMapDomain(), traci::TraCIServer::handleTrafficLightDomain(), traci::TraCIServer::handleVehicleDomain(), MSEdge::by_id_sorter::operator()(), traci::TraCIServer::postProcessSimulationStep(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Lane::processGet(), and MSRouteProbe::writeXMLOutput().

                                           {
        return myID;
    }

const std::vector<MSEdge*>& MSEdge::getIncomingEdges

(

)

const throw () [inline]

Returns the list of edges from which this edge may be reached.

Returns:

Edges from which this edge may be reached

Definition at line 221 of file MSEdge.h.

References myPredeccesors.

                                                               {
        return myPredeccesors;
    }

const std::vector<MSLane*>& MSEdge::getLanes

(

)

const throw () [inline]

Returns this edge's lanes.

Returns:

This edge's lanes

Definition at line 148 of file MSEdge.h.

References myLanes.

Referenced by MSEdgeControl::changeLanes(), MSVehicleTransfer::checkEmissions(), traci::TraCIServer::commandChangeLane(), traci::TraCIServer::commandStopNode(), traci::TraCIServer::convertCartesianToRoadMap(), traci::TraCIServer::convertRoadMapToCartesian(), GUITriggeredRerouter::drawGL(), emit(), MS_E2_ZS_CollectorOverLanes::extendTo(), GUILaneWrapper::getEdgeLaneNumber(), MSDevice_Routing::getEffort(), MSNet::EdgeWeightsProxi::getTravelTime(), GUITriggeredRerouter::GUITriggeredRerouter(), traci::TraCIServer::handleRoadMapDomain(), GUINet::initGUIStructures(), MSVehicle::MSVehicle(), MSLCM_DK2004::patchSpeed(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_Edge::processSet(), MSVehicle::rebuildContinuationsFor(), and MSVehicle::replaceRoute().

                                                       {
        return *myLanes;
    }

SUMOTime MSEdge::getLastFailedEmissionTime

(

)

const throw () [inline]

Returns the last time a vehicle could not be inserted.

Returns:

The current value

Definition at line 341 of file MSEdge.h.

References myLastFailedEmissionTime.

Referenced by MSEmitControl::tryEmit().

                                                              {
        return myLastFailedEmissionTime;
    }

unsigned int MSEdge::getNoFollowing

(

)

const throw () [inline]

Returns the number of edges that may be reached from this edge.

Returns:

The number of following edges

Definition at line 229 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

                                                {
        return (unsigned int) mySuccessors.size();
    }

unsigned int MSEdge::getNumericalID

(

)

const throw () [inline]

Returns the numerical id of the edge.

Returns:

This edge's numerical id

Definition at line 200 of file MSEdge.h.

References myNumericalID.

Referenced by MSEdgeControl::changeLanes(), and traci::TraCIServer::handleRoadMapDomain().

                                                {
        return myNumericalID;
    }

EdgeBasicFunction MSEdge::getPurpose

(

)

const throw () [inline]

Returns the edge type (EdgeBasicFunction).

Returns:

This edge's EdgeBasicFunction

See also:

EdgeBasicFunction

Definition at line 192 of file MSEdge.h.

References myFunction.

Referenced by MSLane::appropriate(), MSVehicle::checkRewindLinkLanes(), MSVehicle::enterLaneAtMove(), MSVehicle::getBestLanesContinuation(), GUILaneWrapper::getPurpose(), traci::TraCIServer::postProcessSimulationStep(), and MSVehicle::vsafeCriticalCont().

                                                 {
        return myFunction;
    }

SUMOTime MSEdge::incVaporization

(

SUMOTime

t

)

throw (ProcessError)

Enables vaporization.

The internal vaporization counter is increased enabling the vaporization. Called from the event handler.

Parameters:

[in]

t

The current time (unused)

Returns:

Time to next call (always 0)

Exceptions:

ProcessError

not thrown by this method, just derived

Definition at line 224 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

                                                    {
    ++myVaporizationRequests;
    return 0;
}

void MSEdge::initialize	(	MSLane *	departLane,
		std::vector< MSLane * > *	lanes,
		EdgeBasicFunction	function
	)			throw ()

Initialize the edge.

Parameters:

[in]	allowed	Information which edges may be reached from which lanes
[in]	departLane	The default departure lane (may be 0)
[in]	lanes	List of this edge's lanes
[in]	function	A basic type of the edge

Definition at line 81 of file MSEdge.cpp.

References EDGEFUNCTION_DISTRICT, EDGEFUNCTION_INTERNAL, myDepartLane, myFunction, myLaneChanger, and myLanes.

Referenced by NLHandler::addDistrict(), and NLEdgeControlBuilder::closeEdge().

                                                                                  {
    assert(function == EDGEFUNCTION_DISTRICT || lanes!=0);
    myDepartLane = departLane;
    myLanes = lanes;
    myFunction = function;
    if (myLanes && myLanes->size() > 1 && function!=EDGEFUNCTION_INTERNAL) {
        myLaneChanger = new MSLaneChanger(myLanes);
    }
}

void MSEdge::insertIDs

(

std::vector< std::string > &

into

)

throw () [static]

Inserts IDs of all known edges into the given vector.

Definition at line 451 of file MSEdge.cpp.

References myDict.

Referenced by TraCIServerAPI_Edge::processGet().

                                                    {
    for (DictType::iterator i=myDict.begin(); i!=myDict.end(); ++i) {
        into.push_back((*i).first);
    }
}

bool MSEdge::isVaporizing

(

)

const throw () [inline]

Returns whether vehicles on this edge shall be vaporized.

Returns:

Whether no vehicle shall be on this edge

Definition at line 250 of file MSEdge.h.

References myVaporizationRequests.

Referenced by MSEmitter::childCheckEmit(), MSCalibrator::childCheckEmit(), emit(), and MSEmitControl::tryEmit().

                                      {
        return myVaporizationRequests>0;
    }

MSLane *const MSEdge::leftLane

(

const MSLane *const

lane

)

const throw ()

Returns the lane left to the one given, 0 if the given lane is leftmost.

Parameters:

[in]

lane

The lane right to the one to be returned

Returns:

The lane left to the given, 0 if no such lane exists

Todo:

This method searches for the given in the container; probably, this could be done faster

Definition at line 167 of file MSEdge.cpp.

References myLanes.

Referenced by traci::TraCIServer::commandStopNode(), and MSLane::getLeftLane().

                                                        {
    std::vector<MSLane*>::iterator laneIt = find(myLanes->begin(), myLanes->end(), lane);
    if (laneIt==myLanes->end()||laneIt==myLanes->end()-1) {
        return 0;
    }
    return *(laneIt+1);
}

MSEdge& MSEdge::operator=

(

const MSEdge &

)

[private]

assignment operator.

void MSEdge::parseEdgesList	(	const std::vector< std::string > &	desc,
		std::vector< const MSEdge * > &	into,
		const std::string &	rid
	)			throw (ProcessError) [static]

Parses the given string vector assuming it edge ids.

Parameters:

[in]	desc	The string vector containing edge ids
[out]	into	The vector to fill
[in]	rid	The id of the route these description belongs to; used for error message generation

Exceptions:

ProcessError

If one of the strings contained is not a known edge id

Definition at line 467 of file MSEdge.cpp.

References dictionary().

                                                                 {
    for (std::vector<std::string>::const_iterator i=desc.begin(); i!=desc.end(); ++i) {
        const MSEdge *edge = MSEdge::dictionary(*i);
        // check whether the edge exists
        if (edge==0) {
            throw ProcessError("The edge '" + *i + "' within route '" + rid + "' is not known."
                               + "\n The route can not be build.");
        }
        into.push_back(edge);
    }
}

void MSEdge::parseEdgesList	(	const std::string &	desc,
		std::vector< const MSEdge * > &	into,
		const std::string &	rid
	)			throw (ProcessError) [static]

Parses the given string assuming it contains a list of edge ids divided by spaces.

Splits the string at spaces, uses polymorph method to generate edge vector.

Parameters:

[in]	desc	The string containing space-separated edge ids
[out]	into	The vector to fill
[in]	rid	The id of the route these description belongs to; used for error message generation

Exceptions:

ProcessError

If one of the strings contained is not a known edge id

Definition at line 459 of file MSEdge.cpp.

References StringTokenizer::getVector().

Referenced by MSRouteHandler::myCharacters(), MSRouteHandler::myStartElement(), MSRouteHandler::openRoute(), and TraCIServerAPI_Vehicle::processSet().

                                                                 {
    StringTokenizer st(desc);
    parseEdgesList(st.getVector(), into, rid);
}

bool MSEdge::prohibits

(

const SUMOVehicle *const

vehicle

)

const throw ()

Returns whether the vehicle (class) is not allowed on the edge.

Definition at line 387 of file MSEdge.cpp.

References EDGEFUNCTION_DISTRICT, myFunction, myHaveClassConstraints, and myLanes.

                                                                 {
    if (myFunction == EDGEFUNCTION_DISTRICT || !myHaveClassConstraints) {
        return false;
    }
    SUMOVehicleClass vclass = vehicle->getVehicleType().getVehicleClass();
    for (std::vector<MSLane*>::iterator i=myLanes->begin(); i!=myLanes->end(); ++i) {
        if ((*i)->allowsVehicleClass(vclass)) {
            return false;
        }
    }
    return true;
}

void MSEdge::rebuildAllowedLanes

(

)

throw ()

Definition at line 124 of file MSEdge.cpp.

References myAllowed, myClassedAllowed, myHaveClassConstraints, and myLanes.

Referenced by closeBuilding(), TraCIServerAPI_Lane::processSet(), and TraCIServerAPI_Edge::processSet().

                                    {
    // build the classed allowed lanes
    myHaveClassConstraints = false;
    // build list of vehicle classes that are constrained
    // ... all others will be not regarded (allowed) ...
    std::set<SUMOVehicleClass> vclasses;
    for (std::vector<MSLane*>::const_iterator i2=myLanes->begin(); i2!=myLanes->end(); ++i2) {
        const std::vector<SUMOVehicleClass> &allowed = (*i2)->getAllowedClasses();
        for (std::vector<SUMOVehicleClass>::const_iterator j=allowed.begin(); j!=allowed.end(); j++) {
            vclasses.insert(*j);
        }
        const std::vector<SUMOVehicleClass> &disallowed = (*i2)->getNotAllowedClasses();
        for (std::vector<SUMOVehicleClass>::const_iterator j=disallowed.begin(); j!=disallowed.end(); j++) {
            vclasses.insert(*j);
        }
    }
    // go through these classes
    for (std::set<SUMOVehicleClass>::const_iterator j=vclasses.begin(); j!=vclasses.end(); ++j) {
        // go through connected edges
        for (AllowedLanesCont::iterator i1=myAllowed.begin(); i1!=myAllowed.end(); ++i1) {
            delete myClassedAllowed[*j][(*i1).first];
            myClassedAllowed[*j][(*i1).first] = new std::vector<MSLane*>();
            // go through lanes approaching current edge
            for (std::vector<MSLane*>::iterator i2=(*i1).second->begin(); i2!=(*i1).second->end(); ++i2) {
                // allows the current vehicle class?
                if ((*i2)->allowsVehicleClass(*j)) {
                    // -> may be used
                    myClassedAllowed[*j][(*i1).first]->push_back(*i2);
                }
            }
            // assert that 0 is returned if no connection is allowed for a class
            if (myClassedAllowed[*j][(*i1).first]->size()==0) {
                delete myClassedAllowed[*j][(*i1).first];
                myClassedAllowed[*j][(*i1).first] = 0;
            }
        }
        myHaveClassConstraints = true;
    }
}

MSLane *const MSEdge::rightLane

(

const MSLane *const

lane

)

const throw ()

Returns the lane right to the one given, 0 if the given lane is rightmost.

Parameters:

[in]

lane

The lane left to the one to be returned

Returns:

The lane right to the given, 0 if no such lane exists

Todo:

This method searches for the given in the container; probably, this could be done faster

Definition at line 177 of file MSEdge.cpp.

References myLanes.

Referenced by traci::TraCIServer::commandStopNode(), and MSLane::getRightLane().

                                                         {
    std::vector<MSLane*>::iterator laneIt = find(myLanes->begin(), myLanes->end(), lane);
    if (laneIt==myLanes->end()||laneIt==myLanes->begin()) {
        return 0;
    }
    return *(laneIt-1);
}

void MSEdge::setLastFailedEmissionTime

(

SUMOTime

time

)

const throw () [inline]

Sets the last time a vehicle could not be inserted.

Parameters:

[in]

time

the new value

Definition at line 349 of file MSEdge.h.

References myLastFailedEmissionTime.

Referenced by MSEmitControl::tryEmit().

                                                                       {
        myLastFailedEmissionTime = time;
    }

---

Field Documentation

AllowedLanesCont MSEdge::myAllowed [protected]

Associative container from destination-edge to allowed-lanes.

Definition at line 484 of file MSEdge.h.

Referenced by allowedLanes(), closeBuilding(), rebuildAllowedLanes(), and ~MSEdge().

ClassedAllowedLanesCont MSEdge::myClassedAllowed [protected]

From vehicle class to lanes allowed to be used by it.

Definition at line 487 of file MSEdge.h.

Referenced by allowedLanes(), rebuildAllowedLanes(), and ~MSEdge().

MSLane* MSEdge::myDepartLane [protected]

Lane from which vehicles will depart, usually the rightmost.

Definition at line 458 of file MSEdge.h.

Referenced by getDepartLane(), and initialize().

MSEdge::DictType MSEdge::myDict [static, protected]

Static dictionary to associate string-ids with objects.

Deprecated:

Move to MSEdgeControl, make non-static

Definition at line 504 of file MSEdge.h.

Referenced by clear(), dictionary(), dictSize(), GUIEdge::fill(), GUIEdge::getIDs(), and insertIDs().

std::vector< MSEdge * > MSEdge::myEdges [static, protected]

Static list of edges.

Deprecated:

Move to MSEdgeControl, make non-static

Definition at line 509 of file MSEdge.h.

Referenced by dictionary().

EdgeBasicFunction MSEdge::myFunction [protected]

the purpose of the edge

Definition at line 464 of file MSEdge.h.

Referenced by changeLanes(), GUIEdge::drawGL(), getPurpose(), initialize(), and prohibits().

bool MSEdge::myHaveClassConstraints [protected]

Whether any class constraints exist for this edge.

Definition at line 490 of file MSEdge.h.

Referenced by allowedLanes(), prohibits(), and rebuildAllowedLanes().

std::string MSEdge::myID [protected]

Unique ID.

Definition at line 449 of file MSEdge.h.

Referenced by getID().

MSLaneChanger* MSEdge::myLaneChanger [protected]

This member will do the lane-change.

Definition at line 461 of file MSEdge.h.

Referenced by changeLanes(), initialize(), and ~MSEdge().

std::vector<MSLane*>* MSEdge::myLanes [protected]

Container for the edge's lane; should be sorted: (right-hand-traffic) the more left the lane, the higher the container-index.

Definition at line 455 of file MSEdge.h.

Referenced by closeBuilding(), getCurrentTravelTime(), getDepartLane(), getLanes(), GUIEdge::getParameterWindow(), GUIEdge::initGeometry(), initialize(), leftLane(), prohibits(), rebuildAllowedLanes(), rightLane(), and ~MSEdge().

SUMOTime MSEdge::myLastFailedEmissionTime [mutable, protected]

The time of last emission failure.

Definition at line 470 of file MSEdge.h.

Referenced by getLastFailedEmissionTime(), and setLastFailedEmissionTime().

unsigned int MSEdge::myNumericalID [protected]

This edge's numerical id.

Definition at line 452 of file MSEdge.h.

Referenced by getNumericalID().

std::vector<MSEdge*> MSEdge::myPredeccesors [protected]

The preceeding edges.

Definition at line 476 of file MSEdge.h.

Referenced by closeBuilding(), and getIncomingEdges().

std::vector<MSEdge*> MSEdge::mySuccessors [protected]

The succeeding edges.

Definition at line 473 of file MSEdge.h.

Referenced by addFollower(), closeBuilding(), getFollower(), and getNoFollowing().

int MSEdge::myVaporizationRequests [protected]

Vaporizer counter.

Definition at line 467 of file MSEdge.h.

Referenced by decVaporization(), incVaporization(), and isVaporizing().

---

The documentation for this class was generated from the following files:

• MSEdge.h
• MSEdge.cpp