Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
PCLoaderOSM::EdgesHandler Class Reference

A class which extracts OSM-edges from a parsed OSM-file. More...

#include <PCLoaderOSM.h>

Inheritance diagram for PCLoaderOSM::EdgesHandler:
[legend]
Collaboration diagram for PCLoaderOSM::EdgesHandler:
[legend]

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occurred.
 EdgesHandler (const std::map< long long int, PCOSMNode * > &osmNodes, EdgeMap &toFill, const RelationsMap &additionalWays, bool withAttributes, MsgHandler &errorHandler)
 Constructor.
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
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.
 ~EdgesHandler ()
 Destructor.

inherited from GenericSAXHandler

bool myWithAttributes
 Whether all attributes shall be stored.
MsgHandlermyErrorHandler
 The handler to report errors to (will be the WarningsHandler if –ignore-errors was set).
const std::map< long long int, PCOSMNode * > & myOSMNodes
 The previously parsed nodes.
EdgeMapmyEdgeMap
 A map of built edges.
const RelationsMapmyAdditionalWays
 additional ways which are reference by relations
PCOSMEdgemyCurrentEdge
 The currently built edge.
std::vector< int > myParentElements
 Current path in order to know to what occuring values belong.
bool myKeep
 whether the last edge (way) should be kept because it had a key from the inclusion list
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.
void myEndElement (int element)
 Called when a closing tag occurs.
 EdgesHandler (const EdgesHandler &s)
 Invalidated copy constructor.
EdgesHandleroperator= (const EdgesHandler &s)
 Invalidated assignment operator.

attributes parsing

AttrMap myPredefinedTags
std::vector< std::string > myPredefinedTagsMML
 the map from ids to their string representation
typedef std::vector< 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.
GenericSAXHandlermyParentHandler
 The handler to give control back to.
int myParentIndicator
 The tag indicating that control should be given back.
std::string myFileName
 The name of the currently parsed file.
std::string myExpectedRoot
 The root element to expect, empty string disables the check.
bool myCollectCharacterData = false
 whether the reader should collect character data
bool myRootSeen = false
 whether the reader has already seen the root element
int mySection = -1
 The tag indicating the current section to parse.
bool mySectionSeen = false
 whether the reader has already seen the begin of the section
bool mySectionEnded = false
 whether the reader has already seen the end of the section
bool mySectionOpen = false
 whether an element of the current section is open
std::pair< int, SUMOSAXAttributes * > myNextSectionStart
typedef std::map< std::string, int > TagMap

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.
void setSection (const int element, const bool seen)
bool sectionFinished () const
std::pair< int, SUMOSAXAttributes * > retrieveNextSectionStart ()
void needsCharacterData (const bool value=true)
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.
void callParentEnd (int element)
 signal endElement to the parent handler (special case for MSCalibrator)
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation.

Detailed Description

A class which extracts OSM-edges from a parsed OSM-file.

Definition at line 299 of file PCLoaderOSM.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 303 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 317 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ EdgesHandler() [1/2]

PCLoaderOSM::EdgesHandler::EdgesHandler ( const std::map< long long int, PCOSMNode * > & osmNodes,
EdgeMap & toFill,
const RelationsMap & additionalWays,
bool withAttributes,
MsgHandler & errorHandler )

Constructor.

Parameters
[in]osmNodesThe previously parsed (osm-)nodes
[in]toFillThe edges container to fill with read edges
[in]withAttributesWhether all attributes shall be stored
[in]additionalWaysAdditional ways which were identified as polygons to import
[in]errorHandlerThe handler to report errors to (WarningHandler for ignoring errors)

Definition at line 537 of file PCLoaderOSM.cpp.

References myAdditionalWays, myEdgeMap, myErrorHandler, myOSMNodes, myWithAttributes, and SUMOSAXHandler::SUMOSAXHandler().

Referenced by EdgesHandler(), and operator=().

Here is the caller graph for this function:

◆ ~EdgesHandler()

PCLoaderOSM::EdgesHandler::~EdgesHandler ( )

