SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PCLoaderOSM::NodesHandler Class Reference

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

#include <PCLoaderOSM.h>

Inheritance diagram for PCLoaderOSM::NodesHandler:
SUMOSAXHandler GenericSAXHandler

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< SUMOLong, PCOSMNode * > &toFill, bool withAttributes, MsgHandler &errorHandler)
 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

MsgHandlermyErrorHandler
 The handler to report errors to (will be the WarningsHandler if –ignore-errors was set) More...
 
SUMOLong myLastNodeID
 The id of the last parsed node. More...
 
std::vector< intmyParentElements
 Current path in order to know to what occuring values belong. More...
 
std::map< SUMOLong, PCOSMNode * > & myToFill
 The nodes container to fill. More...
 
bool myWithAttributes
 Whether all attributes shall be stored. More...
 

Detailed Description

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

Definition at line 125 of file PCLoaderOSM.h.

Constructor & Destructor Documentation

PCLoaderOSM::NodesHandler::NodesHandler ( std::map< SUMOLong, PCOSMNode * > &  toFill,
bool  withAttributes,
MsgHandler errorHandler 
)

Contructor.

Parameters
[in]toFillThe nodes container to fill
[in]withAttributesWhether all attributes shall be stored
[in]errorHandlerThe handler to report errors to (WarningHandler for ignoring errors)

Definition at line 273 of file PCLoaderOSM.cpp.

PCLoaderOSM::NodesHandler::~NodesHandler ( )

Destructor.

Definition at line 279 of file PCLoaderOSM.cpp.

PCLoaderOSM::NodesHandler::NodesHandler ( const NodesHandler s)
private

Invalidated copy constructor.

Member Function Documentation

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

References GenericSAXHandler::getFileName().

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

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

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

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.

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

References GenericSAXHandler::buildErrorMessage().

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

References GenericSAXHandler::buildErrorMessage().

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

Referenced by GenericSAXHandler::endElement().

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

References SUMO_TAG_NODE.

void PCLoaderOSM::NodesHandler::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 283 of file PCLoaderOSM.cpp.

References SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), PCLoaderOSM::PCOSMNode::id, PCLoaderOSM::PCOSMNode::lat, PCLoaderOSM::PCOSMNode::lon, SUMO_ATTR_ID, SUMO_ATTR_K, SUMO_ATTR_LAT, SUMO_ATTR_LON, SUMO_ATTR_V, SUMO_TAG_NODE, SUMO_TAG_TAG, SUMOLong, SUMOReal, and toString().

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

Invalidated assignment operator.

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited
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_OpenDrive::loadNetwork(), and XMLSubSys::runParser().

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.

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

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

MsgHandler& PCLoaderOSM::NodesHandler::myErrorHandler
private

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

Definition at line 169 of file PCLoaderOSM.h.

SUMOLong PCLoaderOSM::NodesHandler::myLastNodeID
private

The id of the last parsed node.

Definition at line 178 of file PCLoaderOSM.h.

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

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

Definition at line 175 of file PCLoaderOSM.h.

std::map<SUMOLong, PCOSMNode*>& PCLoaderOSM::NodesHandler::myToFill
private

The nodes container to fill.

Definition at line 172 of file PCLoaderOSM.h.

bool PCLoaderOSM::NodesHandler::myWithAttributes
private

Whether all attributes shall be stored.

Definition at line 166 of file PCLoaderOSM.h.


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