SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSEdge Class Reference

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

#include <MSEdge.h>

Inheritance diagram for MSEdge:
Named Parameterised GUIEdge

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

void addParameter (const std::string &key, const std::string &value)
 Adds a parameter.
void addParameter (const std::map< std::string, std::string > &mapArg)
 Adds all given parameter.
void addParameter (const Parameterised &p)
 Adds all given parameter.
virtual void addPerson (MSPerson *p) const
void addTo (const StoringVisitor &cont) const
 Adds this object to the given container.
virtual void changeLanes (SUMOTime t)
 Performs lane changing on this edge.
void clearParameter ()
 Clears the parameter map.
void closeBuilding ()
SUMOReal getCurrentTravelTime (const SUMOReal minSpeed=0.00001) const
 Computes and returns the current travel time for this edge.
SUMOReal getDistanceTo (const MSEdge *other) const
 optimistic air distance heuristic for use in routing
const std::string & getID () const
 Returns the id.
SUMOReal getLength () const
 return the length of the edge
const std::map< std::string,
std::string > & 
getMap () const
 Returns the inner key/value map.
SUMOReal getMinimumTravelTime (const SUMOVehicle *const veh) const
 returns the minimum travel time for the given vehicle
const std::string & getParameter (const std::string &key, const std::string &defaultValue) const
 Returns the value for a given key.
SUMOReal getSpeedLimit () const
 Returns the speed limit of the edge The speed limit of the first lane is retured; should probably be the fastest edge.
SUMOReal getVehicleMaxSpeed (const SUMOVehicle *const veh) const
 Returns the maximum speed the vehicle may use on this edge.
void initialize (std::vector< MSLane * > *lanes)
 Initialize the edge.
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known.
 MSEdge (const std::string &id, int numericalID, const EdgeBasicFunction function, const std::string &streetName="")
 Constructor.
bool prohibits (const SUMOVehicle *const vehicle) const
 Returns whether the vehicle (class) is not allowed on the edge.
void rebuildAllowedLanes ()
virtual void removePerson (MSPerson *p) const
void setID (const std::string &newID)
 resets the id
virtual ~MSEdge ()
 Destructor.
Access to the edge's lanes
MSLaneleftLane (const MSLane *const lane) const
 Returns the lane left to the one given, 0 if the given lane is leftmost.
MSLanerightLane (const MSLane *const lane) const
 Returns the lane right to the one given, 0 if the given lane is rightmost.
const std::vector< MSLane * > & getLanes () const
 Returns this edge's lanes.
const std::vector< MSLane * > * allowedLanes (const MSEdge &destination, SUMOVehicleClass vclass=SVC_UNKNOWN) const
 Get the allowed lanes to reach the destination-edge.
const std::vector< MSLane * > * allowedLanes (SUMOVehicleClass vclass=SVC_UNKNOWN) const
 Get the allowed lanes for the given vehicle class.
Access to other edge attributes
EdgeBasicFunction getPurpose () const
 Returns the edge type (EdgeBasicFunction)
int getNumericalID () const
 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)
 Returns the list of edges which may be reached from this edge.
const std::vector< MSEdge * > & getIncomingEdges () const
 Returns the list of edges from which this edge may be reached.
unsigned int getNoFollowing () const
 Returns the number of edges that may be reached from this edge.
const MSEdgegetFollower (unsigned int n) const
 Returns the n-th of the following edges.
Access to vaporizing interface
bool isVaporizing () const
 Returns whether vehicles on this edge shall be vaporized.
SUMOTime incVaporization (SUMOTime t)
 Enables vaporization.
SUMOTime decVaporization (SUMOTime t)
 Disables vaporization.
Methods releated to vehicle insertion
bool insertVehicle (SUMOVehicle &v, SUMOTime time) const
 Tries to insert the given vehicle into the network.
MSLanegetFreeLane (const std::vector< MSLane * > *allowed, const SUMOVehicleClass vclass) const
 Finds the emptiest lane allowing the vehicle class.
