SAX2-Handler for loading DFROUTER-detector definitions. More...

#include <RODFDetectorHandler.h>

Inheritance diagram for RODFDetectorHandler:

Collaboration diagram for RODFDetectorHandler:

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.
const std::string &	getFileName () const
	returns the current file name
void	registerParent (const int tag, GenericSAXHandler *handler)
	Assigning a parent handler which is enabled when the specified tag is closed.
	RODFDetectorHandler (RODFNet *optNet, bool ignoreErrors, RODFDetectorCon &con, const std::string &file)
	Constructor.
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.
virtual	~RODFDetectorHandler ()
	Destructor.

inherited from GenericSAXHandler
RODFNet *	myNet
	the net
bool	myIgnoreErrors
	whether to ignore errors on parsing
RODFDetectorCon &	myContainer
	the container to put the detectors into
void	myStartElement (int element, const SUMOSAXAttributes &attrs)
	Called on the opening of a tag;.
	RODFDetectorHandler (const RODFDetectorHandler &src)
	invalidated copy constructor
RODFDetectorHandler &	operator= (const RODFDetectorHandler &src)
	invalidated assignment operator

attributes parsing
AttrMap	myPredefinedTags
std::vector< std::string >	myPredefinedTagsMML
	the map from ids to their string representation
typedef std::vector< 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.
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
typedef std::map< std::string, int >	TagMap

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)
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.
virtual void	myEndElement (int element)
	Callback method for a closing tag to implement by derived classes.
void	callParentEnd (int element)
	signal endElement to the parent handler (special case for MSCalibrator)
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.

Detailed Description

SAX2-Handler for loading DFROUTER-detector definitions.

Definition at line 39 of file RODFDetectorHandler.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

◆ RODFDetectorHandler() [1/2]

RODFDetectorHandler::RODFDetectorHandler	(	RODFNet *	optNet,
		bool	ignoreErrors,
		RODFDetectorCon &	con,
		const std::string &	file )

Constructor.

Definition at line 41 of file RODFDetectorHandler.cpp.

References myContainer, myIgnoreErrors, myNet, and SUMOSAXHandler::SUMOSAXHandler().

Referenced by operator=(), and RODFDetectorHandler().

Here is the caller graph for this function:

◆ ~RODFDetectorHandler()

RODFDetectorHandler::~RODFDetectorHandler ( )

virtual

Destructor.

Definition at line 47 of file RODFDetectorHandler.cpp.

◆ RODFDetectorHandler() [2/2]

RODFDetectorHandler::RODFDetectorHandler ( const RODFDetectorHandler & src )

private

invalidated copy constructor

References RODFDetectorHandler().

Member Function Documentation

◆ 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 getFileName(), and TL.

Referenced by error(), fatalError(), and 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 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 myCharactersVector, 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().

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 myTagMap, and SUMO_TAG_NOTHING.

Referenced by endElement(), and 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 convertTag(), myCharacters(), myCharactersVector, myEndElement(), myParentHandler, myParentIndicator, mySection, mySectionOpen, 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] exception The occurred exception to process

Exceptions

ProcessError On any call

Definition at line 224 of file GenericSAXHandler.cpp.

References 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 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 myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), SUMORouteHandler::addParam(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), buildErrorMessage(), MSRouteHandler::closeVType(), PCNetProjectionLoader::load(), NLHandler::myEndElement(), GUISettingsHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NLHandler::myStartElement(), RODFDetectorHandler::myStartElement(), SUMORouteHandler::myStartElement(), DataHandler::parse(), GeneralHandler::parse(), XMLSubSys::runParser(), and startElement().

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 endElement().

Here is the caller graph for this function:

◆ myEndElement()

void GenericSAXHandler::myEndElement ( int element )

protectedvirtualinherited

Callback method for a closing tag to implement by derived classes.

Called by "endElement" (see there).

Parameters

[in] element The closed element, given as a int @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in DataHandler, GeneralHandler, GUISettingsHandler, GUITriggeredRerouter, MSCalibrator, MSLaneSpeedTrigger, MSStateHandler, MSTriggeredRerouter, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenStreetMap::RelationHandler, NIImporter_SUMO, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIXMLConnectionsHandler, NIXMLEdgesHandler, NIXMLNodesHandler, NIXMLPTHandler, NIXMLTrafficLightsHandler, NLHandler, ODDistrictHandler, PCLoaderOSM::EdgesHandler, PCLoaderOSM::NodesHandler, PCLoaderOSM::RelationsHandler, ROMARouteHandler, RONetHandler, SAXWeightsHandler, ShapeHandler, SUMORouteHandler, and VehicleEngineHandler.

Definition at line 244 of file GenericSAXHandler.cpp.

Referenced by endElement().

Here is the caller graph for this function:

◆ myStartElement()

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

protectedvirtual

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

Reimplemented from GenericSAXHandler.

Definition at line 51 of file RODFDetectorHandler.cpp.