Destructor.

Definition at line 550 of file PCLoaderOSM.cpp.

◆ EdgesHandler() [2/2]

PCLoaderOSM::EdgesHandler::EdgesHandler ( const EdgesHandler & s)
private

Invalidated copy constructor.

References EdgesHandler().

Member Function Documentation

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

References getFileName(), and TL.

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

Here is the caller graph for this function:

◆ callParentEnd()

void GenericSAXHandler::callParentEnd ( int element)
protectedinherited

signal endElement to the parent handler (special case for MSCalibrator)

Definition at line 247 of file GenericSAXHandler.cpp.

References myParentHandler.

Referenced by MSCalibrator::myEndElement().

Here is the caller graph for this function:

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

References myCharactersVector, myCollectCharacterData, 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 86 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler().

Here is the caller graph for this function:

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

References myTagMap, and SUMO_TAG_NOTHING.

Referenced by endElement(), and startElement().

Here is the caller graph for this function:

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

References convertTag(), myCharacters(), myCharactersVector, myEndElement(), myParentHandler, myParentIndicator, mySection, mySectionOpen, 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 224 of file GenericSAXHandler.cpp.

References buildErrorMessage().

Referenced by MSRouteHandler::addFlowTransportable(), MSRouteHandler::addTransportable(), MSRouteHandler::closeTransportable(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::interpretDepartPosLat().

Here is the caller graph for this function:

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

References 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_ITSUMO::Handler, and NIImporter_OpenDrive.

Definition at line 240 of file GenericSAXHandler.cpp.

Referenced by endElement().

Here is the caller graph for this function:

◆ myEndElement()

void PCLoaderOSM::EdgesHandler::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 609 of file PCLoaderOSM.cpp.

References myAdditionalWays, myCurrentEdge, myEdgeMap, myKeep, myParentElements, and SUMO_TAG_WAY.

◆ myStartElement()

void PCLoaderOSM::EdgesHandler::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 555 of file PCLoaderOSM.cpp.

References SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), invalid_return< std::string >::value, myAdditionalWays, myCurrentEdge, myErrorHandler, myKeep, PCLoaderOSM::MyKeysToInclude, myOSMNodes, myParentElements, SUMO_ATTR_ACTION, SUMO_ATTR_ID, SUMO_ATTR_K, SUMO_ATTR_REF, SUMO_ATTR_V, SUMO_TAG_ND, SUMO_TAG_TAG, SUMO_TAG_WAY, TL, toString(), and WRITE_WARNINGF.

◆ needsCharacterData()

void GenericSAXHandler::needsCharacterData ( const bool value = true)
inlineinherited

Definition at line 220 of file GenericSAXHandler.h.

References invalid_return< std::string >::value, and myCollectCharacterData.

Referenced by NIImporter_ITSUMO::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and NIImporter_OpenDrive::myCharacters().

Here is the caller graph for this function:

◆ operator=()

EdgesHandler & PCLoaderOSM::EdgesHandler::operator= ( const EdgesHandler & s)
private

Invalidated assignment operator.

References EdgesHandler().

◆ registerParent()

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

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 178 of file GenericSAXHandler.cpp.

References GenericSAXHandler(), myParentHandler, myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

Here is the caller graph for this function:

◆ retrieveNextSectionStart()

std::pair< int, SUMOSAXAttributes * > GenericSAXHandler::retrieveNextSectionStart ( )
inlineinherited

Definition at line 213 of file GenericSAXHandler.h.

References myNextSectionStart.

◆ sectionFinished()

bool GenericSAXHandler::sectionFinished ( ) const
inlineinherited

Definition at line 209 of file GenericSAXHandler.h.

References mySectionEnded.

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

References myFileName.

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

Here is the caller graph for this function:

◆ setSection()

void GenericSAXHandler::setSection ( const int element,
const bool seen )
inlineinherited

Definition at line 202 of file GenericSAXHandler.h.

References mySection, mySectionEnded, mySectionOpen, and mySectionSeen.

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

