Eclipse SUMO - Simulation of Urban MObility
ROJTRTurnDefLoader Class Reference

Loader for the of turning percentages and source/sink definitions. More...

#include <ROJTRTurnDefLoader.h>

Inheritance diagram for ROJTRTurnDefLoader:
[legend]
Collaboration diagram for ROJTRTurnDefLoader:
[legend]

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...
 
 ROJTRTurnDefLoader (RONet &net)
 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...
 
 ~ROJTRTurnDefLoader ()
 Destructor. More...
 

inherited from GenericSAXHandler

RONetmyNet
 The network to set the information into. More...
 
double myIntervalBegin
 The begin and the end of the current interval. More...
 
double myIntervalEnd
 
ROJTREdgemyEdge
 The current incoming edge the turning probabilities are set into. More...
 
bool mySourcesAreSinks
 whether all sources are sinks More...
 
bool myDiscountSources
 whether upstream flows should be discounted from source flows More...
 
bool myHaveWarnedAboutDeprecatedFormat
 whether the warning for the deprecated format has been issued More...
 
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
void beginFromEdge (const SUMOSAXAttributes &attrs)
 Begins the processing of a incoming edge definition. More...
 
void addToEdge (const SUMOSAXAttributes &attrs)
 Parses the probability to use a certain outgoing edge. More...
 
void addEdgeRel (const SUMOSAXAttributes &attrs)
 Parses the probability to use a certain incoming-outgoing edge relation. More...
 

attributes parsing

AttrMap myPredefinedTags
 
std::vector< std::string > myPredefinedTagsMML
 the map from ids to their string representation More...
 
typedef std::vector< 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 myRootSeen
 whether the reader has already seen the root element More...
 
typedef std::map< std::string, int > TagMap
 

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...
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes. More...
 
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...
 

Detailed Description

Loader for the of turning percentages and source/sink definitions.

This handler parses XML-descriptions of jtrrouter-definitions, including percentage ratios at junctions and definitions of sink/source edges.

All read values are stored directly into the given network's structures (edges).

Definition at line 52 of file ROJTRTurnDefLoader.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 279 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 293 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ ROJTRTurnDefLoader()

ROJTRTurnDefLoader::ROJTRTurnDefLoader ( RONet net)

Constructor.

Parameters
[in]netThe net to add loaded turning percentages into

Definition at line 43 of file ROJTRTurnDefLoader.cpp.

◆ ~ROJTRTurnDefLoader()

ROJTRTurnDefLoader::~ROJTRTurnDefLoader ( )

Destructor.

Definition at line 53 of file ROJTRTurnDefLoader.cpp.

Member Function Documentation

◆ addEdgeRel()

void ROJTRTurnDefLoader::addEdgeRel ( const SUMOSAXAttributes attrs)
private

Parses the probability to use a certain incoming-outgoing edge relation.

Parameters
[in]attrsThe SAX-attributes to parse the destination edge and the probability to use it from

Definition at line 187 of file ROJTRTurnDefLoader.cpp.

References ROJTREdge::addFollowerProbability(), SUMOSAXAttributes::get(), RONet::getEdge(), SUMOSAXAttributes::hasAttribute(), myIntervalBegin, myIntervalEnd, myNet, SUMO_ATTR_COUNT, SUMO_ATTR_FROM, SUMO_ATTR_PROB, SUMO_ATTR_TO, and WRITE_ERROR.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addToEdge()

void ROJTRTurnDefLoader::addToEdge ( const SUMOSAXAttributes attrs)
private

Parses the probability to use a certain outgoing edge.

Tries to retreive the outgoing edge and then the probability to use it. If one of both operations could not be accomplished, an error is generated.

If everything is ok, this means the destination edge is defined and known and the probability is valid, too, this probability is added to "myEdge", the last parsed incoming edge. As time, the previously parsed interval begin/end is used.

Parameters
[in]attrsThe SAX-attributes to parse the destination edge and the probability to use it from

Definition at line 159 of file ROJTRTurnDefLoader.cpp.

References ROJTREdge::addFollowerProbability(), SUMOSAXAttributes::get(), RONet::getEdge(), myEdge, myIntervalBegin, myIntervalEnd, myNet, SUMO_ATTR_ID, SUMO_ATTR_PROB, and WRITE_ERROR.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ beginFromEdge()

void ROJTRTurnDefLoader::beginFromEdge ( const SUMOSAXAttributes attrs)
private

Begins the processing of a incoming edge definition.

Tries to retrieve the currently described incoming edge. If the edge id is not given in the attributes or the edge is not known, an error is reported.

If everything is ok, the edge's address is stored in myEdge.

Parameters
[in]attrsThe SAX-attributes to parse incoming edge from

Definition at line 141 of file ROJTRTurnDefLoader.cpp.

References SUMOSAXAttributes::get(), RONet::getEdge(), myEdge, myNet, SUMO_ATTR_ID, and WRITE_ERROR.

Referenced by myStartElement().

Here is the caller graph for this function:

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

References GenericSAXHandler::getFileName(), and transcode().

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

Here is the caller graph for this function:

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

Referenced by GenericSAXHandler::GenericSAXHandler().

Here is the caller graph for this function:

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

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

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

Here is the caller graph for this function:

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

References GenericSAXHandler::buildErrorMessage().

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

Here is the caller graph for this function:

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

Referenced by GenericSAXHandler::endElement().

Here is the caller graph for this function:

◆ myEndElement()

void GenericSAXHandler::myEndElement ( int  element)
protectedvirtualinherited

◆ myStartElement()

◆ registerParent()

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 163 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

Here is the caller graph for this function:

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

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), PCNetProjectionLoader::load(), NITypeLoader::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), main(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ 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 97 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::myRootSeen, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, StringUtils::transcode(), and WRITE_WARNING.

◆ 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 201 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 300 of file GenericSAXHandler.h.

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

◆ myDiscountSources

bool ROJTRTurnDefLoader::myDiscountSources
private

whether upstream flows should be discounted from source flows

Definition at line 128 of file ROJTRTurnDefLoader.h.

Referenced by myStartElement().

◆ myEdge

ROJTREdge* ROJTRTurnDefLoader::myEdge
private

The current incoming edge the turning probabilities are set into.

Definition at line 122 of file ROJTRTurnDefLoader.h.

Referenced by addToEdge(), and beginFromEdge().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 312 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::getFileName(), and GenericSAXHandler::setFileName().

◆ myHaveWarnedAboutDeprecatedFormat

bool ROJTRTurnDefLoader::myHaveWarnedAboutDeprecatedFormat
private

whether the warning for the deprecated format has been issued

Definition at line 131 of file ROJTRTurnDefLoader.h.

Referenced by myStartElement().

◆ myIntervalBegin

double ROJTRTurnDefLoader::myIntervalBegin
private

The begin and the end of the current interval.

Definition at line 119 of file ROJTRTurnDefLoader.h.

Referenced by addEdgeRel(), addToEdge(), and myStartElement().

◆ myIntervalEnd

double ROJTRTurnDefLoader::myIntervalEnd
private

Definition at line 119 of file ROJTRTurnDefLoader.h.

Referenced by addEdgeRel(), addToEdge(), and myStartElement().

◆ myNet

RONet& ROJTRTurnDefLoader::myNet
private

The network to set the information into.

Definition at line 116 of file ROJTRTurnDefLoader.h.

Referenced by addEdgeRel(), addToEdge(), beginFromEdge(), and myStartElement().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 303 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 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

◆ myPredefinedTagsMML

std::vector<std::string> GenericSAXHandler::myPredefinedTagsMML
privateinherited

the map from ids to their string representation

Definition at line 285 of file GenericSAXHandler.h.

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

◆ myRootSeen

bool GenericSAXHandler::myRootSeen
privateinherited

whether the reader has already seen the root element

Definition at line 315 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ mySourcesAreSinks

bool ROJTRTurnDefLoader::mySourcesAreSinks
private

whether all sources are sinks

Definition at line 125 of file ROJTRTurnDefLoader.h.

Referenced by myStartElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

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