#include <GeneralHandler.h>

Inheritance diagram for GeneralHandler:

Collaboration diagram for GeneralHandler:

Public Member Functions
void	characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
	The inherited method called when characters occurred.

void	endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname)
	The inherited method called when a tag is being closed.

	GeneralHandler (const std::string &file)
	Constructor.

const std::string &	getFileName () const
	returns the current file name

bool	parse ()
	parse

void	registerParent (const int tag, GenericSAXHandler *handler)
	Assigning a parent handler which is enabled when the specified tag is closed.

void	setFileName (const std::string &name)
	Sets the current file name.

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.

	~GeneralHandler ()
	Destructor.

Private Member Functions
virtual void	beginTag (SumoXMLTag tag, const SUMOSAXAttributes &attrs)=0
	start element

virtual void	endTag ()=0
	end element

	GeneralHandler (const GeneralHandler &s)=delete
	invalidate copy constructor

GeneralHandler &	operator= (const GeneralHandler &s)=delete
	invalidate assignment operator

virtual bool	postParserTasks ()=0
	run post parser tasks

inherited from SUMOSAXHandler
void	myStartElement (int element, const SUMOSAXAttributes &attrs)
	Called on the opening of a tag;.

void	myEndElement (int element)
	Called when a closing tag occurs.

SAX ErrorHandler callbacks
void	warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-warnings.

void	error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-errors.

void	fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-errors.

void	setSection (const int element, const bool seen)

bool	sectionFinished () const

std::pair< int, SUMOSAXAttributes * >	retrieveNextSectionStart ()

void	needsCharacterData (const bool value=true)

XMLCh *	convert (const std::string &name) const
	converts from c++-string into unicode

int	convertTag (const std::string &tag) const
	Converts a tag from its string into its numerical representation.

std::string	buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Builds an error message.

virtual void	myCharacters (int element, const std::string &chars)
	Callback method for characters to implement by derived classes.

void	callParentEnd (int element)
	signal endElement to the parent handler (special case for MSCalibrator)

attributes parsing
typedef std::vector< XMLCh * >	AttrMap

AttrMap	myPredefinedTags

std::vector< std::string >	myPredefinedTagsMML
	the map from ids to their string representation

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.

GenericSAXHandler *	myParentHandler
	The handler to give control back to.

int	myParentIndicator
	The tag indicating that control should be given back.

std::string	myFileName
	The name of the currently parsed file.

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

bool	myCollectCharacterData = false
	whether the reader should collect character data

bool	myRootSeen = false
	whether the reader has already seen the root element

int	mySection = -1
	The tag indicating the current section to parse.

bool	mySectionSeen = false
	whether the reader has already seen the begin of the section

bool	mySectionEnded = false
	whether the reader has already seen the end of the section

bool	mySectionOpen = false
	whether an element of the current section is open

std::pair< int, SUMOSAXAttributes * >	myNextSectionStart

Detailed Description

Definition at line 29 of file GeneralHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap

privateinherited

Definition at line 303 of file GenericSAXHandler.h.

◆ TagMap

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

privateinherited

Definition at line 317 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ GeneralHandler() [1/2]

GeneralHandler::GeneralHandler ( const std::string & file )

Constructor.

Parameters

[in] file Name of the parsed file

Definition at line 35 of file GeneralHandler.cpp.

◆ ~GeneralHandler()

GeneralHandler::~GeneralHandler ( )

Destructor.

Definition at line 40 of file GeneralHandler.cpp.

◆ GeneralHandler() [2/2]

GeneralHandler::GeneralHandler ( const GeneralHandler & s )

privatedelete

invalidate copy constructor

Member Function Documentation

◆ beginTag()

virtual void GeneralHandler::beginTag	(	SumoXMLTag	tag,
		const SUMOSAXAttributes &	attrs
	)

privatepure virtual

start element

Implemented in GNEGeneralHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ 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] exception The name of the currently processed file

Returns: A string describing the given exception

Definition at line 205 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName(), and TL.

Referenced by GenericSAXHandler::error(), GenericSAXHandler::fatalError(), and GenericSAXHandler::warning().

Here is the caller graph for this function:

◆ callParentEnd()

void GenericSAXHandler::callParentEnd ( int element )

protectedinherited

signal endElement to the parent handler (special case for MSCalibrator)

Definition at line 247 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myEndElement(), and GenericSAXHandler::myParentHandler.

Referenced by MSCalibrator::myEndElement().

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

References GenericSAXHandler::myCharactersVector, GenericSAXHandler::myCollectCharacterData, and StringUtils::transcode().

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string & name ) const

