Eclipse SUMO - Simulation of Urban MObility
SAXWeightsHandler Class Reference

An XML-handler for network weights. More...

#include <SAXWeightsHandler.h>

Inheritance diagram for SAXWeightsHandler:
Collaboration diagram for SAXWeightsHandler:

Data Structures

class  EdgeFloatTimeLineRetriever
 Interface for a class which obtains read weights for named edges. More...
 
class  ToRetrieveDefinition
 Complete definition about what shall be retrieved and where to store it. More...
 

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...
 
 SAXWeightsHandler (const std::vector< ToRetrieveDefinition * > &defs, const std::string &file)
 Constructor. More...
 
 SAXWeightsHandler (ToRetrieveDefinition *def, const std::string &file)
 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...
 
 ~SAXWeightsHandler ()
 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...
 
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
 

inherited from GenericSAXHandler

std::vector< ToRetrieveDefinition * > myDefinitions
 List of definitions what shall be read and whereto stored while parsing the file. More...
 
double myCurrentTimeBeg
 the begin of the time period that is currently processed More...
 
double myCurrentTimeEnd
 the end of the time period that is currently processed More...
 
std::string myCurrentEdgeID
 the edge which is currently being processed More...
 
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
void myEndElement (int elemente)
 Called when a closing tag occurs. More...
 
void tryParse (const SUMOSAXAttributes &attrs, bool isEdge)
 Parses the efforts of a lane for the previously read times. More...
 
 SAXWeightsHandler (const SAXWeightsHandler &src)
 we made the copy constructor invalid More...
 
SAXWeightsHandleroperator= (const SAXWeightsHandler &src)
 we made the assignment operator invalid More...
 

Detailed Description

An XML-handler for network weights.

As network weights are used both in the simulation and the routers, a base class for loading them was built. Instances of this class should be supplied with at least one definition about what shall be retrieved (ToRetrieveDefinition, defined as inner class) which also contains the information about the retriever (EdgeFloatTimeLineRetriever, defined as inner class).

The ToRetrieveDefinition names the attribute which the SAXWeightsHandler shall parse and reporte. Within the parsed xml-file these attributes may be embedded in "lane" or "edge" elements, one for each edge or for each lane (see below). These elements should be embedded in interval-tags which specify the time the weight is valid at. The boolean "edgeBased" tells SAXWeightsHandler whether the weights are supplied on edge- or on lane-basis (whether it shall parse the "edge" or the "lane" elements).

Examples for files the SAXWeightsHandler can handle are the edgedump and the lanedump generated by the simulation.

The EdgeFloatTimeLineRetriever to which read values will be reported should have the method "addEdgeWeight" implemented. It wil be supplied with the current edge name, the interval the weight is valid for and the value.

Definition at line 68 of file SAXWeightsHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::map<int, XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 285 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
privateinherited

Definition at line 299 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ SAXWeightsHandler() [1/3]

SAXWeightsHandler::SAXWeightsHandler ( const std::vector< ToRetrieveDefinition * > &  defs,
const std::string &  file 
)

Constructor.

Gets a list of retriever definitions. Please note that the retrievers are not deleted!

Definition at line 54 of file SAXWeightsHandler.cpp.

◆ SAXWeightsHandler() [2/3]

SAXWeightsHandler::SAXWeightsHandler ( ToRetrieveDefinition def,
const std::string &  file 
)

Constructor.

Gets a single definition. Please note that the retrievers are not deleted!

Definition at line 60 of file SAXWeightsHandler.cpp.

References myDefinitions.

◆ ~SAXWeightsHandler()

SAXWeightsHandler::~SAXWeightsHandler ( )

Destructor.

Definition at line 68 of file SAXWeightsHandler.cpp.

References myDefinitions.

◆ SAXWeightsHandler() [3/3]

SAXWeightsHandler::SAXWeightsHandler ( const SAXWeightsHandler src)
private

we made the copy constructor invalid

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

References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().

◆ 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 80 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 176 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 120 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 205 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 211 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 221 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

void SAXWeightsHandler::myEndElement ( int  elemente)
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 141 of file SAXWeightsHandler.cpp.

References myCurrentEdgeID, myCurrentTimeBeg, myCurrentTimeEnd, myDefinitions, and SUMO_TAG_EDGE.

◆ myStartElement()

void SAXWeightsHandler::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 76 of file SAXWeightsHandler.cpp.

References SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getSUMOTimeReporting(), myCurrentEdgeID, myCurrentTimeBeg, myCurrentTimeEnd, STEPS2TIME, SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_ID, SUMO_TAG_EDGE, SUMO_TAG_INTERVAL, SUMO_TAG_LANE, and tryParse().

◆ operator=()

SAXWeightsHandler& SAXWeightsHandler::operator= ( const SAXWeightsHandler src)
private

we made the assignment operator invalid

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

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), NITypeLoader::load(), PCNetProjectionLoader::load(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), 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 93 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().

◆ tryParse()

void SAXWeightsHandler::tryParse ( const SUMOSAXAttributes attrs,
bool  isEdge 
)
private

Parses the efforts of a lane for the previously read times.

Definition at line 102 of file SAXWeightsHandler.cpp.

References SUMOSAXAttributes::getFloat(), SUMOSAXAttributes::hasAttribute(), myCurrentEdgeID, myCurrentTimeBeg, myDefinitions, toString(), and WRITE_ERROR.

Referenced by myStartElement().

◆ 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 199 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 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::characters(), GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

◆ myCurrentEdgeID

std::string SAXWeightsHandler::myCurrentEdgeID
private

the edge which is currently being processed

Definition at line 201 of file SAXWeightsHandler.h.

Referenced by myEndElement(), myStartElement(), and tryParse().

◆ myCurrentTimeBeg

double SAXWeightsHandler::myCurrentTimeBeg
private

the begin of the time period that is currently processed

Definition at line 195 of file SAXWeightsHandler.h.

Referenced by myEndElement(), myStartElement(), and tryParse().

◆ myCurrentTimeEnd

double SAXWeightsHandler::myCurrentTimeEnd
private

the end of the time period that is currently processed

Definition at line 198 of file SAXWeightsHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myDefinitions

std::vector<ToRetrieveDefinition*> SAXWeightsHandler::myDefinitions
private

List of definitions what shall be read and whereto stored while parsing the file.

Definition at line 192 of file SAXWeightsHandler.h.

Referenced by myEndElement(), SAXWeightsHandler(), tryParse(), and ~SAXWeightsHandler().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

The root element to expect, empty string disables the check.

Definition at line 318 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 315 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 309 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 312 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 291 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 321 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: