Eclipse SUMO - Simulation of Urban MObility
NIXMLConnectionsHandler Class Reference

Importer for edge connections stored in XML. More...

#include <NIXMLConnectionsHandler.h>

Inheritance diagram for NIXMLConnectionsHandler:
Collaboration diagram for NIXMLConnectionsHandler:

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occurred. More...
 
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed. More...
 
const std::string & getFileName () const
 returns the current file name More...
 
 NIXMLConnectionsHandler (NBEdgeCont &ec, NBNodeCont &nc, NBTrafficLightLogicCont &tlc)
 Constructor. More...
 
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed. More...
 
void setFileName (const std::string &name)
 Sets the current file name. More...
 
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. More...
 
 ~NIXMLConnectionsHandler ()
 Destructor. More...
 

inherited from GenericSAXHandler

NBEdgeContmyEdgeCont
 The edge container to fill. More...
 
NBNodeContmyNodeCont
 The edge container to fill. More...
 
NBTrafficLightLogicContmyTLLogicCont
 The traffic lights container to add built tls to (when invalidating tls)
More...
 
bool myHaveWarnedAboutDeprecatedLanes
 Information whether we have a deprecated attribute. More...
 
MsgHandler *const myErrorMsgHandler
 the handler for loading errors More...
 
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
NBConnection parseConnection (const std::string &defRole, const std::string &def)
 Returns the connection described by def. More...
 
void parseLaneBound (const SUMOSAXAttributes &attrs, NBEdge *from, NBEdge *to)
 Parses a connection when it describes a lane-2-lane relationship. More...
 
bool parseLaneInfo (const SUMOSAXAttributes &attributes, NBEdge *fromEdge, NBEdge *toEdge, int *fromLane, int *toLane)
 Parses information about lane-2-lane connection when it describes a lane-2-lane relationship. More...
 
bool parseDeprecatedLaneDefinition (const SUMOSAXAttributes &attributes, NBEdge *fromEdge, NBEdge *toEdge, int *fromLane, int *toLane)
 Parses information about lane-2-lane connection in deprecated format. More...
 
bool parseLaneDefinition (const SUMOSAXAttributes &attributes, int *fromLane, int *toLane)
 Parses information about lane-2-lane connection. More...
 
void addCrossing (const SUMOSAXAttributes &attrs)
 Parses a crossing and updates the referenced node. More...
 
void addWalkingArea (const SUMOSAXAttributes &attrs)
 Parses a walkingArea and updates the referenced node. More...
 
 NIXMLConnectionsHandler (const NIXMLConnectionsHandler &s)
 invalidated copy constructor More...
 
NIXMLConnectionsHandleroperator= (const NIXMLConnectionsHandler &s)
 invalidated assignment operator More...
 

SAX ErrorHandler callbacks

void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings. More...
 
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes. More...
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes. More...
 
void setSchemaSeen (const bool schemaSeen=true)
 
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode More...
 
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation. More...
 

attributes parsing

AttrMap myPredefinedTags
 
std::map< int, std::string > myPredefinedTagsMML
 the map from ids to their string representation More...
 
typedef std::map< int, XMLCh * > AttrMap
 

elements parsing

TagMap myTagMap
 
std::vector< std::string > myCharactersVector
 A list of character strings obtained so far to build the complete characters string at the end. More...
 
GenericSAXHandlermyParentHandler
 The handler to give control back to. More...
 
int myParentIndicator
 The tag indicating that control should be given back. More...
 
std::string myFileName
 The name of the currently parsed file. More...
 
std::string myExpectedRoot
 The root element to expect, empty string disables the check. More...
 
bool mySchemaSeen
 whether the reader has already seen a schema More...
 
typedef std::map< std::string, int > TagMap
 

Detailed Description

Importer for edge connections stored in XML.

This importer parses connections, and prohibitions, and is able to reset connections between edges.

Definition at line 51 of file NIXMLConnectionsHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::map<int, XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 285 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
privateinherited

Definition at line 299 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ NIXMLConnectionsHandler() [1/2]

NIXMLConnectionsHandler::NIXMLConnectionsHandler ( NBEdgeCont ec,
NBNodeCont nc,
NBTrafficLightLogicCont tlc 
)

Constructor.

Parameters
[in]ecThe edge container which includes the edges to change connections of

Definition at line 52 of file NIXMLConnectionsHandler.cpp.

◆ ~NIXMLConnectionsHandler()

NIXMLConnectionsHandler::~NIXMLConnectionsHandler ( )

Destructor.

Definition at line 62 of file NIXMLConnectionsHandler.cpp.

◆ NIXMLConnectionsHandler() [2/2]

NIXMLConnectionsHandler::NIXMLConnectionsHandler ( const NIXMLConnectionsHandler s)
private

invalidated copy constructor

Member Function Documentation

◆ addCrossing()

◆ addWalkingArea()

void NIXMLConnectionsHandler::addWalkingArea ( const SUMOSAXAttributes attrs)
private

