Eclipse SUMO - Simulation of Urban MObility
NIXMLTrafficLightsHandler Class Reference

Importer for edge connections stored in XML. More...

#include <NIXMLTrafficLightsHandler.h>

Inheritance diagram for NIXMLTrafficLightsHandler:
[legend]
Collaboration diagram for NIXMLTrafficLightsHandler:
[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...
 
 NIXMLTrafficLightsHandler (NBTrafficLightLogicCont &tlCont, NBEdgeCont &ec, bool ignoreUnknown=false)
 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...
 
 ~NIXMLTrafficLightsHandler ()
 Destructor. More...
 

inherited from GenericSAXHandler

NBTrafficLightLogicContmyTLLCont
 The traffic light container to fill. More...
 
NBEdgeContmyEdgeCont
 The edge container for retrieving edges. More...
 
NBLoadedSUMOTLDefmyCurrentTL
 The currently parsed traffic light. More...
 
bool myResetPhases
 whether phases of a previously loaded traffic light must be reset More...
 
bool myIgnoreUnknown
 whether definitions for unknown traffic lights shall be silently ignored More...
 
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...
 
NBLoadedSUMOTLDefinitTrafficLightLogic (const SUMOSAXAttributes &attrs, NBLoadedSUMOTLDef *currentTL)
 
void addTlConnection (const SUMOSAXAttributes &attrs)
 reads and adds tl-controlled connection More...
 
void removeTlConnection (const SUMOSAXAttributes &attrs)
 reads and removes tl-controlled connection More...
 
NBEdgeretrieveEdge (const SUMOSAXAttributes &attrs, SumoXMLAttr attr, bool &ok)
 parses and edge id an returns an existing edge More...
 
int retrieveLaneIndex (const SUMOSAXAttributes &attrs, SumoXMLAttr attr, NBEdge *edge, bool &ok, bool isDelete=false)
 parses a lane index and verifies its correctness More...
 
 NIXMLTrafficLightsHandler (const NIXMLTrafficLightsHandler &s)
 invalidated copy constructor More...
 
NIXMLTrafficLightsHandleroperator= (const NIXMLTrafficLightsHandler &s)
 invalidated assignment operator 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...
 
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

Importer for edge connections stored in XML.

This importer parses connections, and prohibitions, and is able to reset connections between edges.

Definition at line 47 of file NIXMLTrafficLightsHandler.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

◆ NIXMLTrafficLightsHandler() [1/2]

NIXMLTrafficLightsHandler::NIXMLTrafficLightsHandler ( NBTrafficLightLogicCont tlCont,
NBEdgeCont ec,
bool  ignoreUnknown = false 
)

Constructor.

Parameters
[in]ecThe traffic light container into which to load logics

Definition at line 51 of file NIXMLTrafficLightsHandler.cpp.

◆ ~NIXMLTrafficLightsHandler()

NIXMLTrafficLightsHandler::~NIXMLTrafficLightsHandler ( )

Destructor.

Definition at line 62 of file NIXMLTrafficLightsHandler.cpp.

◆ NIXMLTrafficLightsHandler() [2/2]

NIXMLTrafficLightsHandler::NIXMLTrafficLightsHandler ( const NIXMLTrafficLightsHandler s)
private

invalidated copy constructor

Member Function Documentation

◆ addTlConnection()

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

◆ initTrafficLightLogic()

◆ 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 NIXMLTrafficLightsHandler::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 103 of file NIXMLTrafficLightsHandler.cpp.

References myCurrentTL, and SUMO_TAG_TLLOGIC.

◆ myStartElement()

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

◆ operator=()

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

invalidated assignment operator

◆ 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:

◆ removeTlConnection()

void NIXMLTrafficLightsHandler::removeTlConnection ( const SUMOSAXAttributes attrs)
private

reads and removes tl-controlled connection

Definition at line 282 of file NIXMLTrafficLightsHandler.cpp.

References SUMOSAXAttributes::get(), NBTrafficLightLogicCont::getPrograms(), myTLLCont, NBLoadedSUMOTLDef::removeConnection(), retrieveEdge(), retrieveLaneIndex(), SUMO_ATTR_FROM, SUMO_ATTR_FROM_LANE, SUMO_ATTR_TLID, SUMO_ATTR_TLLINKINDEX, SUMO_ATTR_TO, and SUMO_ATTR_TO_LANE.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ retrieveEdge()

NBEdge * NIXMLTrafficLightsHandler::retrieveEdge ( const SUMOSAXAttributes attrs,
SumoXMLAttr  attr,
bool &  ok 
)
private

parses and edge id an returns an existing edge

Definition at line 316 of file NIXMLTrafficLightsHandler.cpp.

References SUMOSAXAttributes::get(), myEdgeCont, NBEdgeCont::retrieve(), and WRITE_ERROR.

Referenced by addTlConnection(), and removeTlConnection().

Here is the caller graph for this function:

◆ retrieveLaneIndex()

int NIXMLTrafficLightsHandler::retrieveLaneIndex ( const SUMOSAXAttributes attrs,
SumoXMLAttr  attr,
NBEdge edge,
bool &  ok,
bool  isDelete = false 
)
private

parses a lane index and verifies its correctness

Definition at line 329 of file NIXMLTrafficLightsHandler.cpp.

References SUMOSAXAttributes::get(), NBEdge::getID(), NBEdge::getNumLanes(), toString(), and WRITE_ERROR.

Referenced by addTlConnection(), and removeTlConnection().

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

◆ myCurrentTL

NBLoadedSUMOTLDef* NIXMLTrafficLightsHandler::myCurrentTL
private

The currently parsed traffic light.

Definition at line 92 of file NIXMLTrafficLightsHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myEdgeCont

NBEdgeCont& NIXMLTrafficLightsHandler::myEdgeCont
private

The edge container for retrieving edges.

Definition at line 89 of file NIXMLTrafficLightsHandler.h.

Referenced by retrieveEdge().

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

◆ myIgnoreUnknown

bool NIXMLTrafficLightsHandler::myIgnoreUnknown
private

whether definitions for unknown traffic lights shall be silently ignored

Definition at line 116 of file NIXMLTrafficLightsHandler.h.

Referenced by initTrafficLightLogic().

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

◆ myResetPhases

bool NIXMLTrafficLightsHandler::myResetPhases
private

whether phases of a previously loaded traffic light must be reset

Definition at line 95 of file NIXMLTrafficLightsHandler.h.

Referenced by initTrafficLightLogic(), and myStartElement().

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

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

◆ myTLLCont

NBTrafficLightLogicCont& NIXMLTrafficLightsHandler::myTLLCont
private

The traffic light container to fill.

Definition at line 86 of file NIXMLTrafficLightsHandler.h.

Referenced by addTlConnection(), initTrafficLightLogic(), and removeTlConnection().


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