Eclipse SUMO - Simulation of Urban MObility
NIXMLNodesHandler Class Reference

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

#include <NIXMLNodesHandler.h>

Inheritance diagram for NIXMLNodesHandler:
Collaboration diagram for NIXMLNodesHandler:

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...
 
 NIXMLNodesHandler (NBNodeCont &nc, NBEdgeCont &ec, 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...
 

Static Public Member Functions

static NBNodeprocessNodeType (const SUMOSAXAttributes &attrs, NBNode *node, const std::string &nodeID, const Position &position, bool updateEdgeGeometries, NBNodeCont &nc, NBEdgeCont &ec, NBTrafficLightLogicCont &tlc)
 parses node attributes (not related to positioning) More...
 

inherited from GenericSAXHandler

OptionsContmyOptions
 A reference to the program's options. More...
 
std::string myID
 The id of the currently parsed node. More...
 
Position myPosition
 The position of the currently parsed node. More...
 
NBNodeContmyNodeCont
 The node container to add built nodes to. More...
 
NBEdgeContmyEdgeCont
 The node container to add built nodes to. More...
 
NBTrafficLightLogicContmyTLLogicCont
 The traffic lights container to add built tls to. More...
 
GeoConvHelpermyLocation
 The coordinate transformation which was used compute the node coordinates. More...
 
ParameterisedmyLastParameterised
 last item the could receive parameters 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...
 
void addNode (const SUMOSAXAttributes &attrs)
 
void deleteNode (const SUMOSAXAttributes &attrs)
 
void addJoinCluster (const SUMOSAXAttributes &attrs)
 
void addJoinExclusion (const SUMOSAXAttributes &attrs)
 
 NIXMLNodesHandler (const NIXMLNodesHandler &s)
 invalid copy constructor More...
 
NIXMLNodesHandleroperator= (const NIXMLNodesHandler &s)
 invalid assignment operator More...
 
static void processTrafficLightDefinitions (const SUMOSAXAttributes &attrs, NBNode *currentNode, NBTrafficLightLogicCont &tlc)
 Builds the defined traffic light or adds a node to it. 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
 

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 53 of file NIXMLNodesHandler.h.

Member Typedef Documentation

◆ AttrMap

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

Definition at line 286 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 300 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ NIXMLNodesHandler() [1/2]

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

Constructor.

Parameters
[in,filled]nc The node container to fill
[in,filled]tlc The traffic lights container to fill
[in]optionsThe options to use
Todo:

Options are only given to determine whether "flip-y" is set; maybe this should be done by giving a bool

Why are options not const?

Definition at line 52 of file NIXMLNodesHandler.cpp.

◆ ~NIXMLNodesHandler()

NIXMLNodesHandler::~NIXMLNodesHandler ( )

Destructor.

Definition at line 65 of file NIXMLNodesHandler.cpp.

References myLocation.

◆ NIXMLNodesHandler() [2/2]

NIXMLNodesHandler::NIXMLNodesHandler ( const NIXMLNodesHandler s)
private

invalid copy constructor

Member Function Documentation

◆ addJoinCluster()

◆ addJoinExclusion()

void NIXMLNodesHandler::addJoinExclusion ( const SUMOSAXAttributes attrs)
private

◆ addNode()

◆ 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 187 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 170 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 81 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 177 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

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

◆ deleteNode()

void NIXMLNodesHandler::deleteNode ( const SUMOSAXAttributes attrs)
private

◆ 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 121 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 206 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 212 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 222 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

void NIXMLNodesHandler::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 104 of file NIXMLNodesHandler.cpp.

References myLastParameterised, and SUMO_TAG_NODE.

◆ myStartElement()

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 71 of file NIXMLNodesHandler.cpp.

References addJoinCluster(), addJoinExclusion(), addNode(), deleteNode(), SUMOSAXAttributes::get(), SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), NIImporter_SUMO::loadLocation(), myLastParameterised, myLocation, Parameterised::setParameter(), SUMO_ATTR_KEY, SUMO_ATTR_VALUE, SUMO_TAG_DELETE, SUMO_TAG_JOIN, SUMO_TAG_JOINEXCLUDE, SUMO_TAG_LOCATION, SUMO_TAG_NODE, and SUMO_TAG_PARAM.

◆ operator=()

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

invalid assignment operator

◆ processNodeType()

◆ processTrafficLightDefinitions()

void NIXMLNodesHandler::processTrafficLightDefinitions ( const SUMOSAXAttributes attrs,
NBNode currentNode,
NBTrafficLightLogicCont tlc 
)
staticprivate

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

References GenericSAXHandler::myFileName.

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

◆ 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 200 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 307 of file GenericSAXHandler.h.

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

◆ myEdgeCont

NBEdgeCont& NIXMLNodesHandler::myEdgeCont
private

The node container to add built nodes to.

Definition at line 152 of file NIXMLNodesHandler.h.

Referenced by addJoinCluster(), and addNode().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 319 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 316 of file GenericSAXHandler.h.

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

◆ myID

std::string NIXMLNodesHandler::myID
private

The id of the currently parsed node.

Definition at line 143 of file NIXMLNodesHandler.h.

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

◆ myLastParameterised

Parameterised* NIXMLNodesHandler::myLastParameterised
private

last item the could receive parameters

Definition at line 161 of file NIXMLNodesHandler.h.

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

◆ myLocation

GeoConvHelper* NIXMLNodesHandler::myLocation
private

The coordinate transformation which was used compute the node coordinates.

Definition at line 158 of file NIXMLNodesHandler.h.

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

◆ myNodeCont

NBNodeCont& NIXMLNodesHandler::myNodeCont
private

The node container to add built nodes to.

Definition at line 149 of file NIXMLNodesHandler.h.

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

◆ myOptions

OptionsCont& NIXMLNodesHandler::myOptions
private

A reference to the program's options.

Definition at line 140 of file NIXMLNodesHandler.h.

Referenced by addNode().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

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

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

◆ myPosition

Position NIXMLNodesHandler::myPosition
private

The position of the currently parsed node.

Definition at line 146 of file NIXMLNodesHandler.h.

Referenced by addJoinCluster(), and addNode().

◆ 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 292 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 322 of file GenericSAXHandler.h.

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

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

◆ myTLLogicCont

NBTrafficLightLogicCont& NIXMLNodesHandler::myTLLogicCont
private

The traffic lights container to add built tls to.

Definition at line 155 of file NIXMLNodesHandler.h.

Referenced by addJoinCluster(), and addNode().


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