SUMO - Simulation of Urban MObility
NIXMLNodesHandler Class Reference

Importer for network nodes stored in XML. More...

#include <NIXMLNodesHandler.h>

Inheritance diagram for NIXMLNodesHandler:
Inheritance graph
Collaboration diagram for NIXMLNodesHandler:
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...
 
 NIXMLNodesHandler (NBNodeCont &nc, NBTrafficLightLogicCont &tlc, OptionsCont &options)
 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...
 
 ~NIXMLNodesHandler ()
 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...
 

Static Public Member Functions

static void processNodeType (const SUMOSAXAttributes &attrs, NBNode *node, const std::string &nodeID, const Position &position, bool updateEdgeGeometries, NBNodeCont &nc, NBTrafficLightLogicCont &tlc)
 parses node attributes (not related to positioning) 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...
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes. More...
 
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 

Private Member Functions

void addJoinCluster (const SUMOSAXAttributes &attrs)
 
void addJoinExclusion (const SUMOSAXAttributes &attrs)
 
void addNode (const SUMOSAXAttributes &attrs)
 
void deleteNode (const SUMOSAXAttributes &attrs)
 
 NIXMLNodesHandler (const NIXMLNodesHandler &s)
 invalid copy constructor More...
 
NIXMLNodesHandleroperator= (const NIXMLNodesHandler &s)
 invalid assignment operator More...
 

Static Private Member Functions

static void processTrafficLightDefinitions (const SUMOSAXAttributes &attrs, NBNode *currentNode, NBTrafficLightLogicCont &tlc)
 Builds the defined traffic light or adds a node to it. More...
 

Private Attributes

std::string myID
 The id of the currently parsed node. More...
 
GeoConvHelpermyLocation
 The coordinate transformation which was used compute the node coordinates. More...
 
NBNodeContmyNodeCont
 The node container to add built nodes to. More...
 
OptionsContmyOptions
 A reference to the program's options. More...
 
Position myPosition
 The position of the currently parsed node. More...
 
NBTrafficLightLogicContmyTLLogicCont
 The traffic lights container to add built tls to. More...
 

Detailed Description

Importer for network nodes stored in XML.

This SAX-handler parses node information and stores it in the given node container. Additionally, the given tls-container may be filled with additional information.

Definition at line 60 of file NIXMLNodesHandler.h.

Constructor & Destructor Documentation

NIXMLNodesHandler::NIXMLNodesHandler ( NBNodeCont nc,
NBTrafficLightLogicCont tlc,
OptionsCont options 
)

Constructor.

Parameters

Definition at line 63 of file NIXMLNodesHandler.cpp.

NIXMLNodesHandler::~NIXMLNodesHandler ( )

Destructor.

Definition at line 74 of file NIXMLNodesHandler.cpp.

References myLocation.

NIXMLNodesHandler::NIXMLNodesHandler ( const NIXMLNodesHandler s)
private

invalid copy constructor

Member Function Documentation

void NIXMLNodesHandler::addJoinCluster ( const SUMOSAXAttributes attrs)
private
void NIXMLNodesHandler::addJoinExclusion ( const SUMOSAXAttributes attrs)
private
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 NIXMLNodesHandler::deleteNode ( const SUMOSAXAttributes attrs)
private
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::closeContainer(), MSRouteHandler::closePerson(), NIImporter_OpenDrive::geomFromSpiral(), MSRouteHandler::myStartElement(), and MSRouteHandler::parseWalkPos().

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 NIXMLNodesHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

Called on the opening of a tag;.

In dependence to the obtained type, an appropriate parsing method is called.

Parameters
[in]elementID of the currently opened element
[in]attrsAttributes within the currently opened element
Exceptions
ProcessErrorIf something fails (not used herein)
Note
policy is to throw no exception in order to allow further processing
Todo:
ProcessErrors are thrown when parsing traffic lights!?

Reimplemented from GenericSAXHandler.

Definition at line 80 of file NIXMLNodesHandler.cpp.

References addJoinCluster(), addJoinExclusion(), addNode(), deleteNode(), NIImporter_SUMO::loadLocation(), myLocation, SUMO_TAG_DELETE, SUMO_TAG_JOIN, SUMO_TAG_JOINEXCLUDE, SUMO_TAG_LOCATION, and SUMO_TAG_NODE.

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

invalid assignment operator

void NIXMLNodesHandler::processTrafficLightDefinitions ( const SUMOSAXAttributes attrs,
NBNode currentNode,
NBTrafficLightLogicCont tlc 
)
staticprivate
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_Vissim::loadXML(), NILoader::loadXMLType(), main(), 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

std::string NIXMLNodesHandler::myID
private

The id of the currently parsed node.

Definition at line 142 of file NIXMLNodesHandler.h.

Referenced by addNode(), and deleteNode().

GeoConvHelper* NIXMLNodesHandler::myLocation
private

The coordinate transformation which was used compute the node coordinates.

Definition at line 154 of file NIXMLNodesHandler.h.

Referenced by addNode(), myStartElement(), and ~NIXMLNodesHandler().

NBNodeCont& NIXMLNodesHandler::myNodeCont
private

The node container to add built nodes to.

Definition at line 148 of file NIXMLNodesHandler.h.

Referenced by addJoinCluster(), addJoinExclusion(), addNode(), and deleteNode().

OptionsCont& NIXMLNodesHandler::myOptions
private

A reference to the program's options.

Definition at line 139 of file NIXMLNodesHandler.h.

Referenced by addNode().

Position NIXMLNodesHandler::myPosition
private

The position of the currently parsed node.

Definition at line 145 of file NIXMLNodesHandler.h.

Referenced by addNode().

NBTrafficLightLogicCont& NIXMLNodesHandler::myTLLogicCont
private

The traffic lights container to add built tls to.

Definition at line 151 of file NIXMLNodesHandler.h.

Referenced by addNode().


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