sumolib.net
index
/home/delphi/gcc/sumo/tools/sumolib/net/__init__.py

This file contains a content handler for parsing sumo network xml files.
It uses other classes from this module to represent the road network.

 
Package Contents
       
connection
edge
generator (package)
lane
node
roundabout

 
Classes
       
Net
Phase
TLS
TLSProgram
xml.sax.handler.ContentHandler
NetReader

 
class Net
    The whole sumo network.
 
  Methods defined here:
__init__(self)
addConnection(self, fromEdge, toEdge, fromlane, tolane, direction, tls, tllink, state, viaLaneID=None)
addEdge(self, id, fromID, toID, prio, function, name)
addLane(self, edge, speed, length, width, allow=None, disallow=None)
addNode(self, id, type=None, coord=None, incLanes=None, intLanes=None)
addRoundabout(self, nodes, edges=None)
addTLS(self, tlid, inLane, outLane, linkNo)
addTLSProgram(self, tlid, programID, offset, type, removeOthers)
convertLonLat2XY(self, lon, lat, rawUTM=False)
convertXY2LonLat(self, x, y, rawUTM=False)
forbids(self, possProhibitor, possProhibited)
getBBoxDiameter(self)
# the diagonal of the bounding box of all nodes
getBBoxXY(self)
Get the bounding box (bottom left and top right coordinates) for a net;
Coordinates are in X and Y (not Lat and Lon)
 
:return [(bottom_left_X, bottom_left_Y), (top_right_X, top_right_Y)]
getBoundary(self)
return xmin,ymin,xmax,ymax network coordinates
getDownstreamEdges(self, edge, distance, stopOnTLS, stopOnTurnaround)
return a list of lists of the form
[[firstEdge, pos, [edge_0, edge_1, ..., edge_k], aborted], ...]
where
  firstEdge: is the downstream edge furthest away from the intersection,
  [edge_0, ..., edge_k]: is the list of edges from the intersection downstream to firstEdge
  pos: is the position on firstEdge with distance to the end of the input edge
  aborted: a flag indicating whether the downstream
      search stopped at a TLS or a node without incoming edges before reaching the distance threshold
getEdge(self, id)
getEdges(self, withInternal=True)
getEdgesByOrigID(self, origID)
getGeoProj(self)
getLane(self, laneID)
getLocationOffset(self)
offset to be added after converting from geo-coordinates to UTM
getNeighboringEdges(self, x, y, r=0.1, includeJunctions=True, allowFallback=True)
# Please be aware that the resulting list of edges is NOT sorted
getNeighboringLanes(self, x, y, r=0.1, includeJunctions=True, allowFallback=True)
getNode(self, id)
getNodes(self)
getRoundabouts(self)
getShortestPath(self, fromEdge, toEdge, maxCost=inf, vClass=None)
getTLS(self, tlid)
getTLSSecure(self, tlid)
getTrafficLights(self)
hasEdge(self, id)
hasNode(self, id)
move(self, dx, dy, dz=0)
setAdditionalNodeInfo(self, node, type, coord, incLanes, intLanes=None)
setFoes(self, junctionID, index, foes, prohibits)
setLocation(self, netOffset, convBoundary, origBoundary, projParameter)

 
class NetReader(xml.sax.handler.ContentHandler)
    Reads a network, storing the edge geometries, lane numbers and max. speeds
 
  Methods defined here:
__init__(self, **others)
endDocument(self)
endElement(self, name)
getNet(self)
startElement(self, name, attrs)

Methods inherited from xml.sax.handler.ContentHandler:
characters(self, content)
Receive notification of character data.
 
The Parser will call this method to report each chunk of
character data. SAX parsers may return all contiguous
character data in a single chunk, or they may split it into
several chunks; however, all of the characters in any single
event must come from the same external entity so that the
Locator provides useful information.
endElementNS(self, name, qname)
Signals the end of an element in namespace mode.
 
The name parameter contains the name of the element type, just
as with the startElementNS event.
endPrefixMapping(self, prefix)
End the scope of a prefix-URI mapping.
 
See startPrefixMapping for details. This event will always
occur after the corresponding endElement event, but the order
of endPrefixMapping events is not otherwise guaranteed.
ignorableWhitespace(self, whitespace)
Receive notification of ignorable whitespace in element content.
 
Validating Parsers must use this method to report each chunk
of ignorable whitespace (see the W3C XML 1.0 recommendation,
section 2.10): non-validating parsers may also use this method
if they are capable of parsing and using content models.
 