MSLanegetDepartLane (const MSVehicle &veh) const
 Finds a depart lane for the given vehicle parameters.
SUMOTime getLastFailedInsertionTime () const
 Returns the last time a vehicle could not be inserted.
void setLastFailedInsertionTime (SUMOTime time) const
 Sets the last time a vehicle could not be inserted.

Static Public Member Functions

static void clear ()
 Clears the dictionary.
static bool dictionary (const std::string &id, MSEdge *edge)
 Inserts edge into the static dictionary Returns true if the key id isn't already in the dictionary. Otherwise returns false.
static MSEdgedictionary (const std::string &id)
 Returns the MSEdge associated to the key id if exists, otherwise returns 0.
static MSEdgedictionary (size_t index)
 Returns the MSEdge at the index.
static size_t dictSize ()
 Returns the number of edges.
static void insertIDs (std::vector< std::string > &into)
 Inserts IDs of all known edges into the given vector.
static size_t numericalDictSize ()
 Returns the number of edges with a numerical id.
Static parser helper
static void parseEdgesList (const std::string &desc, std::vector< const MSEdge * > &into, const std::string &rid)
 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)
 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
 Get the allowed lanes to reach the destination-edge.
const std::vector< MSLane * > * getAllowedLanesWithDefault (const AllowedLanesCont &c, const MSEdge *dest) const
 lookup in map and return 0 if not found

Protected Attributes

const EdgeBasicFunction myFunction
 the purpose of the edge
std::string myID
 The name of the object.
MSLaneChangermyLaneChanger
 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.
int myNumericalID
 This edge's numerical id.
std::set< MSPerson * > myPersons
 Persons on the edge (only for drawing)
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.
SVCPermissions myMinimumPermissions
 The intersection of lane permissions for this edge.
SVCPermissions myCombinedPermissions
 The union of lane permissions for this edge.
std::string myStreetName

Private Member Functions

 MSEdge (const MSEdge &)
 Invalidated copy constructor.
MSEdgeoperator= (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 73 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 97 of file MSEdge.h.

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

Definition at line 100 of file MSEdge.h.

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

definition of the static dictionary type

Definition at line 574 of file MSEdge.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

MSEdge::MSEdge ( const std::string &  id,
int  numericalID,
const EdgeBasicFunction  function,
const std::string &  streetName = "" 
)

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]idThe id of the edge
[in]numericalIDThe numerical id (index) of the edge
[in]functionA basic type of the edge
[in]streetNameThe street name for that edge

Definition at line 70 of file MSEdge.cpp.

MSEdge::~MSEdge ( )
virtual

Destructor.

Definition at line 78 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)
inline

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

Returns
Edges reachable from this edge

Definition at line 223 of file MSEdge.h.

References mySuccessors.

Referenced by NLHandler::addDistrict().

void Parameterised::addParameter ( const std::string &  key,
const std::string &  value 
)
inherited

Adds a parameter.

Parameters
[in]keyThe parameter's name
[in]valueThe parameter's value

Definition at line 53 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NLHandler::addParam(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), and NIImporter_MATSim::EdgesHandler::myStartElement().

void Parameterised::addParameter ( const std::map< std::string, std::string > &  mapArg)
inherited

Adds all given parameter.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 59 of file Parameterised.cpp.

References Parameterised::myMap.

void Parameterised::addParameter ( const Parameterised p)
inherited

Adds all given parameter.

Parameters
[in]pThe keys/values to insert

Definition at line 67 of file Parameterised.cpp.

References Parameterised::myMap.

virtual void MSEdge::addPerson ( MSPerson p) const
inlinevirtual
void Named::addTo ( const StoringVisitor cont) const
inlineinherited

Adds this object to the given container.

Parameters
in,filled]cont The container to add this item to

Definition at line 114 of file Named.h.

References Named::StoringVisitor::add().

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

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]destinationThe edge to reach
[in]vclassThe 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 185 of file MSEdge.cpp.

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

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

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]vclassThe vehicle class for which this information shall be returned
Returns
The lanes that may be used by the given vclass

