Eclipse SUMO - Simulation of Urban MObility
NIXMLPTHandler Class Reference

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

#include <NIXMLPTHandler.h>

Inheritance diagram for NIXMLPTHandler:
Collaboration diagram for NIXMLPTHandler:

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...
 
 NIXMLPTHandler (NBEdgeCont &ec, NBPTStopCont &sc, NBPTLineCont &lc)
 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...
 
 ~NIXMLPTHandler ()
 Destructor. More...
 

inherited from GenericSAXHandler

NBEdgeContmyEdgeCont
 The edges container (for retrieving referenced stop edge) More...
 
NBPTStopContmyStopCont
 The stop container (for loading of stops) More...
 
NBPTLineContmyLineCont
 The line container (for loading of lines) More...
 
NBPTStopmyCurrentStop
 The currently processed stop. More...
 
NBPTLinemyCurrentLine
 The currently processed line. More...
 
double myCurrentCompletion
 the completion level of the current line More...
 
std::vector< Parameterised * > myLastParameterised
 element to receive parameters More...
 
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
void myEndElement (int element)
 Called when a closing tag occurs. More...
 
PositionVector tryGetShape (const SUMOSAXAttributes &attrs)
 Tries to parse the shape definition. More...
 
LaneSpreadFunction tryGetLaneSpread (const SUMOSAXAttributes &attrs)
 Tries to parse the spread type. More...
 
bool setNodes (const SUMOSAXAttributes &attrs)
 Sets from/to node information of the currently parsed edge. More...
 
void addPTStop (const SUMOSAXAttributes &attrs)
 Parses an public transport stop. More...
 
void addPTLineStop (const SUMOSAXAttributes &attrs)
 Parses an public transport stop reference within a line element. More...
 
void addAccess (const SUMOSAXAttributes &attrs)
 Parses an stop access definition. More...
 
void addPTLine (const SUMOSAXAttributes &attrs)
 Parses a public transport line. More...
 
 NIXMLPTHandler (const NIXMLPTHandler &s)
 invalid copy constructor More...
 
NIXMLPTHandleroperator= (const NIXMLPTHandler &s)
 invalid 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...
 
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 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 62 of file NIXMLPTHandler.h.

Member Typedef Documentation

◆ AttrMap

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

Definition at line 286 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 300 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ NIXMLPTHandler() [1/2]

NIXMLPTHandler::NIXMLPTHandler ( NBEdgeCont ec,
NBPTStopCont sc,
NBPTLineCont lc 
)

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 51 of file NIXMLPTHandler.cpp.

◆ ~NIXMLPTHandler()

NIXMLPTHandler::~NIXMLPTHandler ( )

Destructor.

Definition at line 60 of file NIXMLPTHandler.cpp.

◆ NIXMLPTHandler() [2/2]

NIXMLPTHandler::NIXMLPTHandler ( const NIXMLPTHandler s)
private

invalid copy constructor

Member Function Documentation

◆ addAccess()

void NIXMLPTHandler::addAccess ( const SUMOSAXAttributes attrs)
private

Parses an stop access definition.

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

Definition at line 143 of file NIXMLPTHandler.cpp.

References NBPTStop::addAccess(), SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), myCurrentStop, SUMO_ATTR_LANE, SUMO_ATTR_LENGTH, and SUMO_ATTR_POSITION.

Referenced by myStartElement().

◆ addPTLine()

void NIXMLPTHandler::addPTLine ( const SUMOSAXAttributes attrs)
private

Parses a public transport line.

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

XXX parse route child

Definition at line 156 of file NIXMLPTHandler.cpp.

References SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getStringSecure(), NBPTLineCont::insert(), myCurrentCompletion, myCurrentLine, myLineCont, SUMO_ATTR_ID, SUMO_ATTR_LINE, SUMO_ATTR_PERIOD, SUMO_ATTR_TYPE, and StringUtils::toDouble().

Referenced by myStartElement().

◆ addPTLineStop()

void NIXMLPTHandler::addPTLineStop ( const SUMOSAXAttributes attrs)
private