◆ buildErrorMessage()

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 186 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName(), and transcode().

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

◆ characters()

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

The inherited method called when characters occurred.

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 169 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string &  name) const
privateinherited

converts from c++-string into unicode

Todo:
recheck encoding
Parameters
[in]nameThe string to convert
Returns
The string converted into a XMLCh-string

Definition at line 80 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::GenericSAXHandler().

◆ convertTag()

int GenericSAXHandler::convertTag ( const std::string &  tag) const
privateinherited

Converts a tag from its string into its numerical representation.

Returns the enum-representation stored for the given tag. If the tag is not known, SUMO_TAG_NOTHING is returned.

Parameters
[in]tagThe string to convert
Returns
The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 176 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

◆ endElement()

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 120 of file GenericSAXHandler.cpp.

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

◆ error()

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 occurred exception to process
Exceptions
ProcessErrorOn any call

Definition at line 205 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::myStartElement().

◆ fatalError()

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 occurred exception to process

Definition at line 211 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

◆ myCharacters()

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 @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 221 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

◆ myStartElement()

◆ operator=()

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

invalidated assignment operator

◆ parseConnection()

NBConnection NIXMLConnectionsHandler::parseConnection ( const std::string &  defRole,
const std::string &  def 
)
private

Returns the connection described by def.

def should have the following format <FROM_EDGE_ID>[_<FROM_LANE_NO>]-><TO_EDGE_ID>[_<TO_LANE_NO>].

Parameters
[in]defRole"prohibitor" or "prohibited" - used for error reporting
[in]defThe definition of the connection
Returns
The parsed connection

Definition at line 163 of file NIXMLConnectionsHandler.cpp.

References MsgHandler::inform(), NBConnection::InvalidConnection, myEdgeCont, myErrorMsgHandler, and NBEdgeCont::retrieve().

Referenced by myStartElement().

◆ parseDeprecatedLaneDefinition()

bool NIXMLConnectionsHandler::parseDeprecatedLaneDefinition ( const SUMOSAXAttributes attributes,
NBEdge fromEdge,
NBEdge toEdge,
int *  fromLane,
int *  toLane 
)
inlineprivate

Parses information about lane-2-lane connection in deprecated format.

Parameters
[in]attrsThe attributes to get further information about the connection from
[in]fromEdgeThe edge at which the connection starts (the on incoming into a node)
[in]toEdgeThe edge at which the connection ends (the on outgoing from a node)
[out]fromLaneThe lane at which connection starts
[out]toLaneThe lane at which connection ends

Definition at line 285 of file NIXMLConnectionsHandler.cpp.

References SUMOSAXAttributes::get(), NBEdge::getID(), MsgHandler::inform(), myErrorMsgHandler, myHaveWarnedAboutDeprecatedLanes, SUMO_ATTR_FROM_LANE, SUMO_ATTR_LANE, SUMO_ATTR_TO_LANE, StringUtils::toIntSecure(), toString(), and WRITE_WARNING.

Referenced by parseLaneInfo().

◆ parseLaneBound()

void NIXMLConnectionsHandler::parseLaneBound ( const SUMOSAXAttributes attrs,
NBEdge from,
NBEdge to 
)
private

Parses a connection when it describes a lane-2-lane relationship.

Parameters
[in]attrsThe attributes to get further information about the connection from
[in]fromThe edge at which the connection starts (the on incoming into a node)
[in]toThe edge at which the connection ends (the on outgoing from a node)

Definition at line 198 of file NIXMLConnectionsHandler.cpp.

References NBEdge::addLane2LaneConnection(), NBEdgeCont::addPostProcessConnection(), NBEdge::Connection::contPos, NBEdge::Connection::customShape, OptionsCont::getBool(), NBEdge::getConnectionsFromLane(), NBEdge::getID(), NBEdge::getLaneID(), SUMOSAXAttributes::getOpt(), OptionsCont::getOptions(), NBEdge::getStep(), NBEdge::getToNode(), NBNode::getType(), SUMOSAXAttributes::hasAttribute(), NBEdge::hasConnectionTo(), MsgHandler::inform(), MsgHandler::informf(), NBNode::invalidateTLS(), NBEdge::Connection::keepClear, NBEdge::L2L_USER, NBEdge::LANES2LANES_USER, NBEdge::Connection::mayDefinitelyPass, myEdgeCont, myErrorMsgHandler, myTLLogicCont, NODETYPE_ZIPPER, parseLaneInfo(), parseVehicleClasses(), NBEdge::removeFromConnections(), NBEdge::Connection::speed, SUMO_ATTR_ALLOW, SUMO_ATTR_CONTPOS, SUMO_ATTR_DISALLOW, SUMO_ATTR_FROM_LANE, SUMO_ATTR_KEEP_CLEAR, SUMO_ATTR_PASS, SUMO_ATTR_SHAPE, SUMO_ATTR_SPEED, SUMO_ATTR_TO_LANE, SUMO_ATTR_UNCONTROLLED, SUMO_ATTR_VISIBILITY_DISTANCE, SVC_UNSPECIFIED, toString(), NBNetBuilder::transformCoordinates(), NBEdge::Connection::uncontrolled, NBEdge::Connection::visibility, WRITE_ERROR, and WRITE_WARNINGF.

