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

Importer for network edges stored in XML. More...

#include <NIXMLEdgesHandler.h>

Inheritance diagram for NIXMLEdgesHandler:
SUMOSAXHandler GenericSAXHandler DefaultHandler

Data Structures

struct  Split
 A structure which describes changes of lane number along the road. More...
class  split_by_pos_finder
 Finds a split at the given position. More...
class  split_sorter
 Sorts splits by their position (increasing) More...

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured.
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed.
const std::string & getFileName () const
 returns the current file name
 NIXMLEdgesHandler (NBNodeCont &nc, NBEdgeCont &ec, NBTypeCont &tc, NBDistrictCont &dc, NBTrafficLightLogicCont &tlc, OptionsCont &options)
 Constructor.
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed.
void setFileName (const std::string &name)
 Sets the current file name.
void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
 The inherited method called when a new tag opens.
 ~NIXMLEdgesHandler ()
 Destructor.
SAX ErrorHandler callbacks
void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings.
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.

Protected Member Functions

std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message.
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.
void myEndElement (int element)
 Called when a closing tag occurs.

Private Member Functions

void addEdge (const SUMOSAXAttributes &attrs)
 Parses an edge and stores the values in "myCurrentEdge".
void addLane (const SUMOSAXAttributes &attrs)
 Parses a lane and modifies myCurrentEdge according to the given attribures.
void addSplit (const SUMOSAXAttributes &attrs)
 Parses a split and stores it in mySplits. Splits are executed Upon reading the end tag of an edge.
void deleteEdge (const SUMOSAXAttributes &attrs)
 parses delete tag and deletes the specified edge
 NIXMLEdgesHandler (const NIXMLEdgesHandler &s)
 invalid copy constructor
NIXMLEdgesHandleroperator= (const NIXMLEdgesHandler &s)
 invalid assignment operator
bool setNodes (const SUMOSAXAttributes &attrs)
 Sets from/to node information of the currently parsed edge.
LaneSpreadFunction tryGetLaneSpread (const SUMOSAXAttributes &attrs)
 Tries to parse the spread type.
PositionVector tryGetShape (const SUMOSAXAttributes &attrs)
 Tries to parse the shape definition.

Private Attributes

NBEdgemyCurrentEdge
 The currently processed edge.
bool myHaveReportedAboutOverwriting
 Information whether at least one edge's attributes were overwritten.
bool myHaveWarnedAboutDeprecatedLaneId
bool myIsUpdate
 Whether this edge definition is an update of a previously inserted edge.
const bool myKeepEdgeShape
 Whether the edge shape shall be kept generally.
OptionsContmyOptions
 A reference to the program's options.
std::vector< SplitmySplits
 The list of this edge's splits.
Currently parsed edge's values
std::string myCurrentID
 The current edge's id.
SUMOReal myCurrentSpeed
 The current edge's maximum speed.
int myCurrentPriority
 The current edge's priority.
int myCurrentLaneNo
 The current edge's number of lanes.
SUMOReal myCurrentWidth
 The current edge's lane width.
SUMOReal myCurrentEndOffset
 The current edge's offset till the destination node.
std::string myCurrentStreetName
 The current edge's street name.
std::string myCurrentType
 The current edge's type.
NBNodemyFromNode
 The nodes the edge starts and ends at.
NBNodemyToNode
SUMOReal myLength
 The current edge's length.
PositionVector myShape
 The shape of the edge.
LaneSpreadFunction myLanesSpread
 Information about how to spread the lanes.
SVCPermissions myPermissions
 Information about lane permissions.
bool myReinitKeepEdgeShape
 Whether the edge shape shall be kept at reinitilization.
Used instance containers (access to nodes, edges, types, etc.)
NBNodeContmyNodeCont
 The nodes container (for retrieval of referenced nodes)
NBEdgeContmyEdgeCont
 The edges container (for insertion of build edges)
NBTypeContmyTypeCont
 The types container (for retrieval of type defaults)
NBDistrictContmyDistrictCont
 The districts container (needed if an edge must be split)
NBTrafficLightLogicContmyTLLogicCont
 The traffic lights container to add built tls to (when invalidating tls because of splits)

Detailed Description

Importer for network edges stored in XML.

This SAX-handler parses edge information and stores it in the given container.

Todo:

revalidate node retrieval

One day, one should rethink the order of parsing. Now, the handler is able to load edges, using information from the types, first, and extending them by given information. In addition, if the read edge is already known, it's values are also used. Then, defining vehicles allowed per lane, and additional edge split definitions add some further complexity. This all works somehow for most of our use cases, but it's definitely not as consistent that everything what seems to be possible would also work appropriately.

