An XML-Handler for districts. More...

#include <ODDistrictHandler.h>

Inheritance diagram for ODDistrictHandler:

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 throw ()
	returns the current file name
	ODDistrictHandler (ODDistrictCont &cont, const std::string &file) throw ()
	Constructor.
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) throw ()
	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.
	~ODDistrictHandler () throw ()
	Destructor.
SAX ErrorHandler callbacks
void	warning (const SAXParseException &exception) throw ()
	Handler for XML-warnings.
void	error (const SAXParseException &exception) throw (ProcessError)
	Handler for XML-errors.
void	fatalError (const SAXParseException &exception) throw (ProcessError)
	Handler for XML-errors.
Protected Member Functions
std::string	buildErrorMessage (const SAXParseException &exception) throw ()
	Builds an error message.
virtual void	myCharacters (int element, const std::string &chars)
	Callback method for characters to implement by derived classes.
inherited from GenericSAXHandler
void	myStartElement (int element, const SUMOSAXAttributes &attrs) throw (ProcessError)
	Called when an opening-tag occurs.
void	myEndElement (int element) throw (ProcessError)
	Called when a closing tag occurs.
Private Member Functions
void	addSink (const SUMOSAXAttributes &attrs) throw ()
	Adds a read sink to the current district.
void	addSource (const SUMOSAXAttributes &attrs) throw ()
	Adds a read source to the current district.
void	closeDistrict () throw ()
	Closes the processing of the current district.
	ODDistrictHandler (const ODDistrictHandler &s)
	invalidated copy constructor
void	openDistrict (const SUMOSAXAttributes &attrs) throw ()
	Begins the parsing of a district.
ODDistrictHandler &	operator= (const ODDistrictHandler &s)
	invalidated assignment operator
std::pair< std::string, SUMOReal >	parseConnection (const SUMOSAXAttributes &attrs) throw ()
	Returns the id and weight for a sink/source.
Private Attributes
ODDistrictCont &	myContainer
	The container to add read districts to.
ODDistrict *	myCurrentDistrict
	The currently parsed district.
bool	myHaveWarnedAboutDeprecatedDistrict
bool	myHaveWarnedAboutDeprecatedDSink
bool	myHaveWarnedAboutDeprecatedDSource

Detailed Description

An XML-Handler for districts.

This SUMOSAXHandler parses districts and their sinks and sources from and stores them into a the district container given at initialisation.

Definition at line 54 of file ODDistrictHandler.h.

Constructor & Destructor Documentation

ODDistrictHandler::ODDistrictHandler	(	ODDistrictCont &	cont,
		const std::string &	file
	)		throw ()

Constructor.

Saves the given district containe in order to fill it.

Parameters:

[in]	cont	The container of districts to fill
[in]	file	The file that will be processed

Definition at line 50 of file ODDistrictHandler.cpp.

ODDistrictHandler::~ODDistrictHandler ( ) throw ()

Destructor.

Definition at line 56 of file ODDistrictHandler.cpp.

ODDistrictHandler::ODDistrictHandler ( const ODDistrictHandler & s ) [private]

invalidated copy constructor

Member Function Documentation

void ODDistrictHandler::addSink ( const SUMOSAXAttributes & attrs ) throw () [private]

Adds a read sink to the current district.

Tries to get the id and the weight of the currently parsed sink from the attributes using getValues. If the retrieval could be done without errors (weight>=0), the so retrieved weighted sink is added to myCurrentDistrict using addSink. (getValues checks whether myCurrentDistrict is valid)

Parameters:

[in] attrs Attributes of the currently opened element

Todo:: Checking whether myCurrentDistrict is valid through getValues is not quite nice

Definition at line 124 of file ODDistrictHandler.cpp.

void ODDistrictHandler::addSource ( const SUMOSAXAttributes & attrs ) throw () [private]

Adds a read source to the current district.

Tries to get the id and the weight of the currently parsed source from the attributes using getValues. If the retrieval could be done without errors (weight>=0), the so retrieved weighted source is added to myCurrentDistrict using addSource. (getValues checks whether myCurrentDistrict is valid)

Parameters:

