Eclipse SUMO - Simulation of Urban MObility
NBNodeCont.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2001-2023 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
22// Container for nodes during the netbuilding process
23/****************************************************************************/
24#pragma once
25#include <config.h>
26
27#include <string>
28#include <map>
29#include <vector>
30#include <set>
32#include <utils/geom/Position.h>
33#include "NBCont.h"
34#include "NBEdgeCont.h"
35#include "NBNode.h"
37
38
39// ===========================================================================
40// class declarations
41// ===========================================================================
42class NBDistrict;
43class OptionsCont;
44class OutputDevice;
45class NBParkingCont;
46class NBPTLineCont;
47class NBPTStopCont;
48
49
50// ===========================================================================
51// class definitions
52// ===========================================================================
58
59public:
61 typedef std::vector<NodeSet> NodeClusters;
62 typedef std::pair<NBNode*, double> NodeAndDist;
63
66
69
72
78 bool insert(const std::string& id, const Position& position, NBDistrict* district = 0);
79
84 bool insert(NBNode* node);
85
90 bool erase(NBNode* node);
91
97 bool extract(NBNode* node, bool remember = false);
98
103 NBNode* retrieve(const std::string& id) const;
104
110 NBNode* retrieve(const Position& position, const double offset = 0.) const;
111
113 std::map<std::string, NBNode*>::const_iterator begin() const {
114 return myNodes.begin();
115 }
116
118 std::map<std::string, NBNode*>::const_iterator end() const {
119 return myNodes.end();
120 }
122
125 /* @brief add ids of nodes wich shall not be joined
126 * @param[in] ids A list of ids to exclude from joining
127 * @note it does not check whether the nodes exist because all nodes may not have been loaded yet
128 */
129 void addJoinExclusion(const std::vector<std::string>& ids);
130
136 std::string createClusterId(const NodeSet& cluster, const std::string& prefix = "cluster_") {
137 std::set<std::string> clusterIds;
138 for (NBNode* j : cluster) {
139 clusterIds.insert(j->getID());
140 }
141 return createClusterId(clusterIds, prefix);
142 }
143
149 std::string createClusterId(const std::set<std::string>& cluster, const std::string& prefix = "cluster_");
150
154 void addCluster2Join(const std::set<std::string>& cluster, NBNode* node);
155
158
160 int joinJunctions(double maxDist, NBDistrictCont& dc, NBEdgeCont& ec, NBTrafficLightLogicCont& tlc, NBPTStopCont& sc);
161
164
166 static NodeSet getClusterNeighbors(const NBNode* n, double longThreshold, NodeSet& cluster);
167
169 static bool isSlipLaneContinuation(const NBNode* cont);
170
172 bool maybeSlipLaneStart(const NBNode* n, EdgeVector& outgoing, double& inAngle) const;
174 bool maybeSlipLaneEnd(const NBNode* n, EdgeVector& incoming, double& outAngle) const;
175
177 bool reduceToCircle(NodeSet& cluster, int circleSize, NodeSet startNodes, std::vector<NBNode*> cands = std::vector<NBNode*>()) const;
178
180 NBEdge* shortestEdge(const NodeSet& cluster, const NodeSet& startNodes, const std::vector<NBNode*>& exclude) const;
182
185
192
199 void joinSimilarEdges(NBDistrictCont& dc, NBEdgeCont& ec, NBTrafficLightLogicCont& tlc, bool removeDuplicates);
200
202 void avoidOverlap();
203
212
220 void removeComponents(NBDistrictCont& dc, NBEdgeCont& ec, const int numKeep, bool hasPTStops);
221
224
243 bool removeGeometryNodes);
245
248
254
257
259 bool recheckTLSThreshold(NBNode* node);
260
262 void computeKeepClear();
263
269 void joinTLS(NBTrafficLightLogicCont& tlc, double maxdist);
270
278 void setAsTLControlled(NBNode* node, NBTrafficLightLogicCont& tlc, TrafficLightType type, std::string id = "");
280
282 bool wasRemoved(std::string id) const {
283 return myExtractedNodes.count(id) != 0;
284 }
285
287 void addPrefix(const std::string& prefix);
288
290 void rename(NBNode* node, const std::string& newID);
291
293 void computeLanes2Lanes();
294
296 void computeLogics(const NBEdgeCont& ec);
297
299 void computeLogics2(const NBEdgeCont& ec, OptionsCont& oc);
300
302 int size() const {
303 return (int) myNodes.size();
304 }
305
307 void clear();
308
310 std::string getFreeID();
311
315 void computeNodeShapes(double mismatchThreshold = -1);
316
322 void printBuiltNodesStatistics() const;
323
325 std::vector<std::string> getAllNames() const;
326
327 /* @brief analyzes a cluster of nodes which shall be joined
328 * @param[in] cluster The nodes to be joined
329 * @param[out] id The name for the new node
330 * @param[out] pos The position of the new node
331 * @param[out] hasTLS Whether the new node has a traffic light
332 * @param[out] tlType The type of traffic light (if any)
333 */
334 void analyzeCluster(NodeSet cluster, std::string& id, Position& pos,
335 bool& hasTLS, TrafficLightType& type, SumoXMLNodeType& nodeType);
336
338 void registerJoinedCluster(const NodeSet& cluster);
339
341 const std::vector<std::set<std::string> >& getJoinedClusters() const {
342 return myJoinedClusters;
343 }
344
345 /* @brief discards traffic lights
346 * @param[in] geometryLike Whether only tls at geometry-like nodes shall be discarded
347 */
348 void discardTrafficLights(NBTrafficLightLogicCont& tlc, bool geometryLike, bool guessSignals);
349
351 void discardRailSignals();
352
354 void markAsSplit(const NBNode* node) {
355 mySplit.insert(node);
356 }
357
359 void markAsNotTLS(const NBNode* node) {
360 myUnsetTLS.insert(node);
361 }
362
364 int remapIDs(bool numericaIDs, bool reservedIDs, const std::string& prefix, NBTrafficLightLogicCont& tlc);
365
367 int guessFringe();
368
371
373 bool resetNodeShapes();
374
375private:
376
379
386 void generateNodeClusters(double maxDist, NodeClusters& into) const;
387
389 void pruneClusterFringe(NodeSet& cluster) const;
390
392 static int pruneLongEdges(NodeSet& cluster, double maxDist, const bool dryRun = false);
393
395 void pruneSlipLaneNodes(NodeSet& cluster) const;
396
398 bool feasibleCluster(const NodeSet& cluster, const std::map<const NBNode*, std::vector<NBNode*> >& ptStopEnds,
399 double maxDist, std::string& reason) const;
400
402 void joinNodeClusters(NodeClusters clusters, NBDistrictCont& dc, NBEdgeCont& ec, NBTrafficLightLogicCont& tlc, bool resetConnections = false);
404 NBNode* predefined = nullptr, bool resetConnections = false);
405
407
410
415 bool shouldBeTLSControlled(const NodeSet& c, double laneSpeedThreshold, bool recheck = false) const;
416
418 bool onlyCrossings(const NodeSet& c) const;
419
421 bool customTLID(const NodeSet& c) const;
423
425 void paretoCheck(NBNode* node, NodeSet& frontier, int xSign, int ySign);
426
428 typedef std::map<std::string, NBNode*> NodeCont;
429
432
435
437 std::set<std::string> myJoinExclusions;
438
440 std::vector<std::pair<std::set<std::string>, NBNode*> > myClusters2Join;
441
443 std::vector<std::set<std::string> > myJoinedClusters;
444
446 std::set<std::string> myJoined;
447
449 std::set<const NBNode*> mySplit;
450
452 std::set<NBNode*, ComparatorIdLess> myGuessedTLS;
453
455 std::set<const NBNode*> myUnsetTLS;
456
459
461 std::vector<std::vector<std::string> > myRailComponents;
462
464 NBNodeCont(const NBNodeCont& s) = delete;
465
467 NBNodeCont& operator=(const NBNodeCont& s) = delete;
468};
std::set< NBNode *, ComparatorIdLess > NodeSet
Definition: NBCont.h:52
std::vector< NBEdge * > EdgeVector
container for (sorted) edges
Definition: NBCont.h:42
TrafficLightType
SumoXMLNodeType
Numbers representing special SUMO-XML-attribute values for representing node- (junction-) types used ...
A container for districts.
A class representing a single district.
Definition: NBDistrict.h:62
Storage for edges, including some functionality operating on multiple edges.
Definition: NBEdgeCont.h:59
The representation of a single edge during network building.
Definition: NBEdge.h:92
Container for nodes during the netbuilding process.
Definition: NBNodeCont.h:57
void clear()
deletes all nodes
std::set< std::string > myJoinExclusions
set of node ids which should not be joined
Definition: NBNodeCont.h:437
std::vector< std::vector< std::string > > myRailComponents
network components that must be removed if not connected to the road network via stop access
Definition: NBNodeCont.h:461
bool wasRemoved(std::string id) const
Returns whether the node with the id was deleted explicitly.
Definition: NBNodeCont.h:282
NamedRTree myRTree
node positions for faster lookup
Definition: NBNodeCont.h:458
void removeRailComponents(NBDistrictCont &dc, NBEdgeCont &ec, NBPTStopCont &sc)
remove rail components after ptstops are built
Definition: NBNodeCont.cpp:412
void avoidOverlap()
fix overlap
Definition: NBNodeCont.cpp:532
bool onlyCrossings(const NodeSet &c) const
check wheter the set of nodes only contains pedestrian crossings
std::vector< std::pair< std::set< std::string >, NBNode * > > myClusters2Join
loaded sets of node ids to join (cleared after use)
Definition: NBNodeCont.h:440
void markAsNotTLS(const NBNode *node)
mark a node as explicitly not controlled by a TLS
Definition: NBNodeCont.h:359
std::string createClusterId(const NodeSet &cluster, const std::string &prefix="cluster_")
generate id from cluster node ids
Definition: NBNodeCont.h:136
int size() const
Returns the number of nodes stored in this container.
Definition: NBNodeCont.h:302
std::map< std::string, NBNode * >::const_iterator begin() const
Returns the pointer to the begin of the stored nodes.
Definition: NBNodeCont.h:113
void recheckGuessedTLS(NBTrafficLightLogicCont &tlc)
recheck myGuessedTLS after node logics are computed
std::vector< NodeSet > NodeClusters
Definition of a node cluster container.
Definition: NBNodeCont.h:61
void computeKeepClear()
compute keepClear status for all connections
NodeCont myNodes
The map of names to nodes.
Definition: NBNodeCont.h:431
bool feasibleCluster(const NodeSet &cluster, const std::map< const NBNode *, std::vector< NBNode * > > &ptStopEnds, double maxDist, std::string &reason) const
determine wether the cluster is not too complex for joining
void registerJoinedCluster(const NodeSet &cluster)
gets all joined clusters (see doc for myClusters2Join)
std::string getFreeID()
generates a new node ID
NBNodeCont(const NBNodeCont &s)=delete
invalidated copy constructor
bool recheckTLSThreshold(NBNode *node)
check whether a specific guessed tls should keep its type
void paretoCheck(NBNode *node, NodeSet &frontier, int xSign, int ySign)
update pareto frontier with the given node
bool maybeSlipLaneStart(const NBNode *n, EdgeVector &outgoing, double &inAngle) const
check whether the given node maybe the start of a slip lane
void addJoinExclusion(const std::vector< std::string > &ids)
Definition: NBNodeCont.cpp:658
bool erase(NBNode *node)
Removes the given node, deleting it.
Definition: NBNodeCont.cpp:146
std::map< std::string, NBNode * > NodeCont
Definition of the map of names to nodes.
Definition: NBNodeCont.h:428
int joinLoadedClusters(NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc)
Joins loaded junction clusters (see NIXMLNodesHandler)
Definition: NBNodeCont.cpp:719
void applyConditionalDefaults()
apply default values after loading
bool insert(const std::string &id, const Position &position, NBDistrict *district=0)
Inserts a node into the map.
Definition: NBNodeCont.cpp:87
std::set< const NBNode * > myUnsetTLS
nodes that are excluded from tls-guessing
Definition: NBNodeCont.h:455
int remapIDs(bool numericaIDs, bool reservedIDs, const std::string &prefix, NBTrafficLightLogicCont &tlc)
remap node IDs according to options –numerical-ids and –reserved-ids
NBNode * retrieve(const std::string &id) const
Returns the node with the given name.
Definition: NBNodeCont.cpp:116
NodeCont myExtractedNodes
The extracted nodes which are kept for reference.
Definition: NBNodeCont.h:434
void joinTLS(NBTrafficLightLogicCont &tlc, double maxdist)
Builds clusters of tls-controlled junctions and joins the control if possible.
int removeUnwishedNodes(NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc, NBPTStopCont &sc, NBPTLineCont &lc, NBParkingCont &pc, bool removeGeometryNodes)
Removes "unwished" nodes.
Definition: NBNodeCont.cpp:453
~NBNodeCont()
Destructor.
Definition: NBNodeCont.cpp:80
std::map< std::string, NBNode * >::const_iterator end() const
Returns the pointer to the end of the stored nodes.
Definition: NBNodeCont.h:118
bool reduceToCircle(NodeSet &cluster, int circleSize, NodeSet startNodes, std::vector< NBNode * > cands=std::vector< NBNode * >()) const
try to find a joinable subset (recursively)
NBNodeCont & operator=(const NBNodeCont &s)=delete
invalidated assignment operator
const std::vector< std::set< std::string > > & getJoinedClusters() const
gets all joined clusters (see doc for myClusters2Join)
Definition: NBNodeCont.h:341
bool extract(NBNode *node, bool remember=false)
Removes the given node but does not delete it.
Definition: NBNodeCont.cpp:157
NBNodeCont()
Constructor.
Definition: NBNodeCont.h:65
std::vector< std::string > getAllNames() const
get all node names
void computeLogics2(const NBEdgeCont &ec, OptionsCont &oc)
compute right-of-way logic for all lane-to-lane connections
bool shouldBeTLSControlled(const NodeSet &c, double laneSpeedThreshold, bool recheck=false) const
Returns whethe the given node cluster should be controlled by a tls.
void rename(NBNode *node, const std::string &newID)
Renames the node. Throws exception if newID already exists.
void joinSimilarEdges(NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc, bool removeDuplicates)
Joins edges connecting the same nodes.
Definition: NBNodeCont.cpp:187
void joinNodeClusters(NodeClusters clusters, NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc, bool resetConnections=false)
joins the given node clusters
void discardRailSignals()
discards rail signals
void addPrefix(const std::string &prefix)
add prefix to all nodes
void printBuiltNodesStatistics() const
Prints statistics about built nodes.
void removeIsolatedRoads(NBDistrictCont &dc, NBEdgeCont &ec)
Removes sequences of edges that are not connected with a junction. Simple roads without junctions som...
Definition: NBNodeCont.cpp:238
void setAsTLControlled(NBNode *node, NBTrafficLightLogicCont &tlc, TrafficLightType type, std::string id="")
Sets the given node as being controlled by a tls.
std::set< const NBNode * > mySplit
nodes that were created when splitting an edge
Definition: NBNodeCont.h:449
static NodeSet getClusterNeighbors(const NBNode *n, double longThreshold, NodeSet &cluster)
return all cluster neighbors for the given node
void computeLogics(const NBEdgeCont &ec)
build the list of outgoing edges and lanes
void joinNodeCluster(NodeSet clusters, NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc, NBNode *predefined=nullptr, bool resetConnections=false)
void generateNodeClusters(double maxDist, NodeClusters &into) const
Builds node clusters.
Definition: NBNodeCont.cpp:541
static bool isSlipLaneContinuation(const NBNode *cont)
whether the given node may continue a slip lane
void computeNodeShapes(double mismatchThreshold=-1)
Compute the junction shape for this node.
std::vector< std::set< std::string > > myJoinedClusters
sets of node ids which were joined
Definition: NBNodeCont.h:443
void pruneClusterFringe(NodeSet &cluster) const
remove geometry-like fringe nodes from cluster
Definition: NBNodeCont.cpp:922
NBEdge * shortestEdge(const NodeSet &cluster, const NodeSet &startNodes, const std::vector< NBNode * > &exclude) const
find closest neighbor for building circle
std::pair< NBNode *, double > NodeAndDist
Definition: NBNodeCont.h:62
void guessTLs(OptionsCont &oc, NBTrafficLightLogicCont &tlc)
Guesses which junctions or junction clusters shall be controlled by tls.
int guessFringe()
guess and mark fringe nodes
void markAsSplit(const NBNode *node)
mark a node as being created form a split
Definition: NBNodeCont.h:354
int joinJunctions(double maxDist, NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc, NBPTStopCont &sc)
Joins junctions that are very close together.
Definition: NBNodeCont.cpp:744
void computeLanes2Lanes()
divides the incoming lanes on outgoing lanes
void discardTrafficLights(NBTrafficLightLogicCont &tlc, bool geometryLike, bool guessSignals)
std::set< NBNode *, ComparatorIdLess > myGuessedTLS
nodes that received a traffic light due to guessing (–tls.guess)
Definition: NBNodeCont.h:452
void removeSelfLoops(NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tc)
Removes self-loop edges (edges where the source and the destination node are the same)
Definition: NBNodeCont.cpp:175
std::set< std::string > myJoined
ids found in loaded join clusters used for error checking
Definition: NBNodeCont.h:446
int joinSameJunctions(NBDistrictCont &dc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc)
Joins junctions with the same coordinates regardless of topology.
Definition: NBNodeCont.cpp:892
void analyzeCluster(NodeSet cluster, std::string &id, Position &pos, bool &hasTLS, TrafficLightType &type, SumoXMLNodeType &nodeType)
void addCluster2Join(const std::set< std::string > &cluster, NBNode *node)
add ids of nodes which shall be joined into a single node
Definition: NBNodeCont.cpp:691
bool customTLID(const NodeSet &c) const
check wheter the set of nodes contains traffic lights with custom id
bool resetNodeShapes()
reset all node shapes
static int pruneLongEdges(NodeSet &cluster, double maxDist, const bool dryRun=false)
avoid removal of long edges when joining junction clusters
bool maybeSlipLaneEnd(const NBNode *n, EdgeVector &incoming, double &outAngle) const
check whether the given node maybe the end of a slip lane
void removeComponents(NBDistrictCont &dc, NBEdgeCont &ec, const int numKeep, bool hasPTStops)
Checks the network for weak connectivity and removes all but the largest components....
Definition: NBNodeCont.cpp:326
void pruneSlipLaneNodes(NodeSet &cluster) const
remove nodes that form a slip lane from cluster
Represents a single node (junction) during network building.
Definition: NBNode.h:66
Container for public transport stops during the net building process.
Definition: NBPTStopCont.h:44
A container for traffic light definitions and built programs.
A RT-tree for efficient storing of SUMO's Named objects.
Definition: NamedRTree.h:61
A storage for options typed value containers)
Definition: OptionsCont.h:89
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37