SUMO - Simulation of Urban MObility
NIXMLTrafficLightsHandler Class Reference

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

#include <NIXMLTrafficLightsHandler.h>

Inheritance diagram for NIXMLTrafficLightsHandler:
Inheritance graph
Collaboration diagram for NIXMLTrafficLightsHandler:
Collaboration graph

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...
 
 NIXMLTrafficLightsHandler (NBTrafficLightLogicCont &tlCont, NBEdgeCont &ec)
 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...
 
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 on the opening of a tag;. More...
 
void myEndElement (int element)
 Called when a closing tag occurs. More...
 

Private Member Functions

void addTlConnection (const SUMOSAXAttributes &attrs)
 reads and adds tl-controlled connection More...
 
NBLoadedSUMOTLDefinitTrafficLightLogic (const SUMOSAXAttributes &attrs, NBLoadedSUMOTLDef *currentTL)
 
 NIXMLTrafficLightsHandler (const NIXMLTrafficLightsHandler &s)
 invalidated copy constructor More...
 
NIXMLTrafficLightsHandleroperator= (const NIXMLTrafficLightsHandler &s)
 invalidated assignment operator 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)
 parses a lane index and verifies its correctness More...
 

Private Attributes

NBLoadedSUMOTLDefmyCurrentTL
 The currently parsed traffic light. More...
 
NBEdgeContmyEdgeCont
 The edge container for retrieving edges. More...
 
bool myResetPhases
 whether phases of a previously loaded traffic light must be reset More...
 
NBTrafficLightLogicContmyTLLCont
 The traffic light container to fill. 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 57 of file NIXMLTrafficLightsHandler.h.

Constructor & Destructor Documentation

◆ NIXMLTrafficLightsHandler() [1/2]

NIXMLTrafficLightsHandler::NIXMLTrafficLightsHandler ( NBTrafficLightLogicCont tlCont,
NBEdgeCont ec 
)

Constructor.

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

Definition at line 60 of file NIXMLTrafficLightsHandler.cpp.

◆ ~NIXMLTrafficLightsHandler()

NIXMLTrafficLightsHandler::~NIXMLTrafficLightsHandler ( )

Destructor.

Definition at line 70 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().

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

References TplConvert::_2str(), and GenericSAXHandler::myCharactersVector.

◆ 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 TplConvert::_2str(), GenericSAXHandler::convertTag(), GenericSAXHandler::myCharacters(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myEndElement(), GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, and SUMO_TAG_NOTHING.

◆ 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 occured exception to process
Exceptions
ProcessErrorOn any call

Definition at line 207 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

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

◆ 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 occured 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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_ITSUMO::Handler.

Definition at line 223 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

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

References myCurrentTL, SUMO_TAG_TLLOGIC, and WRITE_ERROR.

◆ myStartElement()

void NIXMLTrafficLightsHandler::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 74 of file NIXMLTrafficLightsHandler.cpp.

References NIImporter_SUMO::addPhase(), addTlConnection(), NBLoadedSUMOTLDef::getLogic(), initTrafficLightLogic(), myCurrentTL, myResetPhases, removeTlConnection(), NBTrafficLightLogic::resetPhases(), SUMO_TAG_CONNECTION, SUMO_TAG_DELETE, SUMO_TAG_PHASE, and SUMO_TAG_TLLOGIC.

◆ operator=()

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

invalidated assignment operator

◆ registerParent()

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

◆ removeTlConnection()

void NIXMLTrafficLightsHandler::removeTlConnection ( const SUMOSAXAttributes attrs)
private

◆ retrieveEdge()

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

parses and edge id an returns an existing edge

Definition at line 306 of file NIXMLTrafficLightsHandler.cpp.

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

Referenced by addTlConnection(), and removeTlConnection().

◆ retrieveLaneIndex()

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

parses a lane index and verifies its correctness

Definition at line 319 of file NIXMLTrafficLightsHandler.cpp.

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

Referenced by addTlConnection(), and removeTlConnection().

◆ 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 76 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_Vissim::loadXML(), NILoader::loadXMLType(), main(), and XMLSubSys::runParser().

◆ 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 101 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.

◆ 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 occured exception to process

Definition at line 201 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myCurrentTL

NBLoadedSUMOTLDef* NIXMLTrafficLightsHandler::myCurrentTL
private

The currently parsed traffic light.

Definition at line 102 of file NIXMLTrafficLightsHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myEdgeCont

NBEdgeCont& NIXMLTrafficLightsHandler::myEdgeCont
private

The edge container for retrieving edges.

Definition at line 99 of file NIXMLTrafficLightsHandler.h.

Referenced by retrieveEdge().

◆ myResetPhases

bool NIXMLTrafficLightsHandler::myResetPhases
private

whether phases of a previously loaded traffic light must be reset

Definition at line 105 of file NIXMLTrafficLightsHandler.h.

Referenced by initTrafficLightLogic(), and myStartElement().

◆ myTLLCont

NBTrafficLightLogicCont& NIXMLTrafficLightsHandler::myTLLCont
private

The traffic light container to fill.

Definition at line 96 of file NIXMLTrafficLightsHandler.h.

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


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