A reader for a SUMO network's projection description. More...

#include <PCNetProjectionLoader.h>

Inheritance diagram for PCNetProjectionLoader:

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
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.
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.
Static Public Member Functions
static void	loadIfSet (OptionsCont &oc, Position &netOffset, Boundary &origNetBoundary, Boundary &convNetBoundary, std::string &projParameter) throw (ProcessError)
	Loads network projection if wished.
Protected Member Functions
std::string	buildErrorMessage (const SAXParseException &exception) throw ()
	Builds an error message.
bool	hasReadAll () const throw ()
	Returns whether all needed values were read.
virtual void	myEndElement (int element)
	Callback method for a closing tag to implement by derived classes.
	PCNetProjectionLoader (Position &netOffset, Boundary &origNetBoundary, Boundary &convNetBoundary, std::string &projParameter) throw ()
	Constructor.
	~PCNetProjectionLoader () throw ()
	Destructor.
inherited from GenericSAXHandler
virtual void	myStartElement (int element, const SUMOSAXAttributes &attrs) throw (ProcessError)
	Called on the opening of a tag;.
void	myCharacters (int element, const std::string &chars) throw (ProcessError)
	Called when characters occure.
Private Attributes
Boundary &	myConvNetBoundary
	The converted network boundary to fill from values read from the network.
bool	myFoundConvNetBoundary
bool	myFoundOffset
	Information whether the parameter was read.
bool	myFoundOrigNetBoundary
bool	myFoundProj
Position &	myNetOffset
	The network offset to fill from values read from the network.
Boundary &	myOrigNetBoundary
	The original network boundary to fill from values read from the network.
std::string &	myProjParameter
	The projection parameter to fill from values read from the network.

Detailed Description

A reader for a SUMO network's projection description.

Definition at line 51 of file PCNetProjectionLoader.h.

Constructor & Destructor Documentation

PCNetProjectionLoader::PCNetProjectionLoader	(	Position &	netOffset,
		Boundary &	origNetBoundary,
		Boundary &	convNetBoundary,
		std::string &	projParameter
	)		throw () `[protected]`

Constructor.

Parameters:

[out]	netOffset	The network offset to fill from values read from the network
[out]	origNetBoundary	The original network boundary to fill from values read from the network
[out]	convNetBoundary	The converted network boundary to fill from values read from the network
[out]	projParameter	The projection parameter to fill from values read from the network

Definition at line 98 of file PCNetProjectionLoader.cpp.

PCNetProjectionLoader::~PCNetProjectionLoader ( ) throw () [protected]

Destructor.

Definition at line 108 of file PCNetProjectionLoader.cpp.

Member Function Documentation

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 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(), loadIfSet(), NILoader::loadXMLType(), MSTriggeredXMLReader::myInit(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), and GenericSAXHandler::startElement().

bool PCNetProjectionLoader::hasReadAll ( ) const throw () [protected]

Returns whether all needed values were read.

Returns:: Whether all needed values were read

Definition at line 144 of file PCNetProjectionLoader.cpp.

References myFoundConvNetBoundary, myFoundOffset, myFoundOrigNetBoundary, and myFoundProj.

Referenced by loadIfSet().

void PCNetProjectionLoader::loadIfSet	(	OptionsCont &	oc,
		Position &	netOffset,
		Boundary &	origNetBoundary,
		Boundary &	convNetBoundary,
		std::string &	projParameter
	)		throw (ProcessError) `[static]`

Loads network projection if wished.

If the option "net" is set within the given options container, an instance of PCNetProjectionLoader is built and used as a handler for the file given in this option.

Parameters:

[in]	oc	The options container to get further options from
[out]	netOffset	The network offset to fill from values read from the network
[out]	origNetBoundary	The original network boundary to fill from values read from the network
[out]	convNetBoundary	The converted network boundary to fill from values read from the network
[out]	projParameter	The projection parameter to fill from values read from the network

Exceptions:

ProcessError if something fails

Definition at line 61 of file PCNetProjectionLoader.cpp.

References FileHelpers::exists(), GenericSAXHandler::getFileName(), XMLSubSys::getSAXReader(), hasReadAll(), PROGRESS_BEGIN_MESSAGE, PROGRESS_DONE_MESSAGE, and GenericSAXHandler::setFileName().

Referenced by main().

void PCNetProjectionLoader::myCharacters	(	int	element,
		const std::string &	chars
	)		throw (ProcessError) `[protected, virtual]`

Called when characters occure.

Parameters:

[in]	element	ID of the last opened element
[in]	chars	The read characters (complete)

Exceptions:

ProcessError If something fails

See also:: GenericSAXHandler::myCharacters

Reimplemented from GenericSAXHandler.

Definition at line 136 of file PCNetProjectionLoader.cpp.

References UNUSED_PARAMETER.

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, and SAXWeightsHandler.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void PCNetProjectionLoader::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)		throw (ProcessError) `[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 112 of file PCNetProjectionLoader.cpp.

References GeomConvHelper::parseBoundaryReporting(), GeomConvHelper::parseShapeReporting(), SUMO_ATTR_CONV_BOUNDARY, SUMO_ATTR_NET_OFFSET, SUMO_ATTR_ORIG_BOUNDARY, SUMO_ATTR_ORIG_PROJ, and SUMO_TAG_LOCATION.

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(), 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]`