Eclipse SUMO - Simulation of Urban MObility
PCLoaderOSM::RelationsHandler Class Reference

A class which extracts relevant way-ids from relations in a parsed OSM-file. More...

#include <PCLoaderOSM.h>

Inheritance diagram for PCLoaderOSM::RelationsHandler:
Collaboration diagram for PCLoaderOSM::RelationsHandler:

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...
 
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed. More...
 
 RelationsHandler (RelationsMap &additionalWays, Relations &relations, bool withAttributes, MsgHandler &errorHandler)
 Constructor. 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...
 
 ~RelationsHandler ()
 Destructor. 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...
 

Protected Member Functions

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)
 
inherited from GenericSAXHandler
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...
 

Private Member Functions

RelationsHandleroperator= (const RelationsHandler &s)
 Invalidated assignment operator. More...
 
 RelationsHandler (const RelationsHandler &s)
 Invalidated copy constructor. More...
 

Private Attributes

RelationsMapmyAdditionalWays
 additional ways which are reference by relations More...
 
PCOSMRelationmyCurrentRelation
 The currently parsed relation. More...
 
std::vector< long long int > myCurrentWays
 the ways within the current relation More...
 
MsgHandlermyErrorHandler
 The handler to report errors to (will be the WarningsHandler if –ignore-errors was set) More...
 
bool myKeep
 whether the last edge (way) should be kept because it had a key from the inclusion list More...
 
std::vector< long long int > myParentElements
 Current path in order to know to what occuring values belong. More...
 
RelationsmyRelations
 the loaded relations More...
 
bool myWithAttributes
 Whether all attributes shall be stored. More...
 

Detailed Description

A class which extracts relevant way-ids from relations in a parsed OSM-file.

Definition at line 214 of file PCLoaderOSM.h.

Constructor & Destructor Documentation

◆ RelationsHandler() [1/2]

PCLoaderOSM::RelationsHandler::RelationsHandler ( RelationsMap additionalWays,
Relations relations,
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]errorHandlerThe handler to report errors to (WarningHandler for ignoring errors)

Definition at line 469 of file PCLoaderOSM.cpp.

◆ ~RelationsHandler()

PCLoaderOSM::RelationsHandler::~RelationsHandler ( )

Destructor.

Definition at line 482 of file PCLoaderOSM.cpp.

◆ RelationsHandler() [2/2]

PCLoaderOSM::RelationsHandler::RelationsHandler ( const RelationsHandler s)
private

Invalidated copy constructor.

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

◆ 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 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 PCLoaderOSM::RelationsHandler::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 546 of file PCLoaderOSM.cpp.

References myCurrentRelation, myCurrentWays, myParentElements, PCLoaderOSM::PCOSMRelation::myWays, and SUMO_TAG_RELATION.

◆ myStartElement()

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

◆ operator=()

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

Invalidated 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().

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

◆ 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

◆ myAdditionalWays

RelationsMap& PCLoaderOSM::RelationsHandler::myAdditionalWays
private

additional ways which are reference by relations

Definition at line 259 of file PCLoaderOSM.h.

Referenced by myStartElement().

◆ myCurrentRelation

PCOSMRelation* PCLoaderOSM::RelationsHandler::myCurrentRelation
private

The currently parsed relation.

Definition at line 271 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myCurrentWays

std::vector<long long int> PCLoaderOSM::RelationsHandler::myCurrentWays
private

the ways within the current relation

Definition at line 274 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myErrorHandler

MsgHandler& PCLoaderOSM::RelationsHandler::myErrorHandler
private

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

Definition at line 268 of file PCLoaderOSM.h.

Referenced by myStartElement().

◆ myKeep

bool PCLoaderOSM::RelationsHandler::myKeep
private

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

Definition at line 280 of file PCLoaderOSM.h.

◆ myParentElements

std::vector<long long int> PCLoaderOSM::RelationsHandler::myParentElements
private

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

Definition at line 277 of file PCLoaderOSM.h.

Referenced by myEndElement(), and myStartElement().

◆ myRelations

Relations& PCLoaderOSM::RelationsHandler::myRelations
private

the loaded relations

Definition at line 262 of file PCLoaderOSM.h.

Referenced by myStartElement().

◆ myWithAttributes

bool PCLoaderOSM::RelationsHandler::myWithAttributes
private

Whether all attributes shall be stored.

Definition at line 265 of file PCLoaderOSM.h.


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