Definition at line 71 of file NIXMLEdgesHandler.h.

Constructor & Destructor Documentation

NIXMLEdgesHandler::NIXMLEdgesHandler ( NBNodeCont nc,
NBEdgeCont ec,
NBTypeCont tc,
NBDistrictCont dc,
NBTrafficLightLogicCont tlc,
OptionsCont options 
)

Constructor.

Parameters
[in]ncThe nodes container (for retrieval of referenced nodes)
[in]ecThe edges container (for insertion of build edges)
[in]tcThe types container (for retrieval of type defaults)
[in]dcThe districts container (needed if an edge must be split)
[in]optionsThe options to use while building edges

Definition at line 70 of file NIXMLEdgesHandler.cpp.

NIXMLEdgesHandler::~NIXMLEdgesHandler ( )

Destructor.

Definition at line 89 of file NIXMLEdgesHandler.cpp.

NIXMLEdgesHandler::NIXMLEdgesHandler ( const NIXMLEdgesHandler s)
private

invalid copy constructor

Member Function Documentation

void NIXMLEdgesHandler::addEdge ( const SUMOSAXAttributes attrs)
private

Parses an edge and stores the values in "myCurrentEdge".

Parameters
[in]attrsThe attributes to get the edge's values from

Definition at line 115 of file NIXMLEdgesHandler.cpp.

References NBEdge::addSidewalk(), NBEdgeCont::erase(), SUMOSAXAttributes::get(), OptionsCont::getBool(), NBEdge::getEndOffset(), NBEdge::getGeometry(), NBEdge::getLaneSpreadFunction(), NBEdge::getLaneWidth(), NBEdge::getLoadedLength(), NBTypeCont::getNumLanes(), NBEdge::getNumLanes(), SUMOSAXAttributes::getOpt(), NBTypeCont::getPermissions(), NBEdge::getPermissions(), NBTypeCont::getPriority(), NBEdge::getPriority(), NBTypeCont::getSidewalkWidth(), NBTypeCont::getSpeed(), NBEdge::getSpeed(), NBEdge::getStreetName(), SUMOSAXAttributes::getStringSecure(), NBEdge::getTypeID(), NBTypeCont::getWidth(), SUMOSAXAttributes::hasAttribute(), NBEdge::hasDefaultGeometry(), NBEdge::hasLoadedLength(), OptionsCont::isDefault(), NBTypeCont::knows(), LANESPREAD_RIGHT, myCurrentEdge, myCurrentEndOffset, myCurrentID, myCurrentLaneNo, myCurrentPriority, myCurrentSpeed, myCurrentStreetName, myCurrentType, myCurrentWidth, myDistrictCont, myEdgeCont, myFromNode, myHaveReportedAboutOverwriting, myIsUpdate, myKeepEdgeShape, myLanesSpread, myLength, myOptions, myPermissions, myReinitKeepEdgeShape, myShape, mySplits, myToNode, myTypeCont, parseVehicleClasses(), NBEdge::reinit(), NBEdgeCont::retrieve(), OptionsCont::set(), NBEdge::setLoadedLength(), setNodes(), NBEdge::setPermissions(), SUMO_ATTR_ALLOW, SUMO_ATTR_DISALLOW, SUMO_ATTR_ENDOFFSET, SUMO_ATTR_ID, SUMO_ATTR_LENGTH, SUMO_ATTR_NAME, SUMO_ATTR_NUMLANES, SUMO_ATTR_PRIORITY, SUMO_ATTR_REMOVE, SUMO_ATTR_SPEED, SUMO_ATTR_TYPE, SUMO_ATTR_WIDTH, SUMOReal, tryGetLaneSpread(), tryGetShape(), NBEdge::UNSPECIFIED_LOADED_LENGTH, NBEdge::UNSPECIFIED_OFFSET, NBEdge::UNSPECIFIED_WIDTH, WRITE_ERROR, and WRITE_MESSAGE.

Referenced by myStartElement().

void NIXMLEdgesHandler::addSplit ( const SUMOSAXAttributes attrs)
private
std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
protectedinherited

Builds an error message.

The error message includes the file name and the line/column information as supported by the given SAXParseException

Parameters
[in]exceptionThe name of the currently processed file
Returns
A string describing the given exception

Definition at line 193 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName().

Referenced by GenericSAXHandler::error(), GenericSAXHandler::fatalError(), and GenericSAXHandler::warning().

void GenericSAXHandler::characters ( const XMLCh *const  chars,
const XERCES3_SIZE_t  length 
)
inherited