Parses an public transport stop reference within a line element.

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

Definition at line 179 of file NIXMLPTHandler.cpp.

References NBPTLine::addPTStop(), NBPTStopCont::get(), SUMOSAXAttributes::get(), NBPTLine::getLineID(), myCurrentLine, myStopCont, SUMO_ATTR_ID, toString(), and WRITE_ERROR.

Referenced by myStartElement().

◆ addPTStop()

◆ 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 187 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 170 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 81 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 177 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 121 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 206 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 212 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 222 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

void NIXMLPTHandler::myEndElement ( int  element)
protectedvirtual

Called when a closing tag occurs.

Parameters
[in]elementID of the currently opened element
Exceptions
ProcessErrorIf something fails
See also
GenericSAXHandler::myEndElement

Reimplemented from GenericSAXHandler.

Definition at line 96 of file NIXMLPTHandler.cpp.

References NBPTLine::getStops(), myCurrentCompletion, myCurrentLine, myCurrentStop, NBPTLine::setMyNumOfStops(), SUMO_TAG_BUS_STOP, SUMO_TAG_PT_LINE, and SUMO_TAG_TRAIN_STOP.

◆ myStartElement()

void NIXMLPTHandler::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 64 of file NIXMLPTHandler.cpp.

References addAccess(), addPTLine(), addPTLineStop(), addPTStop(), SUMOSAXAttributes::get(), SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), myCurrentLine, myLastParameterised, SUMO_ATTR_KEY, SUMO_ATTR_VALUE, SUMO_TAG_ACCESS, SUMO_TAG_BUS_STOP, SUMO_TAG_PARAM, SUMO_TAG_PT_LINE, and SUMO_TAG_TRAIN_STOP.

◆ operator=()

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

invalid assignment operator

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

References GenericSAXHandler::myFileName.

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

◆ setNodes()

bool NIXMLPTHandler::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

◆ 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 94 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().

◆ tryGetLaneSpread()

LaneSpreadFunction NIXMLPTHandler::tryGetLaneSpread ( const SUMOSAXAttributes attrs)
private

Tries to parse the spread type.

◆ tryGetShape()

PositionVector NIXMLPTHandler::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 occurred.

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

◆ 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 200 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 307 of file GenericSAXHandler.h.

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

◆ myCurrentCompletion

double NIXMLPTHandler::myCurrentCompletion
private

the completion level of the current line

Definition at line 146 of file NIXMLPTHandler.h.

Referenced by addPTLine(), and myEndElement().

◆ myCurrentLine

NBPTLine* NIXMLPTHandler::myCurrentLine
private

The currently processed line.

Definition at line 143 of file NIXMLPTHandler.h.

Referenced by addPTLine(), addPTLineStop(), myEndElement(), and myStartElement().

◆ myCurrentStop

NBPTStop* NIXMLPTHandler::myCurrentStop
private

The currently processed stop.

Definition at line 140 of file NIXMLPTHandler.h.

Referenced by addAccess(), addPTStop(), and myEndElement().

◆ myEdgeCont

NBEdgeCont& NIXMLPTHandler::myEdgeCont
private

The edges container (for retrieving referenced stop edge)

Definition at line 131 of file NIXMLPTHandler.h.

Referenced by addPTStop().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 319 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 316 of file GenericSAXHandler.h.

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

◆ myLastParameterised

std::vector<Parameterised*> NIXMLPTHandler::myLastParameterised
private

element to receive parameters

Definition at line 149 of file NIXMLPTHandler.h.

Referenced by myStartElement().

◆ myLineCont

NBPTLineCont& NIXMLPTHandler::myLineCont
private

The line container (for loading of lines)

Definition at line 137 of file NIXMLPTHandler.h.

Referenced by addPTLine().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 310 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 313 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 292 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 322 of file GenericSAXHandler.h.

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

◆ myStopCont

NBPTStopCont& NIXMLPTHandler::myStopCont
private

The stop container (for loading of stops)

Definition at line 134 of file NIXMLPTHandler.h.

Referenced by addPTLineStop(), and addPTStop().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

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