SUMO - Simulation of Urban MObility
NIImporter_OpenStreetMap::NodesHandler Class Reference

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

#include <NIImporter_OpenStreetMap.h>

Inheritance diagram for NIImporter_OpenStreetMap::NodesHandler:
Inheritance graph
Collaboration diagram for NIImporter_OpenStreetMap::NodesHandler:
Collaboration graph

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured. 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...
 
 NodesHandler (std::map< long long int, NIOSMNode *> &toFill, std::set< NIOSMNode *, CompareNodes > &uniqueNodes, bool importElevation)
 Contructor. 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...
 
 ~NodesHandler ()
 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...
 
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

 NodesHandler (const NodesHandler &s)
 invalidated copy constructor More...
 
NodesHandleroperator= (const NodesHandler &s)
 invalidated assignment operator More...
 

Private Attributes

int myHierarchyLevel
 The current hierarchy level. More...
 
const bool myImportElevation
 whether elevation data should be imported More...
 
bool myIsInValidNodeTag
 Hierarchy helper for parsing a node's tags. More...
 
long long int myLastNodeID
 ID of the currently parsed node, for reporting mainly. More...
 
std::map< long long int, NIOSMNode * > & myToFill
 The nodes container to fill. More...
 
std::set< NIOSMNode *, CompareNodes > & myUniqueNodes
 the set of unique nodes (used for duplicate detection/substitution) More...
 

Detailed Description

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

Definition at line 250 of file NIImporter_OpenStreetMap.h.

Constructor & Destructor Documentation

§ NodesHandler() [1/2]

NIImporter_OpenStreetMap::NodesHandler::NodesHandler ( std::map< long long int, NIOSMNode *> &  toFill,
std::set< NIOSMNode *, CompareNodes > &  uniqueNodes,
bool  importElevation 
)

Contructor.

Parameters
[in,out]toFillThe nodes container to fill
[in,out]uniqueNodesThe nodes container for ensuring uniqueness
[in]optionsThe options to use

Definition at line 563 of file NIImporter_OpenStreetMap.cpp.

§ ~NodesHandler()

NIImporter_OpenStreetMap::NodesHandler::~NodesHandler ( )

Destructor.

Definition at line 577 of file NIImporter_OpenStreetMap.cpp.

§ NodesHandler() [2/2]

NIImporter_OpenStreetMap::NodesHandler::NodesHandler ( const NodesHandler 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 192 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName().

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

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

§ 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 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.

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

Definition at line 211 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

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

§ 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 occured exception to process

Definition at line 217 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_ITSUMO::Handler.

Definition at line 227 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

§ myEndElement()

void NIImporter_OpenStreetMap::NodesHandler::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 666 of file NIImporter_OpenStreetMap.cpp.

References myHierarchyLevel, myIsInValidNodeTag, myLastNodeID, and SUMO_TAG_NODE.

§ myStartElement()

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

§ operator=()

NodesHandler& NIImporter_OpenStreetMap::NodesHandler::operator= ( const NodesHandler 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 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_Vissim::loadXML(), NILoader::loadXMLType(), main(), and XMLSubSys::runParser().

§ 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 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.

§ 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 occured exception to process

Definition at line 205 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

§ myHierarchyLevel

int NIImporter_OpenStreetMap::NodesHandler::myHierarchyLevel
private

The current hierarchy level.

Definition at line 302 of file NIImporter_OpenStreetMap.h.

Referenced by myEndElement(), and myStartElement().

§ myImportElevation

const bool NIImporter_OpenStreetMap::NodesHandler::myImportElevation
private

whether elevation data should be imported

Definition at line 308 of file NIImporter_OpenStreetMap.h.

Referenced by myStartElement().

§ myIsInValidNodeTag

bool NIImporter_OpenStreetMap::NodesHandler::myIsInValidNodeTag
private

Hierarchy helper for parsing a node's tags.

Definition at line 299 of file NIImporter_OpenStreetMap.h.

Referenced by myEndElement(), and myStartElement().

§ myLastNodeID

long long int NIImporter_OpenStreetMap::NodesHandler::myLastNodeID
private

ID of the currently parsed node, for reporting mainly.

Definition at line 296 of file NIImporter_OpenStreetMap.h.

Referenced by myEndElement(), and myStartElement().

§ myToFill

std::map<long long int, NIOSMNode*>& NIImporter_OpenStreetMap::NodesHandler::myToFill
private

The nodes container to fill.

Definition at line 293 of file NIImporter_OpenStreetMap.h.

Referenced by myStartElement().

§ myUniqueNodes

std::set<NIOSMNode*, CompareNodes>& NIImporter_OpenStreetMap::NodesHandler::myUniqueNodes
private

the set of unique nodes (used for duplicate detection/substitution)

Definition at line 305 of file NIImporter_OpenStreetMap.h.

Referenced by myStartElement().


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