References convertTag(), FileHelpers::getConfigurationRelative(), getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), myCharactersVector, myExpectedRoot, myNextSectionStart, myPredefinedTags, myPredefinedTagsMML, myRootSeen, mySection, mySectionEnded, mySectionOpen, mySectionSeen, myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, TL, StringUtils::transcode(), and WRITE_WARNINGF.

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

References buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myAdditionalWays

const RelationsMap& PCLoaderOSM::EdgesHandler::myAdditionalWays
private

additional ways which are reference by relations

Definition at line 358 of file PCLoaderOSM.h.

Referenced by EdgesHandler(), myEndElement(), and myStartElement().

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

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

◆ myCollectCharacterData

bool GenericSAXHandler::myCollectCharacterData = false
privateinherited

whether the reader should collect character data

Definition at line 339 of file GenericSAXHandler.h.

Referenced by characters(), and needsCharacterData().

◆ myCurrentEdge

PCOSMEdge* PCLoaderOSM::EdgesHandler::myCurrentEdge
private

The currently built edge.

Definition at line 361 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myEdgeMap

EdgeMap& PCLoaderOSM::EdgesHandler::myEdgeMap
private

A map of built edges.

Definition at line 355 of file PCLoaderOSM.h.

Referenced by EdgesHandler(), and myEndElement().

◆ myErrorHandler

MsgHandler& PCLoaderOSM::EdgesHandler::myErrorHandler
private

The handler to report errors to (will be the WarningsHandler if –ignore-errors was set).

Definition at line 349 of file PCLoaderOSM.h.

Referenced by EdgesHandler(), and myStartElement().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 336 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), and startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 333 of file GenericSAXHandler.h.

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

◆ myKeep

bool PCLoaderOSM::EdgesHandler::myKeep
private

whether the last edge (way) should be kept because it had a key from the inclusion list

Definition at line 367 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myNextSectionStart

std::pair<int, SUMOSAXAttributes*> GenericSAXHandler::myNextSectionStart
privateinherited

◆ myOSMNodes

const std::map<long long int, PCOSMNode*>& PCLoaderOSM::EdgesHandler::myOSMNodes
private

The previously parsed nodes.

Definition at line 352 of file PCLoaderOSM.h.

Referenced by EdgesHandler(), and myStartElement().

◆ myParentElements

std::vector<int> PCLoaderOSM::EdgesHandler::myParentElements
private

Current path in order to know to what occuring values belong.

Definition at line 364 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 327 of file GenericSAXHandler.h.

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

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
privateinherited

The tag indicating that control should be given back.

Definition at line 330 of file GenericSAXHandler.h.

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

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), startElement(), and ~GenericSAXHandler().

◆ myPredefinedTagsMML

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

the map from ids to their string representation

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), and startElement().

◆ myRootSeen

bool GenericSAXHandler::myRootSeen = false
privateinherited

whether the reader has already seen the root element

Definition at line 342 of file GenericSAXHandler.h.

Referenced by startElement().

◆ mySection

int GenericSAXHandler::mySection = -1
privateinherited

The tag indicating the current section to parse.

Definition at line 345 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionEnded

bool GenericSAXHandler::mySectionEnded = false
privateinherited

whether the reader has already seen the end of the section

Definition at line 351 of file GenericSAXHandler.h.

Referenced by sectionFinished(), setSection(), and startElement().

◆ mySectionOpen

bool GenericSAXHandler::mySectionOpen = false
privateinherited

whether an element of the current section is open

Definition at line 354 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionSeen

bool GenericSAXHandler::mySectionSeen = false
privateinherited

whether the reader has already seen the begin of the section

Definition at line 348 of file GenericSAXHandler.h.

Referenced by setSection(), and startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

Definition at line 320 of file GenericSAXHandler.h.

Referenced by convertTag(), and GenericSAXHandler().

◆ myWithAttributes

bool PCLoaderOSM::EdgesHandler::myWithAttributes
private

Whether all attributes shall be stored.

Definition at line 346 of file PCLoaderOSM.h.

Referenced by EdgesHandler().


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