SAX parsers may return all contiguous whitespace in a single
chunk, or they may split it into several chunks; however, all
of the characters in any single event must come from the same
external entity, so that the Locator provides useful
information.
processingInstruction(self, target, data)
Receive notification of a processing instruction.
 
The Parser will invoke this method once for each processing
instruction found: note that processing instructions may occur
before or after the main document element.
 
A SAX parser should never report an XML declaration (XML 1.0,
section 2.8) or a text declaration (XML 1.0, section 4.3.1)
using this method.
setDocumentLocator(self, locator)
Called by the parser to give the application a locator for
locating the origin of document events.
 
SAX parsers are strongly encouraged (though not absolutely
required) to supply a locator: if it does so, it must supply
the locator to the application by invoking this method before
invoking any of the other methods in the DocumentHandler
interface.
 
The locator allows the application to determine the end
position of any document-related event, even if the parser is
not reporting an error. Typically, the application will use
this information for reporting its own errors (such as
character content that does not match an application's
business rules). The information returned by the locator is
probably not sufficient for use with a search engine.
 
Note that the locator will return correct information only
during the invocation of the events in this interface. The
application should not attempt to use it at any other time.
skippedEntity(self, name)
Receive notification of a skipped entity.
 
The Parser will invoke this method once for each entity
skipped. Non-validating processors may skip entities if they
have not seen the declarations (because, for example, the
entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
http://xml.org/sax/features/external-general-entities and the
http://xml.org/sax/features/external-parameter-entities
properties.
startDocument(self)
Receive notification of the beginning of a document.
 
The SAX parser will invoke this method only once, before any
other methods in this interface or in DTDHandler (except for
setDocumentLocator).
startElementNS(self, name, qname, attrs)
Signals the start of an element in namespace mode.
 
The name parameter contains the name of the element type as a
(uri, localname) tuple, the qname parameter the raw XML 1.0
name used in the source document, and the attrs parameter
holds an instance of the Attributes class containing the
attributes of the element.
 
The uri part of the name tuple is None for elements which have
no namespace.
startPrefixMapping(self, prefix, uri)
Begin the scope of a prefix-URI Namespace mapping.
 
The information from this event is not necessary for normal
Namespace processing: the SAX XML reader will automatically
replace prefixes for element and attribute names when the
http://xml.org/sax/features/namespaces feature is true (the
default).
 
There are cases, however, when applications need to use
prefixes in character data or in attribute values, where they
cannot safely be expanded automatically; the
start/endPrefixMapping event supplies the information to the
application to expand prefixes in those contexts itself, if
necessary.
 
Note that start/endPrefixMapping events are not guaranteed to
be properly nested relative to each-other: all
startPrefixMapping events will occur before the corresponding
startElement event, and all endPrefixMapping events will occur
after the corresponding endElement event, but their order is
not guaranteed.

 
class Phase
     Methods defined here:
__init__(self, duration, state, minDur=-1, maxDur=-1, next=[], name='')
__repr__(self)

 
class TLS
    Traffic Light Signal for a sumo network
 
  Methods defined here:
__init__(self, id)
addConnection(self, inLane, outLane, linkNo)
addProgram(self, program)
getConnections(self)
getEdges(self)
getID(self)
getLinks(self)
getPrograms(self)
removePrograms(self)
toXML(self)

 
class TLSProgram
     Methods defined here:
__init__(self, id, offset, type)
addPhase(self, state, duration, minDur=-1, maxDur=-1, next=[], name='')
getParam(self, key, default=None)
getParams(self)
getPhases(self)
getType(self)
setParam(self, key, value)
toXML(self, tlsID)

 
Functions
       
convertShape(shapeString)
Convert xml shape string into float tuples.
 
This method converts the 2d or 3d shape string from SUMO's xml file
into a list containing 3d float-tuples. Non existant z coordinates default
to zero. If shapeString is empty, an empty list will be returned.
readNet(filename, **others)
load a .net.xml file
The following named options are supported:
 
    'net' : initialize data structurs with an existing net object (default Net())
    'withPrograms' : import all traffic light programs (default False)
    'withLatestPrograms' : import only the last program for each traffic light.
                           This is the program that would be active in sumo by default.
                           (default False)
    'withConnections' : import all connections (default True)
    'withFoes' : import right-of-way information (default True)
    'withInternal' : import internal edges and lanes (default False)
    'withPedestrianConnections' : import connections between sidewalks, crossings (default False)

 
Data
        absolute_import = _Feature((2, 5, 0, 'alpha', 1), (3, 0, 0, 'alpha', 0), 16384)
print_function = _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 65536)