Definition at line 191 of file MSEdge.cpp.

References allowedLanes().

const std::vector< MSLane * > * MSEdge::allowedLanes ( const MSEdge destination,
SUMOVehicleClass  vclass = SVC_UNKNOWN 
) const
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]destinationThe edge to reach
[in]vclassThe 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 207 of file MSEdge.cpp.

References getAllowedLanesWithDefault(), myAllowed, myClassedAllowed, and myMinimumPermissions.

void MSEdge::changeLanes ( SUMOTime  t)
virtual

Performs lane changing on this edge.

Definition at line 377 of file MSEdge.cpp.

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

Referenced by MSEdgeControl::changeLanes().

void MSEdge::clear ( )
static

Clears the dictionary.

Definition at line 487 of file MSEdge.cpp.

References myDict.

Referenced by MSNet::clearAll().

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 91 of file Parameterised.cpp.

References Parameterised::myMap.

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

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

SUMOTime MSEdge::decVaporization ( SUMOTime  t)

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]tThe current time (unused)
Returns
Time to next call (always 0)
Exceptions
ProcessErrornot thrown by this method, just derived

Definition at line 253 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

MSEdge * MSEdge::dictionary ( const std::string &  id)
static

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

Definition at line 457 of file MSEdge.cpp.

References myDict.

MSEdge * MSEdge::dictionary ( size_t  index)
static

Returns the MSEdge at the index.

Definition at line 468 of file MSEdge.cpp.

References myEdges.

size_t MSEdge::dictSize ( )
static

Returns the number of edges.

Definition at line 475 of file MSEdge.cpp.

References myDict.

Referenced by GUIEdge::fill().

const std::vector< MSLane * > * MSEdge::getAllowedLanesWithDefault ( const AllowedLanesCont c,
const MSEdge dest 
) const
protected

lookup in map and return 0 if not found

Definition at line 197 of file MSEdge.cpp.

Referenced by allowedLanes().

SUMOReal MSEdge::getCurrentTravelTime ( const SUMOReal  minSpeed = 0.00001) const

Computes and returns the current travel time for this edge.

The mean speed of all lanes is used to compute the travel time. To avoid inifinte travel times, the given minimum speed is used.

Parameters
[in]minSpeedThe minimumSpeed to assume if traffic on this edge is stopped
Returns
The current effort (travel time) to pass the edge

Definition at line 411 of file MSEdge.cpp.

References getLength(), MSGlobals::gUseMesoSim, MAX2(), myLanes, and SUMOReal.

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

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

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]vehThe vehicle to get the depart lane for
Returns
a possible/chosen depart lane, 0 if no lane can be used

Definition at line 279 of file MSEdge.cpp.

References allowedLanes(), MSRoute::begin(), DEPART_LANE_ALLOWED_FREE, DEPART_LANE_BEST_FREE, DEPART_LANE_DEFAULT, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, SUMOVehicleParameter::departLane, SUMOVehicleParameter::departLaneProcedure, MSVehicle::getBestLanes(), getFreeLane(), MSBaseVehicle::getParameter(), RandHelper::getRandomFrom(), MSBaseVehicle::getRoute(), MSVehicleType::getVehicleClass(), MSBaseVehicle::getVehicleType(), myLanes, MSRoute::size(), and SUMOReal.

Referenced by insertVehicle().

SUMOReal MSEdge::getDistanceTo ( const MSEdge other) const

optimistic air distance heuristic for use in routing

Parameters
[in]otherThe edge to which the distance shall be returned
Returns
The distance to the other edge

Definition at line 534 of file MSEdge.cpp.

References getLanes().

const MSEdge* MSEdge::getFollower ( unsigned int  n) const
inline

Returns the n-th of the following edges.

Parameters
[in]nThe index within following edges of the edge to return
Returns
The n-th of the following edges

Definition at line 247 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

MSLane * MSEdge::getFreeLane ( const std::vector< MSLane * > *  allowed,
const SUMOVehicleClass  vclass 
) const

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]allowedThe lanes to choose from
[in]vclassThe vehicle class to look for
Returns
the least occupied lane
See Also
allowedLanes

