![]() |
Eclipse SUMO - Simulation of Urban MObility
|
SAX-handler base for SUMO-files. More...
#include <SUMOSAXHandler.h>
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... | |
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... | |
SUMOSAXHandler (const std::string &file="", const std::string &expectedRoot="") | |
Constructor. More... | |
virtual | ~SUMOSAXHandler () |
Destructor. More... | |
Private Member Functions | |
const SUMOSAXHandler & | operator= (const SUMOSAXHandler &s) |
invalidated assignment operator More... | |
SUMOSAXHandler (const SUMOSAXHandler &s) | |
invalidated copy constructor 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... | |
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... | |
std::string | buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception) |
Builds an error message. More... | |
virtual void | myStartElement (int element, const SUMOSAXAttributes &attrs) |
Callback method for an opening tag to implement by derived classes. 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... | |
void | setSchemaSeen (const bool schemaSeen=true) |
attributes parsing | |
typedef std::map< int, XMLCh * > | AttrMap |
AttrMap | myPredefinedTags |
std::map< int, std::string > | myPredefinedTagsMML |
the map from ids to their string representation More... | |
elements parsing | |
typedef std::map< std::string, int > | TagMap |
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... | |
GenericSAXHandler * | myParentHandler |
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... | |
SAX-handler base for SUMO-files.
This class is a GenericSAXHandler which knows all tags SUMO uses, so all SUMO-XML - loading classes should be derived from it.
Definition at line 41 of file SUMOSAXHandler.h.
|
privateinherited |
Definition at line 285 of file GenericSAXHandler.h.
|
privateinherited |
Definition at line 299 of file GenericSAXHandler.h.
SUMOSAXHandler::SUMOSAXHandler | ( | const std::string & | file = "" , |
const std::string & | expectedRoot = "" |
||
) |
Constructor.
[in] | file | The name of the processed file |
Definition at line 35 of file SUMOSAXHandler.cpp.
|
virtual |
Destructor.
Definition at line 40 of file SUMOSAXHandler.cpp.
|
private |
invalidated copy constructor
|
protectedinherited |
Builds an error message.
The error message includes the file name and the line/column information as supported by the given SAXParseException
[in] | exception | The name of the currently processed file |
Definition at line 186 of file GenericSAXHandler.cpp.
References GenericSAXHandler::getFileName(), and transcode().
Referenced by GenericSAXHandler::error(), GenericSAXHandler::fatalError(), and GenericSAXHandler::warning().
|
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.
Definition at line 169 of file GenericSAXHandler.cpp.
References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().
|
privateinherited |
converts from c++-string into unicode
[in] | name | The string to convert |
Definition at line 80 of file GenericSAXHandler.cpp.
Referenced by GenericSAXHandler::GenericSAXHandler().
|
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.
[in] | tag | The string to convert |
Definition at line 176 of file GenericSAXHandler.cpp.
References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.
Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().
|
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.
Definition at line 120 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().
|
inherited |
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
[in] | exception | The occurred exception to process |
ProcessError | On any call |
Definition at line 205 of file GenericSAXHandler.cpp.
References GenericSAXHandler::buildErrorMessage().
Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::myStartElement().
|
inherited |
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
ProcessError | On any call |
[in] | exception | The occurred exception to process |
Definition at line 211 of file GenericSAXHandler.cpp.
References GenericSAXHandler::buildErrorMessage().
|
inherited |
returns the current file name
Definition at line 74 of file GenericSAXHandler.cpp.
References GenericSAXHandler::myFileName.
Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), GenericSAXHandler::buildErrorMessage(), PCNetProjectionLoader::load(), NITypeLoader::load(), NLHandler::myEndElement(), RODFDetectorHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NLHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), GNEAdditionalHandler::parseAndBuildPOI(), GNEAdditionalHandler::parseAndBuildPoly(), XMLSubSys::runParser(), GenericSAXHandler::startElement(), and SUMORouteLoader::SUMORouteLoader().
|
protectedvirtualinherited |
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
[in] | element | The opened element, given as a int |
[in] | chars | The 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 221 of file GenericSAXHandler.cpp.
Referenced by GenericSAXHandler::endElement().
|
protectedvirtualinherited |
Callback method for a closing tag to implement by derived classes.
Called by "endElement" (see there).
[in] | element | The closed element, given as a int @exceptions ProcessError These method may throw a ProcessError if something fails |
Reimplemented in SAXWeightsHandler, NIImporter_OpenStreetMap::RelationHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, SUMORouteHandler, ShapeHandler, RONetHandler, PCLoaderOSM::EdgesHandler, PCLoaderOSM::RelationsHandler, PCLoaderOSM::NodesHandler, ODDistrictHandler, NLHandler, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIXMLTrafficLightsHandler, NIXMLPTHandler, NIXMLNodesHandler, NIXMLEdgesHandler, NIImporter_SUMO, NIImporter_OpenDrive, NIImporter_ITSUMO::Handler, GNEAdditionalHandler, MSTriggeredRerouter, MSLaneSpeedTrigger, MSCalibrator, MSStateHandler, ROMARouteHandler, and GUITriggeredRerouter.
Definition at line 225 of file GenericSAXHandler.cpp.
Referenced by GenericSAXHandler::endElement(), and SUMOSAXReader::parseNext().
|
protectedvirtualinherited |
Callback method for an opening tag to implement by derived classes.
Called by "startElement" (see there).
[in] | element | The element that contains the characters, given as a int |
[in] | attrs | The SAX-attributes, wrapped as SUMOSAXAttributes @exceptions ProcessError These method may throw a ProcessError if something fails |
Reimplemented in NIImporter_OpenStreetMap::RelationHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, SAXWeightsHandler, SUMORouteHandler, ShapeHandler, GUISettingsHandler, TrajectoriesHandler, RORouteHandler, RONetHandler, PCTypeDefHandler, PCNetProjectionLoader, PCLoaderXML, PCLoaderOSM::EdgesHandler, PCLoaderOSM::RelationsHandler, PCLoaderOSM::NodesHandler, ODDistrictHandler, ODAmitranHandler, NLHandler, NIImporter_Vissim::NIVissimXMLHandler_ConflictArea, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition, NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIXMLTypesHandler, NIXMLTrafficLightsHandler, NIXMLPTHandler, NIXMLNodesHandler, NIXMLEdgesHandler, NIXMLConnectionsHandler, NIImporter_SUMO, NIImporter_OpenDrive, NIImporter_MATSim::EdgesHandler, NIImporter_MATSim::NodesHandler, NIImporter_ITSUMO::Handler, GNEParametersDialog::ParametersOptions::GNEParameterHandler, GNEAdditionalHandler, MSTriggeredRerouter, MSLaneSpeedTrigger, MSCalibrator, MSStateHandler, MSRouteHandler, ROMARouteHandler, ROJTRTurnDefLoader, GUINet::DiscoverAttributes, RODFDetectorHandler, and AGActivityGenHandler.
Definition at line 217 of file GenericSAXHandler.cpp.
Referenced by SUMOSAXReader::parseNext(), and GenericSAXHandler::startElement().
|
private |
invalidated assignment operator
|
inherited |
Assigning a parent handler which is enabled when the specified tag is closed.
Definition at line 161 of file GenericSAXHandler.cpp.
References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().
Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().
|
inherited |
Sets the current file name.
[in] | name | The name of the currently processed file |
Definition at line 68 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().
|
inlineprotectedinherited |
Definition at line 254 of file GenericSAXHandler.h.
References GenericSAXHandler::mySchemaSeen.
Referenced by SUMOSAXReader::LocalSchemaResolver::resolveEntity().
|
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.
Definition at line 93 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().
|
inherited |
Handler for XML-warnings.
The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.
[in] | exception | The occurred exception to process |
Definition at line 199 of file GenericSAXHandler.cpp.
References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.
|
privateinherited |
A list of character strings obtained so far to build the complete characters string at the end.
Definition at line 306 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::characters(), GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().
|
privateinherited |
The root element to expect, empty string disables the check.
Definition at line 318 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::startElement().
|
privateinherited |
The name of the currently parsed file.
Definition at line 315 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::getFileName(), and GenericSAXHandler::setFileName().
|
privateinherited |
The handler to give control back to.
Definition at line 309 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().
|
privateinherited |
The tag indicating that control should be given back.
Definition at line 312 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().
|
privateinherited |
Definition at line 288 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::GenericSAXHandler(), GenericSAXHandler::startElement(), and GenericSAXHandler::~GenericSAXHandler().
|
privateinherited |
the map from ids to their string representation
Definition at line 291 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::GenericSAXHandler(), SUMOSAXReader::parseNext(), and GenericSAXHandler::startElement().
|
privateinherited |
whether the reader has already seen a schema
Definition at line 321 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::setSchemaSeen(), and GenericSAXHandler::startElement().
|
privateinherited |
Definition at line 302 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler::convertTag(), and GenericSAXHandler::GenericSAXHandler().