The inherited method called when characters occured.

The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon as the element ends.

Todo:

recheck/describe what happens with characters when a new element is opened

describe characters processing in the class' head

Definition at line 176 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), and GenericSAXHandler::myCharactersVector.

void NIXMLEdgesHandler::deleteEdge ( const SUMOSAXAttributes attrs)
private

parses delete tag and deletes the specified edge

Parameters
[in]attrsThe attributes to get the edge's id from

Definition at line 445 of file NIXMLEdgesHandler.cpp.

References NBEdgeCont::extract(), SUMOSAXAttributes::get(), myCurrentID, myDistrictCont, myEdgeCont, NBEdgeCont::retrieve(), SUMO_ATTR_ID, SUMO_TAG_DELETE, toString(), and WRITE_WARNING.

Referenced by myStartElement().

void GenericSAXHandler::endElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname 
)
inherited

The inherited method called when a tag is being closed.

This method calls the user-implemented methods myCharacters with the previously collected and converted characters.

Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 126 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), GenericSAXHandler::convertTag(), GenericSAXHandler::myCharacters(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myEndElement(), GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, and SUMO_TAG_NOTHING.

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
inherited

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters
[in]exceptionThe occured exception to process
Exceptions
ProcessErrorOn any call

Definition at line 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::myStartElement().

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
inherited

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Exceptions
ProcessErrorOn any call
Parameters
[in]exceptionThe occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtualinherited

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

Parameters
[in]elementThe opened element, given as a int
[in]charsThe complete embedded character string ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_ITSUMO::Handler.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void NIXMLEdgesHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

Called on the opening of a tag;.

Parameters
[in]elementID of the currently opened element
[in]attrsAttributes within the currently opened element
Exceptions
ProcessErrorIf something fails
See Also
GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 93 of file NIXMLEdgesHandler.cpp.

References addEdge(), addLane(), addSplit(), deleteEdge(), SUMO_TAG_DELETE, SUMO_TAG_EDGE, SUMO_TAG_LANE, and SUMO_TAG_SPLIT.

NIXMLEdgesHandler& NIXMLEdgesHandler::operator= ( const NIXMLEdgesHandler s)
private

invalid assignment operator

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited
void GenericSAXHandler::setFileName ( const std::string &  name)
inherited

Sets the current file name.

Parameters
[in]nameThe name of the currently processed file
Todo:
Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 80 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), PCNetProjectionLoader::load(), NIImporter_OpenStreetMap::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and XMLSubSys::runParser().

bool NIXMLEdgesHandler::setNodes ( const SUMOSAXAttributes attrs)
private

Sets from/to node information of the currently parsed edge.

If the nodes could be retrieved/built, they are set in myFromNode/myToNode, respectively, and true is returned. If not, false is returned.

Parameters
[in]attrsThe SAX-attributes to parse the nodes from
Returns
Whether valid nodes exist

Definition at line 369 of file NIXMLEdgesHandler.cpp.

References SUMOSAXAttributes::get(), NBEdge::getFromNode(), Named::getID(), NBEdge::getToNode(), SUMOSAXAttributes::hasAttribute(), myCurrentEdge, myCurrentID, myFromNode, myIsUpdate, myNodeCont, myShape, myToNode, NBNodeCont::retrieve(), SUMO_ATTR_FROM, SUMO_ATTR_TO, and WRITE_ERROR.

Referenced by addEdge().

void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const XERCES_CPP_NAMESPACE::Attributes &  attrs 
)
inherited

The inherited method called when a new tag opens.

The method parses the supplied XMLCh*-qname using the internal name/enum-map to obtain the enum representation of the attribute name.

Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the attributes.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 105 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), GenericSAXHandler::convertTag(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myPredefinedTags, GenericSAXHandler::myPredefinedTagsMML, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, and SUMO_TAG_INCLUDE.

LaneSpreadFunction NIXMLEdgesHandler::tryGetLaneSpread ( const SUMOSAXAttributes attrs)
private
PositionVector NIXMLEdgesHandler::tryGetShape ( const SUMOSAXAttributes attrs)
private

Tries to parse the shape definition.

Returns the edge's geometry (may be empty if no one was defined). Writes an error message if an error occured.

Parameters
[in]attrsThe attributes to read the shape from
Returns
The edge's shape

Definition at line 410 of file NIXMLEdgesHandler.cpp.

References SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::hasAttribute(), myCurrentID, myKeepEdgeShape, myReinitKeepEdgeShape, myShape, SUMO_ATTR_SHAPE, NBNetBuilder::transformCoordinates(), and WRITE_ERROR.

Referenced by addEdge().

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
inherited

Handler for XML-warnings.

The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.

Parameters
[in]exceptionThe occured exception to process

Definition at line 206 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

NBEdge* NIXMLEdgesHandler::myCurrentEdge
private

The currently processed edge.

Definition at line 220 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), addLane(), addSplit(), myEndElement(), and setNodes().

