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

#include <RODFDetectorHandler.h>

Inheritance diagram for RODFDetectorHandler:

Public Member Functions
void	characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
	The inherited method called when characters occured.
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 Attributes &attrs)
	The inherited method called when a new tag opens.
virtual	~RODFDetectorHandler ()
	Destructor.
SAX ErrorHandler callbacks
void	warning (const SAXParseException &exception)
	Handler for XML-warnings.
void	error (const SAXParseException &exception)
	Handler for XML-errors.
void	fatalError (const SAXParseException &exception)
	Handler for XML-errors.
Protected Member Functions
std::string	buildErrorMessage (const 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.
inherited from GenericSAXHandler
void	myStartElement (int element, const SUMOSAXAttributes &attrs)
	Called on the opening of a tag;.
Private Member Functions
RODFDetectorHandler &	operator= (const RODFDetectorHandler &src)
	invalidated assignment operator
	RODFDetectorHandler (const RODFDetectorHandler &src)
	invalidated copy constructor
Private Attributes
RODFDetectorCon &	myContainer
	the container to put the detectors into
bool	myHaveWarnedAboutDeprecatedDetectorDefinition
bool	myIgnoreErrors
	whether to ignore errors on parsing
RODFNet *	myNet
	the net

Detailed Description

SAX2-Handler for loading DFROUTER-detector definitions.

Definition at line 49 of file RODFDetectorHandler.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 54 of file RODFDetectorHandler.cpp.

RODFDetectorHandler::~RODFDetectorHandler ( ) [virtual]

Destructor.

Definition at line 61 of file RODFDetectorHandler.cpp.

RODFDetectorHandler::RODFDetectorHandler ( const RODFDetectorHandler & src ) [private]

invalidated copy constructor

Member Function Documentation

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException & exception ) [protected, inherited]

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 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 GenericSAXHandler::myCharactersVector.

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 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 SAXParseException & exception ) [inherited]

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters:

[in] exception The occured exception to process

Exceptions:

ProcessError On any call

Definition at line 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by NLHandler::getLanesFromIndices().

void GenericSAXHandler::fatalError ( const 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 occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

const std::string & GenericSAXHandler::getFileName ( ) const [inherited]

returns the current file name

Returns:: The name of the currently processed file

Definition at line 86 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), GenericSAXHandler::buildErrorMessage(), MSRouteLoader::init(), PCNetProjectionLoader::loadIfSet(), NILoader::loadXMLType(), MSTriggeredXMLReader::myInit(), myStartElement(), NLHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), GUISettingsHandler::myStartElement(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), ROTypedXMLRoutesLoader::ROTypedXMLRoutesLoader(), XMLSubSys::runParser(), and GenericSAXHandler::startElement().

void GenericSAXHandler::myCharacters	(	int	element,
		const std::string &	chars
	)		`[protected, virtual, inherited]`

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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in ROJTRTurnDefLoader, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_SUMO, PCLoaderXML, PCNetProjectionLoader, and RORDLoader_SUMOBase.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void GenericSAXHandler::myEndElement ( int element ) [protected, virtual, inherited]

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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in MSRouteHandler, MSLaneSpeedTrigger, MSTriggeredRerouter, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_SUMO, NIXMLEdgesHandler, NIXMLTrafficLightsHandler, NLHandler, ODDistrictHandler, PCLoaderOSM::NodesHandler, PCLoaderOSM::EdgesHandler, RORDGenerator_ODAmounts, RORDLoader_SUMOBase, RORDLoader_TripDefs, SAXWeightsHandler, and SUMORouteHandler.

Definition at line 232 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void RODFDetectorHandler::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)		`[protected, virtual]`

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 65 of file RODFDetectorHandler.cpp.

References RODFDetectorCon::addDetector(), BETWEEN_DETECTOR, RONet::getEdge(), GenericSAXHandler::getFileName(), ROEdge::getLaneNo(), SUMOSAXAttributes::getOptStringReporting(), SUMOSAXAttributes::getStringReporting(), SUMOSAXAttributes::getSUMORealReporting(), myContainer, myHaveWarnedAboutDeprecatedDetectorDefinition, myIgnoreErrors, myNet, SINK_DETECTOR, SOURCE_DETECTOR, SUMO_ATTR_ID, SUMO_ATTR_LANE, SUMO_ATTR_POSITION, SUMO_ATTR_TYPE, SUMO_TAG_DETECTOR_DEFINITION, SUMO_TAG_DETECTOR_DEFINITION__DEPRECATED, SUMOReal, toString(), TYPE_NOT_DEFINED, and WRITE_WARNING.

RODFDetectorHandler& RODFDetectorHandler::operator= ( const RODFDetectorHandler & src ) [private]

invalidated assignment operator

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

References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

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

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), AGActivityGen::importInfoCity(), NIImporter_OpenStreetMap::load(), PCNetProjectionLoader::loadIfSet(), ROLoader::loadNet(), loadNet(), NIImporter_OpenDrive::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_ITSUMO::loadNetwork(), NILoader::loadXMLType(), and XMLSubSys::runParser().

void GenericSAXHandler::startElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname,
		const Attributes &	attrs
	)		`[inherited]`