[in] attrs Attributes of the currently opened element

Todo:: Checking whether myCurrentDistrict is valid through getValues is not quite nice

Definition at line 115 of file ODDistrictHandler.cpp.

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException & exception ) throw () [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 189 of file GenericSAXHandler.cpp.

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

References GenericSAXHandler::myCharactersVector.

void ODDistrictHandler::closeDistrict ( ) throw () [private]

Closes the processing of the current district.

Adds myCurrentDistrict to myContainer.

Definition at line 160 of file ODDistrictHandler.cpp.

References NamedObjectCont< T >::add(), Named::getID(), myContainer, and myCurrentDistrict.

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 122 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 ) throw (ProcessError) [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 208 of file GenericSAXHandler.cpp.

Referenced by NLHandler::getLanesFromIndices().

void GenericSAXHandler::fatalError ( const SAXParseException & exception ) throw (ProcessError) [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 214 of file GenericSAXHandler.cpp.

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

returns the current file name

Returns:: The name of the currently processed file

Definition at line 82 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), MSRouteLoader::init(), PCNetProjectionLoader::loadIfSet(), NILoader::loadXMLType(), MSTriggeredXMLReader::myInit(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), 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 224 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void ODDistrictHandler::myEndElement ( int element ) throw (ProcessError) [protected, virtual]

Called when a closing tag occurs.

Processes district elements via closeDistrict.

Parameters:

[in] element ID of the currently opened element

Exceptions:

ProcessError If an error within the parsed file occurs

Reimplemented from GenericSAXHandler.

Definition at line 94 of file ODDistrictHandler.cpp.

References SUMO_TAG_DISTRICT__DEPRECATED, and SUMO_TAG_TAZ.

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

Called when an opening-tag occurs.

Processes district elements via openDistrict, their sinks (via addSink) and sources (via addSource).

Parameters:

[in]	element	The enum of the currently opened element
[in]	attrs	Attributes of the currently opened element

Exceptions:

ProcessError If an error within the parsed file occurs

See also:: GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 60 of file ODDistrictHandler.cpp.

References SUMO_TAG_DISTRICT__DEPRECATED, SUMO_TAG_DSINK__DEPRECATED, SUMO_TAG_DSOURCE__DEPRECATED, SUMO_TAG_TAZ, SUMO_TAG_TAZSINK, SUMO_TAG_TAZSOURCE, toString(), and WRITE_WARNING.

void ODDistrictHandler::openDistrict ( const SUMOSAXAttributes & attrs ) throw () [private]

Begins the parsing of a district.

Tries to retrieve the id of a district, adds a message to the error handler if this fails. Otherwise builds a new district with this id at myCurrentDistrict.

Parameters:

[in] attrs Attributes of the currently opened element

Definition at line 102 of file ODDistrictHandler.cpp.

References SUMO_ATTR_ID.

ODDistrictHandler& ODDistrictHandler::operator= ( const ODDistrictHandler & s ) [private]

invalidated assignment operator

std::pair< std::string, SUMOReal > ODDistrictHandler::parseConnection ( const SUMOSAXAttributes & attrs ) throw () [private]

Returns the id and weight for a sink/source.

Checks whether myCurrentDistrict (the currently processed district) is !=0; in this case, both the id and the weight are parsed. If one of them is missing or the weight is not numerical, an error is generated and reported to MsgHandler. The "type"-parameter is used in order to inform the user whether a source or a sink was processed. In the case of an error, the returned weight is -1.

If no error occurs, the correct id and weight are returned.

Parameters:

[in]	attrs	Attributes of the currently opened element
[in]	type	The type of the currntly processed connection (sink/source)

Returns:: The id and the weight of a connection

Definition at line 134 of file ODDistrictHandler.cpp.

References SUMO_ATTR_ID, SUMO_ATTR_WEIGHT, SUMOReal, and WRITE_ERROR.

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

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

Referenced by NLTriggerBuilder::parseAndBuildLaneSpeedTrigger().

void GenericSAXHandler::setFileName ( const std::string & name ) throw () [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 76 of file GenericSAXHandler.cpp.

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

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