Referenced by myStartElement().

◆ parseLaneDefinition()

bool NIXMLConnectionsHandler::parseLaneDefinition ( const SUMOSAXAttributes attributes,
int *  fromLane,
int *  toLane 
)
inlineprivate

Parses information about lane-2-lane connection.

Parameters
[in]attrsThe attributes to get further information about the connection from
[out]fromLaneThe lane at which connection starts
[out]toLaneThe lane at which connection ends

Definition at line 312 of file NIXMLConnectionsHandler.cpp.

References SUMOSAXAttributes::get(), SUMO_ATTR_FROM_LANE, and SUMO_ATTR_TO_LANE.

Referenced by parseLaneInfo().

◆ parseLaneInfo()

bool NIXMLConnectionsHandler::parseLaneInfo ( const SUMOSAXAttributes attributes,
NBEdge fromEdge,
NBEdge toEdge,
int *  fromLane,
int *  toLane 
)
private

Parses information about lane-2-lane connection when it describes a lane-2-lane relationship.

Parameters
[in]attrsThe attributes to get further information about the connection from
[in]fromEdgeThe edge at which the connection starts (the on incoming into a node)
[in]toEdgeThe edge at which the connection ends (the on outgoing from a node)
[out]fromLaneThe lane at which connection starts
[out]toLaneThe lane at which connection ends

Definition at line 274 of file NIXMLConnectionsHandler.cpp.

References SUMOSAXAttributes::hasAttribute(), parseDeprecatedLaneDefinition(), parseLaneDefinition(), and SUMO_ATTR_LANE.

Referenced by myStartElement(), and parseLaneBound().

◆ registerParent()

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited

◆ setFileName()

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 68 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

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

◆ setSchemaSeen()

void GenericSAXHandler::setSchemaSeen ( const bool  schemaSeen = true)
inlineprotectedinherited

◆ startElement()

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 93 of file GenericSAXHandler.cpp.

References GenericSAXHandler::convertTag(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myExpectedRoot, GenericSAXHandler::myPredefinedTags, GenericSAXHandler::myPredefinedTagsMML, GenericSAXHandler::mySchemaSeen, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, and StringUtils::transcode().

◆ warning()

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 occurred exception to process

Definition at line 199 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myCharactersVector

std::vector<std::string> GenericSAXHandler::myCharactersVector
privateinherited

A list of character strings obtained so far to build the complete characters string at the end.

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::characters(), GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

◆ myEdgeCont

NBEdgeCont& NIXMLConnectionsHandler::myEdgeCont
private

The edge container to fill.

Definition at line 140 of file NIXMLConnectionsHandler.h.

Referenced by addCrossing(), addWalkingArea(), myStartElement(), parseConnection(), and parseLaneBound().

◆ myErrorMsgHandler

MsgHandler* const NIXMLConnectionsHandler::myErrorMsgHandler
private

the handler for loading errors

Definition at line 153 of file NIXMLConnectionsHandler.h.

Referenced by myStartElement(), parseConnection(), parseDeprecatedLaneDefinition(), and parseLaneBound().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

The root element to expect, empty string disables the check.

Definition at line 318 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 315 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::getFileName(), and GenericSAXHandler::setFileName().

◆ myHaveWarnedAboutDeprecatedLanes

bool NIXMLConnectionsHandler::myHaveWarnedAboutDeprecatedLanes
private

Information whether we have a deprecated attribute.

Definition at line 150 of file NIXMLConnectionsHandler.h.

Referenced by parseDeprecatedLaneDefinition().

◆ myNodeCont

NBNodeCont& NIXMLConnectionsHandler::myNodeCont
private

The edge container to fill.

Definition at line 143 of file NIXMLConnectionsHandler.h.

Referenced by addCrossing().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
privateinherited

The tag indicating that control should be given back.

Definition at line 312 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

◆ myPredefinedTagsMML

std::map<int, std::string> GenericSAXHandler::myPredefinedTagsMML
privateinherited

the map from ids to their string representation

Definition at line 291 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::GenericSAXHandler(), SUMOSAXReader::parseNext(), and GenericSAXHandler::startElement().

◆ mySchemaSeen

bool GenericSAXHandler::mySchemaSeen
privateinherited

whether the reader has already seen a schema

Definition at line 321 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::setSchemaSeen(), and GenericSAXHandler::startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

◆ myTLLogicCont

NBTrafficLightLogicCont& NIXMLConnectionsHandler::myTLLogicCont
private

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

Definition at line 147 of file NIXMLConnectionsHandler.h.

Referenced by myStartElement(), and parseLaneBound().


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