privateinherited

converts from c++-string into unicode

Todo:: recheck encoding

Parameters

[in] name The string to convert

Returns: The string converted into a XMLCh-string

Definition at line 86 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] tag The string to convert

Returns: The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 195 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 134 of file GenericSAXHandler.cpp.

References GenericSAXHandler::convertTag(), GenericSAXHandler::myCharacters(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myEndElement(), GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, GenericSAXHandler::mySection, GenericSAXHandler::mySectionOpen, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, SUMO_TAG_NOTHING, and StringUtils::transcode().

◆ endTag()

virtual void GeneralHandler::endTag ( )

privatepure virtual

end element

Implemented in GNEGeneralHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ 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] exception The occurred exception to process

Exceptions

ProcessError On any call

Definition at line 224 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::addFlowTransportable(), MSRouteHandler::addTransportable(), MSRouteHandler::closeTransportable(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::interpretDepartPosLat().

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

ProcessError On any call

Parameters

[in] exception The occurred exception to process

Definition at line 230 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

const std::string & GenericSAXHandler::getFileName ( ) const

inherited

returns the current file name

Returns: The name of the currently processed file

Definition at line 80 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(), NLHandler::myEndElement(), RODFDetectorHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NLHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), DataHandler::parse(), parse(), XMLSubSys::runParser(), GenericSAXHandler::startElement(), and SUMORouteLoader::SUMORouteLoader().

Here is the caller graph for this function:

◆ 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]	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_ITSUMO::Handler, and NIImporter_OpenDrive.

Definition at line 240 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

Here is the caller graph for this function:

◆ myEndElement()

void GeneralHandler::myEndElement ( int element )

privatevirtual

Called when a closing tag occurs.

Parameters

[in] element ID of the currently opened element

Exceptions

ProcessError If something fails

See also: GenericSAXHandler::myEndElement

Todo:: Refactor/describe

Reimplemented from GenericSAXHandler.

Definition at line 62 of file GeneralHandler.cpp.

References endTag().

◆ myStartElement()

void GeneralHandler::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)

privatevirtual

Called on the opening of a tag;.

Parameters

[in]	element	ID of the currently opened element
[in]	attrs	Attributes within the currently opened element

Exceptions

ProcessError If something fails

See also: GenericSAXHandler::myStartElement

Todo:: Refactor/describe

Reimplemented from GenericSAXHandler.

Definition at line 53 of file GeneralHandler.cpp.

References beginTag(), and SUMO_TAG_ROOTFILE.

◆ needsCharacterData()

void GenericSAXHandler::needsCharacterData ( const bool value = true )

inlineinherited

Definition at line 220 of file GenericSAXHandler.h.

References GenericSAXHandler::myCollectCharacterData.

Referenced by NIImporter_ITSUMO::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and NIImporter_OpenDrive::myCharacters().

Here is the caller graph for this function:

◆ operator=()

GeneralHandler & GeneralHandler::operator= ( const GeneralHandler & s )

privatedelete

invalidate assignment operator

◆ parse()

bool GeneralHandler::parse ( )

parse

Definition at line 44 of file GeneralHandler.cpp.

References GenericSAXHandler::getFileName(), postParserTasks(), and XMLSubSys::runParser().

Referenced by GNENet::computeNetwork(), GNEApplicationWindow::loadAdditionalElements(), GNEApplicationWindow::loadDemandElements(), GNEApplicationWindow::loadMeanDataElements(), GNENetDiffTool::loadShapes(), GNEApplicationWindow::onCmdOpenAdditionals(), GNEApplicationWindow::onCmdOpenDemandElements(), GNEApplicationWindow::onCmdOpenMeanDatas(), GNEApplicationWindow::onCmdReloadAdditionals(), GNEApplicationWindow::onCmdReloadDemandElements(), and GNEApplicationWindow::onCmdReloadMeanDatas().

Here is the caller graph for this function:

◆ postParserTasks()

virtual bool GeneralHandler::postParserTasks ( )

privatepure virtual

run post parser tasks

Implemented in GNEGeneralHandler.

Referenced by parse().

Here is the caller graph for this function:

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

◆ retrieveNextSectionStart()

std::pair< int, SUMOSAXAttributes * > GenericSAXHandler::retrieveNextSectionStart ( )

inlineinherited

Definition at line 213 of file GenericSAXHandler.h.

References GenericSAXHandler::myNextSectionStart.

Referenced by SUMOSAXReader::parseSection().

Here is the caller graph for this function:

◆ sectionFinished()

bool GenericSAXHandler::sectionFinished ( ) const

inlineinherited

