Eclipse SUMO - Simulation of Urban MObility
ODDistrictHandler Class Reference

An XML-Handler for districts. More...

#include <ODDistrictHandler.h>

Inheritance diagram for ODDistrictHandler:
Collaboration diagram for ODDistrictHandler:

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...
 
 ODDistrictHandler (ODDistrictCont &cont, const std::string &file)
 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...
 
 ~ODDistrictHandler ()
 Destructor. More...
 

inherited from GenericSAXHandler

ODDistrictContmyContainer
 The container to add read districts to. More...
 
ODDistrictmyCurrentDistrict
 The currently parsed district. More...
 
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called when an opening-tag occurs. More...
 
void myEndElement (int element)
 Called when a closing tag occurs. More...
 
void openDistrict (const SUMOSAXAttributes &attrs)
 Begins the parsing of a district. More...
 
void addSource (const SUMOSAXAttributes &attrs)
 Adds a read source to the current district. More...
 
void addSink (const SUMOSAXAttributes &attrs)
 Adds a read sink to the current district. More...
 
void closeDistrict ()
 Closes the processing of the current district. More...
 
std::pair< std::string, double > parseTAZ (const SUMOSAXAttributes &attrs)
 Returns the id and weight for a taz/tazSink/tazSource. More...
 
 ODDistrictHandler (const ODDistrictHandler &s)
 invalidated copy constructor More...
 
ODDistrictHandleroperator= (const ODDistrictHandler &s)
 invalidated 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

An XML-Handler for districts.

This SUMOSAXHandler parses districts and their sinks and sources from and stores them into a the district container given at initialisation.

Definition at line 50 of file ODDistrictHandler.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

◆ ODDistrictHandler() [1/2]

ODDistrictHandler::ODDistrictHandler ( ODDistrictCont cont,
const std::string &  file 
)

Constructor.

Saves the given district containe in order to fill it.

Parameters
[in]contThe container of districts to fill
[in]fileThe file that will be processed

Definition at line 42 of file ODDistrictHandler.cpp.

◆ ~ODDistrictHandler()

ODDistrictHandler::~ODDistrictHandler ( )

Destructor.

Definition at line 47 of file ODDistrictHandler.cpp.

◆ ODDistrictHandler() [2/2]

ODDistrictHandler::ODDistrictHandler ( const ODDistrictHandler s)
private

invalidated copy constructor

Member Function Documentation

◆ addSink()

void ODDistrictHandler::addSink ( const SUMOSAXAttributes attrs)
private

Adds a read sink to the current district.

Tries to get the id and the weight of the currently parsed sink from the attributes using getValues. If the retrieval could be done without errors (weight>=0), the so retrieved weighted sink is added to myCurrentDistrict using addSink. (getValues checks whether myCurrentDistrict is valid)

Parameters
[in]attrsAttributes of the currently opened element
Todo:
Checking whether myCurrentDistrict is valid through getValues is not quite nice

Definition at line 107 of file ODDistrictHandler.cpp.

References ODDistrict::addSink(), myCurrentDistrict, and parseTAZ().

Referenced by myStartElement().

◆ addSource()

void ODDistrictHandler::addSource ( const SUMOSAXAttributes attrs)
private

Adds a read source to the current district.

Tries to get the id and the weight of the currently parsed source from the attributes using getValues. If the retrieval could be done without errors (weight>=0), the so retrieved weighted source is added to myCurrentDistrict using addSource. (getValues checks whether myCurrentDistrict is valid)

Parameters
[in]attrsAttributes of the currently opened element
Todo:
Checking whether myCurrentDistrict is valid through getValues is not quite nice

Definition at line 98 of file ODDistrictHandler.cpp.

References ODDistrict::addSource(), myCurrentDistrict, and parseTAZ().

Referenced by myStartElement().

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

◆ closeDistrict()

void ODDistrictHandler::closeDistrict ( )
private

Closes the processing of the current district.

Adds myCurrentDistrict to myContainer.

Definition at line 142 of file ODDistrictHandler.cpp.

References NamedObjectCont< T >::add(), Named::getID(), myContainer, and myCurrentDistrict.

Referenced by myEndElement().

◆ 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 ODDistrictHandler::myEndElement ( int  element)
protectedvirtual

Called when a closing tag occurs.

Processes district elements via closeDistrict.

Parameters
[in]elementID of the currently opened element
Exceptions
ProcessErrorIf an error within the parsed file occurs

Reimplemented from GenericSAXHandler.

Definition at line 70 of file ODDistrictHandler.cpp.

References closeDistrict(), and SUMO_TAG_TAZ.

◆ myStartElement()

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

Called when an opening-tag occurs.

Processes district elements via openDistrict, their sinks (via addSink) and sources (via addSource).

Parameters
[in]elementThe enum of the currently opened element
[in]attrsAttributes of the currently opened element
Exceptions
ProcessErrorIf an error within the parsed file occurs
See also
GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 51 of file ODDistrictHandler.cpp.

References addSink(), addSource(), openDistrict(), SUMO_TAG_TAZ, SUMO_TAG_TAZSINK, and SUMO_TAG_TAZSOURCE.

◆ openDistrict()

void ODDistrictHandler::openDistrict ( const SUMOSAXAttributes attrs)
private

Begins the parsing of a district.

Tries to retrieve the id of a district, adds a message to the error handler if this fails. Otherwise builds a new district with this id at myCurrentDistrict.

Parameters
[in]attrsAttributes of the currently opened element

Definition at line 78 of file ODDistrictHandler.cpp.

References ODDistrict::addSink(), ODDistrict::addSource(), SUMOSAXAttributes::get(), SUMOSAXAttributes::getStringVector(), SUMOSAXAttributes::hasAttribute(), myCurrentDistrict, SUMO_ATTR_EDGES, and SUMO_ATTR_ID.

Referenced by myStartElement().

◆ operator=()

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

invalidated assignment operator

◆ parseTAZ()

std::pair< std::string, double > ODDistrictHandler::parseTAZ ( const SUMOSAXAttributes attrs)
private

Returns the id and weight for a taz/tazSink/tazSource.

Checks whether myCurrentDistrict (the currently processed district) is !=0; in this case, both the id and the weight are parsed. If one of them is missing or the weight is not numerical, an error is generated and reported to MsgHandler. The "type"-parameter is used in order to inform the user whether a source or a sink was processed. In the case of an error, the returned weight is -1.

If no error occurs, the correct id and weight are returned.

Parameters
[in]attrsAttributes of the currently opened element
[in]typeThe type of the currntly processed connection (sink/source)
Returns
The id and the weight of a taz

Definition at line 117 of file ODDistrictHandler.cpp.

References SUMOSAXAttributes::get(), SUMOSAXAttributes::getObjectType(), myCurrentDistrict, SUMO_ATTR_ID, SUMO_ATTR_WEIGHT, and WRITE_ERROR.

Referenced by addSink(), and addSource().

◆ 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

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

◆ myContainer

ODDistrictCont& ODDistrictHandler::myContainer
private

The container to add read districts to.

Definition at line 160 of file ODDistrictHandler.h.

Referenced by closeDistrict().

◆ myCurrentDistrict

ODDistrict* ODDistrictHandler::myCurrentDistrict
private

The currently parsed district.

Definition at line 163 of file ODDistrictHandler.h.

Referenced by addSink(), addSource(), closeDistrict(), openDistrict(), and parseTAZ().

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

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

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

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