A road/street connecting two junctions. More...

#include <MSEdge.h>

Inheritance diagram for MSEdge:

Data Structures
class	by_id_sorter
	Sorts edges by their ids. More...
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 (std::vector< MSLane * > *lanes, EdgeBasicFunction function) throw ()
	Initialize the edge.
	MSEdge (const std::string &id, unsigned int numericalID, const std::string &streetName="") 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 the edge's lanes
MSLane *	leftLane (const MSLane *const lane) const throw ()
	Returns the lane left to the one given, 0 if the given lane is leftmost.
MSLane *	rightLane (const MSLane *const lane) const throw ()
	Returns the lane right to the one given, 0 if the given lane is rightmost.
const std::vector< MSLane * > &	getLanes () const throw ()
	Returns this edge's lanes.
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 * > *	allowedLanes (SUMOVehicleClass vclass=SVC_UNKNOWN) const throw ()
	Get the allowed lanes for the given vehicle class.
Access to other edge attributes
const std::string &	getID () const throw ()
	Returns the id of the edge.
EdgeBasicFunction	getPurpose () const throw ()
	Returns the edge type (EdgeBasicFunction)
unsigned int	getNumericalID () const throw ()
	Returns the numerical id of the edge.
const std::string &	getStreetName () const
	Returns the street name of the edge.
Access to succeeding/predecessing edges
void	addFollower (MSEdge *edge) throw ()
	Returns the list of edges which may be reached from this edge.
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.
const MSEdge *	getFollower (unsigned int n) const throw ()
	Returns the n-th of the following edges.
Access to vaporizing interface
bool	isVaporizing () const throw ()
	Returns whether vehicles on this edge shall be vaporized.
SUMOTime	incVaporization (SUMOTime t) throw (ProcessError)
	Enables vaporization.
SUMOTime	decVaporization (SUMOTime t) throw (ProcessError)
	Disables vaporization.
Methods releated to vehicle insertion
bool	insertVehicle (SUMOVehicle &v, SUMOTime time) const throw (ProcessError)
	Tries to insert the given vehicle into the network.
MSLane *	getFreeLane (const std::vector< MSLane * > *allowed, const SUMOVehicleClass vclass) const throw ()
	Finds the emptiest lane allowing the vehicle class.
MSLane *	getDepartLane (const MSVehicle &veh) const throw ()
	Finds a depart lane for the given vehicle parameters.
SUMOTime	getLastFailedInsertionTime () const throw ()
	Returns the last time a vehicle could not be inserted.
void	setLastFailedInsertionTime (SUMOTime time) const throw ()
	Sets the last time a vehicle could not be inserted.
Static Public Member Functions
static void	clear () throw ()
	Clears the dictionary.
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 MSEdge *	dictionary (const std::string &id) throw ()
	Returns the MSEdge associated to the key id if exists, otherwise returns 0.
static MSEdge *	dictionary (size_t index) throw ()
	Returns the MSEdge at the index.
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::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.
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.
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
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	myLastFailedInsertionTime
	The time of last insertion 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.
std::string	myStreetName
Private Member Functions
	MSEdge (const MSEdge &)
	Invalidated copy constructor.
MSEdge &	operator= (const MSEdge &)
	assignment operator.
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.

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 63 of file MSEdge.h.

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 87 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 90 of file MSEdge.h.

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

definition of the static dictionary type

Definition at line 509 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 72 of file MSEdge.h.

Constructor & Destructor Documentation

MSEdge::MSEdge	(	const std::string &	id,
		unsigned int	numericalID,
		const std::string &	streetName = `""`
	)		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
[in]	streetName	The street name for that edge

Definition at line 62 of file MSEdge.cpp.

MSEdge::~MSEdge ( ) throw () [virtual]

Destructor.

Definition at line 69 of file MSEdge.cpp.

References myAllowed, myClassedAllowed, myLaneChanger, and myLanes.

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 221 of file MSEdge.h.