Definition at line 260 of file MSEdge.cpp.

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

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

const std::string& Named::getID ( ) const
inlineinherited

Returns the id.

Returns
The stored id

Reimplemented in MS_E2_ZS_CollectorOverLanes.

Definition at line 60 of file Named.h.

References Named::myID.

Referenced by Named::StoringVisitor::add(), MSDetectorControl::add(), RORouteDef::addAlternative(), MSNet::addBusStop(), NBLoadedSUMOTLDef::addConnection(), NLHandler::addConnection(), RONet::addEdge(), ROJTREdge::addFollowerProbability(), RONet::addNode(), NIImporter_SUMO::addPhase(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), NBTrafficLightLogic::addStep(), MSRouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), MSPerson::MSPersonStage_Driving::beginEventOutput(), MSPerson::MSPersonStage_Waiting::beginEventOutput(), NIVisumTL::build(), RODFNet::buildApproachList(), MS_E2_ZS_CollectorOverLanes::buildCollector(), NIImporter_VISUM::buildDistrictNode(), NIVissimConnection::buildEdgeConnections(), RODFNet::buildEdgeFlowMap(), NBEdge::buildInnerEdges(), NGEdge::buildNBEdge(), NIVissimEdge::buildNBEdge(), NBRampsComputer::buildOffRamp(), NBRampsComputer::buildOnRamp(), MSVehicleTransfer::checkInsertions(), ODDistrictHandler::closeDistrict(), NLHandler::closeEdge(), RORouteHandler::closeRouteDistribution(), RORouteHandler::closeVehicle(), NBTrafficLightDefinition::collectAllLinks(), NBTrafficLightDefinition::collectEdges(), ROJTRRouter::compute(), NBTrafficLightDefinition::compute(), NBNode::computeInternalLaneShape(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBNode::computeNodeShape(), NBTrafficLightLogicCont::computeSingleLogic(), NBTurningDirectionsComputer::computeTurnDirectionsForNode(), NGNet::connect(), NBEdge::connections_sorter(), NLDetectorBuilder::convUncontE2PosLength(), MSLane::detectCollisions(), NIVissimDistrictConnection::dict_BuildDistricts(), MSPerson::MSPersonStage_Driving::endEventOutput(), MSPerson::MSPersonStage_Waiting::endEventOutput(), MSE3Collector::enter(), MSCalibrator::execute(), Command_SaveTLSSwitches::execute(), MSVTypeProbe::execute(), MSVehicle::executeMove(), MSLane::executeMovements(), NBNodeCont::extract(), NBTrafficLightLogicCont::extract(), NBEdgeCont::extract(), RODFDetectorCon::getAggFlowFor(), RODFDetectorCon::getAnyDetectorForEdge(), MSNet::getBusStopID(), MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes(), AGStreet::getName(), NIImporter_VISUM::getNamedEdgeContinuating(), NLTriggerBuilder::getPosition(), NLDetectorBuilder::getPositionChecking(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBEdgeCont::ignoreFilterMatch(), MSActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NBDistrictCont::insert(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), NBEdgeCont::joinSameNodeConnectingEdges(), MSE3Collector::leave(), NIImporter_OpenDrive::loadNetwork(), NBRampsComputer::moveRampRight(), MSPerson::MSPersonStage_Waiting::MSPersonStage_Waiting(), MSVehicle::MSVehicle(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), NIXMLTrafficLightsHandler::myEndElement(), NIXMLEdgesHandler::myEndElement(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), MSDevice_Person::notifyLeave(), RORouteHandler::openRoute(), Named::ComparatorIdLess::operator()(), NBTurningDirectionsComputer::combination_by_angle_sorter::operator()(), RODFNet::idComp::operator()(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), MSEdge::by_id_sorter::operator()(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), NBLoadedTLDef::SignalGroup::patchTYellow(), AGStreet::print(), TraCIServerAPI_Lane::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_InductionLoop::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Vehicle::processSet(), NWWriter_SUMO::prohibitionConnection(), NBEdgeCont::recheckPostProcessConnections(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), NBLoadedSUMOTLDef::removeConnection(), NBNode::removeSelfLoops(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::removeUnwishedNodes(), NBNodeCont::rename(), NBEdgeCont::rename(), NBConnection::replaceFrom(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIImporter_DlrNavteq::TrafficlightsHandler::report(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), PCPolyContainer::save(), RONet::saveAndRemoveRoutesUntil(), NBNodeCont::setAsTLControlled(), NBEdge::setControllingTLInformation(), NIXMLEdgesHandler::setNodes(), NBOwnTLDef::setTLControllingInformation(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBEdgeCont::splitAt(), NIXMLConnectionsHandler::validateLaneInfo(), TraCIServerAPI_Vehicle::vtdMap_matchingEdgeLane(), TraCIServerAPI_Vehicle::vtdMap_matchingRoutePosition(), MSEmissionExport::write(), MSFCDExport::write(), MSInstantInductLoop::write(), NBSign::writeAsPOI(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), MSFullExport::writeEdge(), MSXMLRawOut::writeEdge(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeInternalConnections(), NWWriter_SUMO::writeJunction(), MSQueueExport::writeLane(), MSFullExport::writeLane(), NWWriter_DlrNavteq::writeLinksUnsplitted(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), MSInductLoop::writeTypedXMLOutput(), MSFullExport::writeVehicles(), MSRouteProbe::writeXMLOutput(), and MSE2Collector::writeXMLOutput().

const std::vector<MSEdge*>& MSEdge::getIncomingEdges ( ) const
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 231 of file MSEdge.h.

References myPredeccesors.

Referenced by MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes(), and MSLane::getLogicalPredecessorLane().

const std::vector<MSLane*>& MSEdge::getLanes ( ) const
inline
SUMOTime MSEdge::getLastFailedInsertionTime ( ) const
inline

Returns the last time a vehicle could not be inserted.

Returns
The current value

Definition at line 363 of file MSEdge.h.

References myLastFailedInsertionTime.

const std::map<std::string, std::string>& Parameterised::getMap ( ) const
inlineinherited

Returns the inner key/value map.

Returns
the inner map

Definition at line 106 of file Parameterised.h.

References Parameterised::myMap.

Referenced by PCPolyContainer::save().

SUMOReal MSEdge::getMinimumTravelTime ( const SUMOVehicle *const  veh) const
inline

returns the minimum travel time for the given vehicle

Definition at line 302 of file MSEdge.h.

References getLength(), SUMOVehicle::getMaxSpeed(), getSpeedLimit(), getVehicleMaxSpeed(), and MIN2().

Referenced by MSDevice_Routing::getEffort(), and MSNet::getTravelTime().

unsigned int MSEdge::getNoFollowing ( ) const
inline

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

Returns
The number of following edges

Definition at line 239 of file MSEdge.h.

References mySuccessors.

Referenced by MSRouteHandler::myStartElement().

int MSEdge::getNumericalID ( ) const
inline

Returns the numerical id of the edge.

Returns
This edge's numerical id

Definition at line 203 of file MSEdge.h.

References myNumericalID.

Referenced by MSEdgeControl::changeLanes(), and dictionary().

const std::string & Parameterised::getParameter ( const std::string &  key,
const std::string &  defaultValue 
) const
inherited

Returns the value for a given key.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Definition at line 81 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by TraCIServerAPI_Vehicle::vtdMap_matchingNearest().

SUMOReal MSEdge::getSpeedLimit ( ) const

Returns the speed limit of the edge The speed limit of the first lane is retured; should probably be the fastest edge.

Returns
The maximum speed allowed on this edge

Definition at line 550 of file MSEdge.cpp.

References getLanes().

Referenced by getMinimumTravelTime(), MSCalibrator::invalidJam(), MSCalibrator::remainingVehicleCapacity(), and MSMeanData::writeEdge().

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

Returns the street name of the edge.

Definition at line 210 of file MSEdge.h.

References myStreetName.

Referenced by GUIEdge::drawGL(), and GUILaneWrapper::getParameterWindow().

SUMOReal MSEdge::getVehicleMaxSpeed ( const SUMOVehicle *const  veh) const

Returns the maximum speed the vehicle may use on this edge.

Note that the vehicle's max. speed is not considered herein, only the edge's speed limit and the driver's adaptation of this speed. Only the first lane is considered

Returns
The maximum velocity on this edge for the given vehicle

Definition at line 557 of file MSEdge.cpp.

References getLanes().

Referenced by getMinimumTravelTime().

SUMOTime MSEdge::incVaporization ( SUMOTime  t)

Enables vaporization.

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

Parameters
[in]tThe current time (unused)
Returns
Time to next call (always 0)
Exceptions
ProcessErrornot thrown by this method, just derived

Definition at line 246 of file MSEdge.cpp.

References myVaporizationRequests.

Referenced by NLTriggerBuilder::buildVaporizer().

void MSEdge::initialize ( std::vector< MSLane * > *  lanes)

Initialize the edge.

Parameters
[in]allowedInformation which edges may be reached from which lanes
[in]lanesList of this edge's lanes

Definition at line 94 of file MSEdge.cpp.

References EDGEFUNCTION_DISTRICT, EDGEFUNCTION_INTERNAL, OptionsCont::getOptions(), myCombinedPermissions, myFunction, myLaneChanger, myLanes, and SVCFreeForAll.

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

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

Inserts IDs of all known edges into the given vector.

Definition at line 496 of file MSEdge.cpp.

References myDict.

Referenced by TraCIServerAPI_Edge::processGet().

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

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]vThe vehicle to insert
[in]timeThe current simulation time
Returns
Whether the vehicle could be inserted
See Also
MSLane::insertVehicle

Definition at line 326 of file MSEdge.cpp.

References DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, SUMOVehicleParameter::departPos, SUMOVehicleParameter::departPosProcedure, getDepartLane(), SUMOVehicle::getID(), getLength(), SUMOVehicle::getParameter(), MSGlobals::gUseMesoSim, MSLane::insertVehicle(), isVaporizing(), RandHelper::rand(), SUMOReal, toString(), UNUSED_PARAMETER, and WRITE_WARNING.

Referenced by MSCalibrator::execute().

bool MSEdge::isVaporizing ( ) const
inline

Returns whether vehicles on this edge shall be vaporized.

Returns
Whether no vehicle shall be on this edge

Definition at line 260 of file MSEdge.h.

References myVaporizationRequests.

Referenced by MSVehicle::executeMove(), MSLane::executeMovements(), and insertVehicle().

bool Parameterised::knowsParameter ( const std::string &  key) const
inherited

Returns whether the parameter is known.

Parameters
[in]keyThe key to ask for
Returns
Whether the key is known

Definition at line 75 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by TraCIServerAPI_Vehicle::vtdMap_matchingNearest().

MSLane * MSEdge::leftLane ( const MSLane *const  lane) const

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

Parameters
[in]laneThe 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 165 of file MSEdge.cpp.

References myLanes.

Referenced by MSLane::getLeftLane().

size_t MSEdge::numericalDictSize ( )
static

Returns the number of edges with a numerical id.

Definition at line 481 of file MSEdge.cpp.

References myEdges.

Referenced by MSDevice_Routing::getRouter(), MSNet::getRouterEffort(), and MSNet::getRouterTT().

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

assignment operator.

void MSEdge::parseEdgesList ( const std::string &  desc,
std::vector< const MSEdge * > &  into,
const std::string &  rid 
)
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]descThe string containing space-separated edge ids
[out]intoThe vector to fill
[in]ridThe id of the route these description belongs to; used for error message generation
Exceptions
ProcessErrorIf one of the strings contained is not a known edge id

Definition at line 504 of file MSEdge.cpp.

References BinaryFormatter::BF_ROUTE, StringTokenizer::getVector(), and FileHelpers::readEdgeVector().

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 
)
static

Parses the given string vector assuming it edge ids.

Parameters
[in]descThe string vector containing edge ids
[out]intoThe vector to fill
[in]ridThe id of the route these description belongs to; used for error message generation
Exceptions
ProcessErrorIf one of the strings contained is not a known edge id

Definition at line 519 of file MSEdge.cpp.

References dictionary().

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

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

Definition at line 387 of file MSEdge.h.

References MSVehicleType::getVehicleClass(), SUMOVehicle::getVehicleType(), and myCombinedPermissions.

void MSEdge::rebuildAllowedLanes ( )
virtual void MSEdge::removePerson ( MSPerson p) const
inlinevirtual
MSLane * MSEdge::rightLane ( const MSLane *const  lane) const

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

Parameters
[in]laneThe 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 175 of file MSEdge.cpp.

References myLanes.

Referenced by MSLane::getRightLane().

void Named::setID ( const std::string &  newID)
inlineinherited

resets the id

Parameters
[in]newIDThe new id of this object

Definition at line 68 of file Named.h.

References Named::myID.

Referenced by NBNodeCont::rename(), and NBEdgeCont::rename().

void MSEdge::setLastFailedInsertionTime ( SUMOTime  time) const
inline

Sets the last time a vehicle could not be inserted.

Parameters
[in]timethe new value

Definition at line 371 of file MSEdge.h.

References myLastFailedInsertionTime.

Field Documentation

AllowedLanesCont MSEdge::myAllowed
protected

Associative container from destination-edge to allowed-lanes.

Definition at line 554 of file MSEdge.h.

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

ClassedAllowedLanesCont MSEdge::myClassedAllowed
mutableprotected

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

Definition at line 558 of file MSEdge.h.

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

SVCPermissions MSEdge::myCombinedPermissions
protected

The union of lane permissions for this edge.

Definition at line 563 of file MSEdge.h.

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

MSEdge::DictType MSEdge::myDict
staticprotected

Static dictionary to associate string-ids with objects.

Deprecated:
Move to MSEdgeControl, make non-static

Definition at line 579 of file MSEdge.h.

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

std::vector< MSEdge * > MSEdge::myEdges
staticprotected

Static list of edges.

Deprecated:
Move to MSEdgeControl, make non-static

Definition at line 584 of file MSEdge.h.

Referenced by dictionary(), and numericalDictSize().

const EdgeBasicFunction MSEdge::myFunction
protected

the purpose of the edge

Definition at line 533 of file MSEdge.h.

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

MSLaneChanger* MSEdge::myLaneChanger
protected

This member will do the lane-change.

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

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

SUMOTime MSEdge::myLastFailedInsertionTime
mutableprotected

The time of last insertion failure.

Definition at line 539 of file MSEdge.h.

Referenced by getLastFailedInsertionTime(), and setLastFailedInsertionTime().

SVCPermissions MSEdge::myMinimumPermissions
protected

The intersection of lane permissions for this edge.

Definition at line 561 of file MSEdge.h.

Referenced by allowedLanes(), and rebuildAllowedLanes().

int MSEdge::myNumericalID
protected

This edge's numerical id.

Definition at line 524 of file MSEdge.h.

Referenced by getNumericalID().

std::set<MSPerson*> MSEdge::myPersons
mutableprotected

Persons on the edge (only for drawing)

Definition at line 548 of file MSEdge.h.

Referenced by addPerson(), GUIEdge::drawGL(), and removePerson().

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

The preceeding edges.

Definition at line 545 of file MSEdge.h.

Referenced by closeBuilding(), and getIncomingEdges().

std::string MSEdge::myStreetName
protected

Definition at line 565 of file MSEdge.h.

Referenced by GUIEdge::drawGL(), and getStreetName().

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

The succeeding edges.

Definition at line 542 of file MSEdge.h.

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

int MSEdge::myVaporizationRequests
protected

Vaporizer counter.

Definition at line 536 of file MSEdge.h.

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


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