SUMOReal NIXMLEdgesHandler::myCurrentEndOffset
private

The current edge's offset till the destination node.

Definition at line 165 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

std::string NIXMLEdgesHandler::myCurrentID
private

The current edge's id.

Definition at line 150 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), addLane(), addSplit(), deleteEdge(), myEndElement(), setNodes(), tryGetLaneSpread(), and tryGetShape().

int NIXMLEdgesHandler::myCurrentLaneNo
private

The current edge's number of lanes.

Definition at line 159 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

int NIXMLEdgesHandler::myCurrentPriority
private

The current edge's priority.

Definition at line 156 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

SUMOReal NIXMLEdgesHandler::myCurrentSpeed
private

The current edge's maximum speed.

Definition at line 153 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

std::string NIXMLEdgesHandler::myCurrentStreetName
private

The current edge's street name.

Definition at line 168 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

std::string NIXMLEdgesHandler::myCurrentType
private

The current edge's type.

Definition at line 171 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

SUMOReal NIXMLEdgesHandler::myCurrentWidth
private

The current edge's lane width.

Definition at line 162 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

NBDistrictCont& NIXMLEdgesHandler::myDistrictCont
private

The districts container (needed if an edge must be split)

Definition at line 211 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), deleteEdge(), and myEndElement().

NBEdgeCont& NIXMLEdgesHandler::myEdgeCont
private

The edges container (for insertion of build edges)

Definition at line 205 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), deleteEdge(), and myEndElement().

NBNode* NIXMLEdgesHandler::myFromNode
private

The nodes the edge starts and ends at.

Definition at line 174 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), and setNodes().

bool NIXMLEdgesHandler::myHaveReportedAboutOverwriting
private

Information whether at least one edge's attributes were overwritten.

Definition at line 277 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

bool NIXMLEdgesHandler::myHaveWarnedAboutDeprecatedLaneId
private

Definition at line 279 of file NIXMLEdgesHandler.h.

Referenced by addLane().

bool NIXMLEdgesHandler::myIsUpdate
private

Whether this edge definition is an update of a previously inserted edge.

Definition at line 195 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), myEndElement(), and setNodes().

const bool NIXMLEdgesHandler::myKeepEdgeShape
private

Whether the edge shape shall be kept generally.

Definition at line 282 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), and tryGetShape().

LaneSpreadFunction NIXMLEdgesHandler::myLanesSpread
private

Information about how to spread the lanes.

Definition at line 183 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), and tryGetLaneSpread().

SUMOReal NIXMLEdgesHandler::myLength
private

The current edge's length.

Definition at line 177 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

NBNodeCont& NIXMLEdgesHandler::myNodeCont
private

The nodes container (for retrieval of referenced nodes)

Definition at line 202 of file NIXMLEdgesHandler.h.

Referenced by myEndElement(), and setNodes().

OptionsCont& NIXMLEdgesHandler::myOptions
private

A reference to the program's options.

Definition at line 143 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

SVCPermissions NIXMLEdgesHandler::myPermissions
private

Information about lane permissions.

Definition at line 186 of file NIXMLEdgesHandler.h.

Referenced by addEdge().

bool NIXMLEdgesHandler::myReinitKeepEdgeShape
private

Whether the edge shape shall be kept at reinitilization.

Definition at line 189 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), and tryGetShape().

PositionVector NIXMLEdgesHandler::myShape
private

The shape of the edge.

Definition at line 180 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), setNodes(), and tryGetShape().

std::vector<Split> NIXMLEdgesHandler::mySplits
private

The list of this edge's splits.

Definition at line 237 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), addSplit(), and myEndElement().

NBTrafficLightLogicCont& NIXMLEdgesHandler::myTLLogicCont
private

The traffic lights container to add built tls to (when invalidating tls because of splits)

Definition at line 215 of file NIXMLEdgesHandler.h.

Referenced by myEndElement().

NBNode * NIXMLEdgesHandler::myToNode
private

Definition at line 174 of file NIXMLEdgesHandler.h.

Referenced by addEdge(), and setNodes().

NBTypeCont& NIXMLEdgesHandler::myTypeCont
private

The types container (for retrieval of type defaults)

Definition at line 208 of file NIXMLEdgesHandler.h.

Referenced by addEdge().


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