References BETWEEN_DETECTOR, SUMOSAXAttributes::get(), SUMOXMLDefinitions::getEdgeIDFromLane(), GenericSAXHandler::getFileName(), SUMOXMLDefinitions::getIndexFromLane(), ROEdge::getNumLanes(), SUMOSAXAttributes::getOpt(), myContainer, myIgnoreErrors, myNet, SINK_DETECTOR, SOURCE_DETECTOR, SUMO_ATTR_ID, SUMO_ATTR_LANE, SUMO_ATTR_POSITION, SUMO_ATTR_TYPE, SUMO_TAG_DETECTOR_DEFINITION, SUMO_TAG_E1DETECTOR, SUMO_TAG_INDUCTION_LOOP, TLF, TYPE_NOT_DEFINED, and WRITE_WARNING.

◆ needsCharacterData()

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

inlineinherited

Definition at line 220 of file GenericSAXHandler.h.

References invalid_return< std::string >::value, and myCollectCharacterData.

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

Here is the caller graph for this function:

◆ operator=()

RODFDetectorHandler & RODFDetectorHandler::operator= ( const RODFDetectorHandler & src )

private

invalidated assignment operator

References RODFDetectorHandler().

◆ 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, 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 myNextSectionStart.

◆ sectionFinished()

bool GenericSAXHandler::sectionFinished ( ) const

inlineinherited

Definition at line 209 of file GenericSAXHandler.h.

References mySectionEnded.

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

Referenced by NIImporter_SUMO::_loadNetwork(), MSStateHandler::MSStateTimeHandler::getTime(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), NITypeLoader::load(), PCNetProjectionLoader::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 mySection, mySectionEnded, mySectionOpen, and mySectionSeen.

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

References convertTag(), FileHelpers::getConfigurationRelative(), getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), myCharactersVector, myExpectedRoot, myNextSectionStart, myPredefinedTags, myPredefinedTagsMML, myRootSeen, mySection, mySectionEnded, mySectionOpen, mySectionSeen, myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, TL, StringUtils::transcode(), and WRITE_WARNINGF.

◆ 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 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 characters(), endElement(), and startElement().

◆ myCollectCharacterData

bool GenericSAXHandler::myCollectCharacterData = false

privateinherited

whether the reader should collect character data

Definition at line 339 of file GenericSAXHandler.h.

Referenced by characters(), and needsCharacterData().

◆ myContainer

RODFDetectorCon& RODFDetectorHandler::myContainer

private

the container to put the detectors into

Definition at line 71 of file RODFDetectorHandler.h.

Referenced by myStartElement(), and RODFDetectorHandler().

◆ 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(), and 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 setFileName().

◆ myIgnoreErrors

bool RODFDetectorHandler::myIgnoreErrors

private

whether to ignore errors on parsing

Definition at line 68 of file RODFDetectorHandler.h.

Referenced by myStartElement(), and RODFDetectorHandler().

◆ myNet

RODFNet* RODFDetectorHandler::myNet

private

the net

Definition at line 65 of file RODFDetectorHandler.h.

Referenced by myStartElement(), and RODFDetectorHandler().

◆ myNextSectionStart

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

privateinherited

Definition at line 356 of file GenericSAXHandler.h.

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

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler

privateinherited

The handler to give control back to.

Definition at line 327 of file GenericSAXHandler.h.

Referenced by callParentEnd(), endElement(), GenericSAXHandler(), and 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 endElement(), GenericSAXHandler(), and registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags

privateinherited

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), startElement(), and ~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(), and 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 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 endElement(), setSection(), and 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 sectionFinished(), setSection(), and 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 endElement(), setSection(), and 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 setSection(), and startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap

privateinherited

Definition at line 320 of file GenericSAXHandler.h.

Referenced by convertTag(), and GenericSAXHandler().

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

Public Member Functions

inherited from GenericSAXHandler

attributes parsing

elements parsing

SAX ErrorHandler callbacks

Detailed Description

Member Typedef Documentation

◆ AttrMap

◆ TagMap

Constructor & Destructor Documentation

◆ RODFDetectorHandler() [1/2]

◆ ~RODFDetectorHandler()

◆ RODFDetectorHandler() [2/2]

Member Function Documentation

◆ buildErrorMessage()

◆ callParentEnd()

◆ characters()

◆ convert()

◆ convertTag()

◆ endElement()

◆ error()

◆ fatalError()

◆ getFileName()

◆ myCharacters()

◆ myEndElement()

◆ myStartElement()

◆ needsCharacterData()

◆ operator=()

◆ registerParent()

◆ retrieveNextSectionStart()

◆ sectionFinished()

◆ setFileName()

◆ setSection()

◆ startElement()

◆ warning()

Field Documentation

◆ myCharactersVector

◆ myCollectCharacterData

◆ myContainer

◆ myExpectedRoot

◆ myFileName

◆ myIgnoreErrors

◆ myNet

◆ myNextSectionStart

◆ myParentHandler

◆ myParentIndicator

◆ myPredefinedTags

◆ myPredefinedTagsMML

◆ myRootSeen

◆ mySection

◆ mySectionEnded

◆ mySectionOpen

◆ mySectionSeen

◆ myTagMap