Definition at line 209 of file GenericSAXHandler.h.

References GenericSAXHandler::mySectionEnded.

Referenced by SUMOSAXReader::parseSection().

Here is the caller graph for this function:

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string & name )

inherited

Sets the current file name.

Parameters

[in] name The name of the currently processed file

Todo:: Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 74 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), MSStateHandler::MSStateTimeHandler::getTime(), 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:

◆ setSection()

void GenericSAXHandler::setSection	(	const int	element,
		const bool	seen
	)

inlineinherited

Definition at line 202 of file GenericSAXHandler.h.

References GenericSAXHandler::mySection, GenericSAXHandler::mySectionEnded, GenericSAXHandler::mySectionOpen, and GenericSAXHandler::mySectionSeen.

Referenced by SUMOSAXReader::parseSection().

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

◆ 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] exception The occurred exception to process

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

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

◆ myCollectCharacterData

bool GenericSAXHandler::myCollectCharacterData = false

privateinherited

whether the reader should collect character data

Definition at line 339 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::characters(), and GenericSAXHandler::needsCharacterData().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot

privateinherited

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

Definition at line 336 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName

privateinherited

The name of the currently parsed file.

Definition at line 333 of file GenericSAXHandler.h.

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

◆ myNextSectionStart

std::pair<int, SUMOSAXAttributes*> GenericSAXHandler::myNextSectionStart

privateinherited

Definition at line 356 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::retrieveNextSectionStart(), GenericSAXHandler::startElement(), and GenericSAXHandler::~GenericSAXHandler().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler

privateinherited

The handler to give control back to.

Definition at line 327 of file GenericSAXHandler.h.

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

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator

privateinherited

The tag indicating that control should be given back.

Definition at line 330 of file GenericSAXHandler.h.

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

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags

privateinherited

Definition at line 306 of file GenericSAXHandler.h.

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

◆ myPredefinedTagsMML

std::vector<std::string> GenericSAXHandler::myPredefinedTagsMML

privateinherited

the map from ids to their string representation

Definition at line 309 of file GenericSAXHandler.h.

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

◆ myRootSeen

bool GenericSAXHandler::myRootSeen = false

privateinherited

whether the reader has already seen the root element

Definition at line 342 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ mySection

int GenericSAXHandler::mySection = -1

privateinherited

The tag indicating the current section to parse.

Definition at line 345 of file GenericSAXHandler.h.

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

◆ mySectionEnded

bool GenericSAXHandler::mySectionEnded = false

privateinherited

whether the reader has already seen the end of the section

Definition at line 351 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::sectionFinished(), GenericSAXHandler::setSection(), and GenericSAXHandler::startElement().

◆ mySectionOpen

bool GenericSAXHandler::mySectionOpen = false

privateinherited

whether an element of the current section is open

Definition at line 354 of file GenericSAXHandler.h.

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

◆ mySectionSeen

bool GenericSAXHandler::mySectionSeen = false

privateinherited

whether the reader has already seen the begin of the section

Definition at line 348 of file GenericSAXHandler.h.

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

◆ myTagMap

TagMap GenericSAXHandler::myTagMap

privateinherited

Definition at line 320 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::convertTag(), and GenericSAXHandler::GenericSAXHandler().

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

Public Member Functions

Private Member Functions

SAX ErrorHandler callbacks

attributes parsing

elements parsing

Detailed Description

Member Typedef Documentation

◆ AttrMap

◆ TagMap

Constructor & Destructor Documentation

◆ GeneralHandler() [1/2]

◆ ~GeneralHandler()

◆ GeneralHandler() [2/2]

Member Function Documentation

◆ beginTag()

◆ buildErrorMessage()

◆ callParentEnd()

◆ characters()

◆ convert()

◆ convertTag()

◆ endElement()

◆ endTag()

◆ error()

◆ fatalError()

◆ getFileName()

◆ myCharacters()

◆ myEndElement()

◆ myStartElement()

◆ needsCharacterData()

◆ operator=()

◆ parse()

◆ postParserTasks()

◆ registerParent()

◆ retrieveNextSectionStart()

◆ sectionFinished()

◆ setFileName()

◆ setSection()

◆ startElement()

◆ warning()

Field Documentation

◆ myCharactersVector

◆ myCollectCharacterData

◆ myExpectedRoot

◆ myFileName

◆ myNextSectionStart

◆ myParentHandler

◆ myParentIndicator

◆ myPredefinedTags

◆ myPredefinedTagsMML

◆ myRootSeen

◆ mySection

◆ mySectionEnded

◆ mySectionOpen

◆ mySectionSeen

◆ myTagMap