References mySuccessors.

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

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 201 of file MSEdge.cpp.

References SVC_UNKNOWN.

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 189 of file MSEdge.cpp.

Referenced by MSVehicleTransfer::checkInsertions(), MSVehicle::getBestLanes(), MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes(), MSLane::by_connections_to_sorter::operator()(), and MSLane::succLinkSec().

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 195 of file MSEdge.cpp.

void MSEdge::changeLanes ( SUMOTime t ) throw () [virtual]

Performs lane changing on this edge.

Definition at line 350 of file MSEdge.cpp.

Referenced by MSEdgeControl::changeLanes().

void MSEdge::clear ( ) throw () [static]

Clears the dictionary.

Definition at line 465 of file MSEdge.cpp.

References myDict.

Referenced by MSNet::clearAll().

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 96 of file MSEdge.cpp.

References MSLane::getEdge(), myAllowed, myLanes, myPredeccesors, mySuccessors, and 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 233 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

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 425 of file MSEdge.cpp.

Referenced by NLHandler::addConnection(), NLHandler::addDistrict(), NLHandler::addDistrictEdge(), NLBuilder::EdgeFloatTimeLineRetriever_EdgeTravelTime::addEdgeWeight(), NLBuilder::EdgeFloatTimeLineRetriever_EdgeEffort::addEdgeWeight(), NLEdgeControlBuilder::beginEdgeParsing(), NLTriggerBuilder::buildVaporizer(), MSDevice_Routing::buildVehicleDevices(), NLHandler::closeEdge(), TraCIServerAPI_Simulation::convertCartesianToRoadMap(), GUINet::getEdgeBoundary(), NLDetectorBuilder::getEdgeChecking(), TraCIServerAPI_Simulation::getLaneChecking(), MSTriggeredRerouter::myStartElement(), MSRouteHandler::myStartElement(), NLTriggerBuilder::parseAndBuildRerouter(), parseEdgesList(), MSDevice_Routing::preInsertionReroute(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_Route::processSet(), TraCIServerAPI_Edge::processSet(), and MSBaseVehicle::reroute().

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 441 of file MSEdge.cpp.

MSEdge * MSEdge::dictionary ( size_t index ) throw () [static]

Returns the MSEdge at the index.

Definition at line 452 of file MSEdge.cpp.

size_t MSEdge::dictSize ( ) throw () [static]

Returns the number of edges.

Definition at line 459 of file MSEdge.cpp.

References myDict.

Referenced by TraCIServerAPI_Simulation::commandDistanceRequest(), GUIEdge::fill(), MSTriggeredRerouter::notifyEnter(), MSDevice_Routing::preInsertionReroute(), TraCIServerAPI_Vehicle::processSet(), and MSDevice_Routing::wrappedRerouteCommandExecute().

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 380 of file MSEdge.cpp.

References myLanes, and SUMOReal.

Referenced by MSVehicleTransfer::addVeh(), MSVehicleTransfer::checkInsertions(), and TraCIServerAPI_Edge::processGet().

MSLane * MSEdge::getDepartLane ( const MSVehicle & veh ) const throw ()

Finds a depart lane for the given vehicle parameters.

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] veh The vehicle to get the depart lane for

Returns:: a possible/chosen depart lane, 0 if no lane can be used

Definition at line 259 of file MSEdge.cpp.

References DEPART_LANE_ALLOWED_FREE, DEPART_LANE_BEST_FREE, DEPART_LANE_DEFAULT, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, RandHelper::getRandomFrom(), and SUMOReal.

const MSEdge* 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 245 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

