SUMO - Simulation of Urban MObility
ODDistrictHandler Class Reference

An XML-Handler for districts. More...

#include <ODDistrictHandler.h>

Inheritance diagram for ODDistrictHandler:
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...
 
 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...
 
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 when an opening-tag occurs. More...
 
void myEndElement (int element)
 Called when a closing tag occurs. More...
 

Private Member Functions

void addSink (const SUMOSAXAttributes &attrs)
 Adds a read sink to the current district. More...
 
void addSource (const SUMOSAXAttributes &attrs)
 Adds a read source to the current district. More...
 
void closeDistrict ()
 Closes the processing of the current district. More...
 
 ODDistrictHandler (const ODDistrictHandler &s)
 invalidated copy constructor More...
 
void openDistrict (const SUMOSAXAttributes &attrs)
 Begins the parsing of a district. More...
 
ODDistrictHandleroperator= (const ODDistrictHandler &s)
 invalidated assignment operator More...
 
std::pair< std::string, SUMORealparseConnection (const SUMOSAXAttributes &attrs)
 Returns the id and weight for a sink/source. More...
 

Private Attributes

ODDistrictContmyContainer
 The container to add read districts to. More...
 
ODDistrictmyCurrentDistrict
 The currently parsed district. More...
 

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 57 of file ODDistrictHandler.h.

Constructor & Destructor Documentation

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 53 of file ODDistrictHandler.cpp.

ODDistrictHandler::~ODDistrictHandler ( )

Destructor.

Definition at line 58 of file ODDistrictHandler.cpp.

ODDistrictHandler::ODDistrictHandler ( const ODDistrictHandler s)
private

invalidated copy constructor

Member Function Documentation

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 118 of file ODDistrictHandler.cpp.

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

Referenced by myStartElement().

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 109 of file ODDistrictHandler.cpp.

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

Referenced by myStartElement().

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 ODDistrictHandler::closeDistrict ( )
private

Closes the processing of the current district.

Adds myCurrentDistrict to myContainer.

Definition at line 153 of file ODDistrictHandler.cpp.

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

Referenced by myEndElement().

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

Referenced by MSRouteHandler::myStartElement().

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 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 81 of file ODDistrictHandler.cpp.

References closeDistrict(), and SUMO_TAG_TAZ.

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 62 of file ODDistrictHandler.cpp.

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

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

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

invalidated assignment operator

std::pair< std::string, SUMOReal > ODDistrictHandler::parseConnection ( const SUMOSAXAttributes attrs)
private

Returns the id and weight for a sink/source.

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 connection

Definition at line 128 of file ODDistrictHandler.cpp.

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

Referenced by addSink(), and addSource().

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

ODDistrictCont& ODDistrictHandler::myContainer
private

The container to add read districts to.

Definition at line 167 of file ODDistrictHandler.h.

Referenced by closeDistrict().

ODDistrict* ODDistrictHandler::myCurrentDistrict
private

The currently parsed district.

Definition at line 170 of file ODDistrictHandler.h.

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


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