MSLane * MSEdge::getFreeLane	(	const std::vector< MSLane * > *	allowed,
		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.

If allowed==0, the lanes allowed for the given vehicle class will be used.

Parameters:

[in]	allowed	The lanes to choose from
[in]	vclass	The vehicle class to look for

Returns:: the least occupied lane

See also:: allowedLanes

Definition at line 240 of file MSEdge.cpp.

References MSLane::getVehicleNumber().

Referenced by MSVehicleTransfer::checkInsertions().

const std::string& MSEdge::getID ( ) const throw () [inline]

Returns the id of the edge.

Returns:: This edge's id

Definition at line 184 of file MSEdge.h.

References myID.

Referenced by MSVehicleTransfer::checkInsertions(), NLHandler::closeEdge(), NLHandler::getLanesFromIndices(), MSEdge::by_id_sorter::operator()(), TraCIServerAPI_Vehicle::processGet(), and TraCIServerAPI_Lane::processGet().

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 229 of file MSEdge.h.

References myPredeccesors.

Referenced by MSLane::getLogicalPredecessorLane().

const std::vector<MSLane*>& MSEdge::getLanes ( ) const throw () [inline]

SUMOTime MSEdge::getLastFailedInsertionTime ( ) const throw () [inline]

Returns the last time a vehicle could not be inserted.

Returns:: The current value

Definition at line 352 of file MSEdge.h.

References myLastFailedInsertionTime.

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 237 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

unsigned int MSEdge::getNumericalID ( ) const throw () [inline]

Returns the numerical id of the edge.

Returns:: This edge's numerical id

Definition at line 201 of file MSEdge.h.

References myNumericalID.

Referenced by MSEdgeControl::changeLanes().

EdgeBasicFunction MSEdge::getPurpose ( ) const throw () [inline]

Returns the edge type (EdgeBasicFunction)

Returns:: This edge's EdgeBasicFunction

See also:: EdgeBasicFunction

Definition at line 193 of file MSEdge.h.

References myFunction.

Referenced by MSLane::appropriate(), MSVehicle::enterLaneAtMove(), GUIEdge::getIDs(), and MSVehicle::vsafeCriticalCont().

const std::string& MSEdge::getStreetName ( ) const [inline]

Returns the street name of the edge.

Definition at line 208 of file MSEdge.h.

References myStreetName.

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 226 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

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

Initialize the edge.

Parameters:

[in]	allowed	Information which edges may be reached from which lanes
[in]	lanes	List of this edge's lanes
[in]	function	A basic type of the edge

Definition at line 85 of file MSEdge.cpp.

References OptionsCont::getOptions().

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

void MSEdge::insertIDs ( std::vector< std::string > & into ) throw () [static]

Inserts IDs of all known edges into the given vector.

Definition at line 474 of file MSEdge.cpp.

Referenced by TraCIServerAPI_Edge::processGet().

bool MSEdge::insertVehicle	(	SUMOVehicle &	v,
		SUMOTime	time
	)		const throw (ProcessError)

Tries to insert the given vehicle into the network.

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

Insertion itself is done by calling the chose lane's "insertVehicle" method.

Parameters:

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

Returns:: Whether the vehicle could be inserted

See also:: MSLane::insertVehicle

Definition at line 306 of file MSEdge.cpp.

References DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, SUMOVehicleParameter::departPos, SUMOVehicleParameter::departPosProcedure, MSLane::insertVehicle(), RandHelper::rand(), and SUMOReal.

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 258 of file MSEdge.h.

References myVaporizationRequests.

Referenced by MSVehicle::moveChecked(), and MSLane::setCritical().

MSLane * 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 169 of file MSEdge.cpp.

Referenced by MSLane::getLeftLane().

MSEdge& MSEdge::operator= ( const MSEdge & ) [private]

assignment operator.

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 482 of file MSEdge.cpp.

References StringTokenizer::getVector().

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

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 490 of file MSEdge.cpp.

References dictionary().

bool MSEdge::prohibits ( const SUMOVehicle *const vehicle ) const throw ()

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

Definition at line 410 of file MSEdge.cpp.

void MSEdge::rebuildAllowedLanes ( ) throw ()

Definition at line 126 of file MSEdge.cpp.

References myAllowed, myClassedAllowed, myHaveClassConstraints, and myLanes.

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

MSLane * MSEdge::rightLane ( const MSLane *const lane ) const throw ()