The base class for SUMO-native route handlers. More...

#include <RORDLoader_SUMOBase.h>

Inheritance diagram for RORDLoader_SUMOBase:

Public Member Functions
void	characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
	The inherited method called when characters occured.
void	endDocument ()
	Called when the document has ended.
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.
	RORDLoader_SUMOBase (RONet &net, SUMOTime begin, SUMOTime end, const SUMOReal beta, const SUMOReal gawronA, const SUMOReal logitGamma, const int maxRouteNumber, const bool tryRepair, const bool withTaz, const bool keepRoutes, const bool skipRouteCalculation, const std::string &file="") throw (ProcessError)
	Constructor.
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.
	~RORDLoader_SUMOBase () throw ()
	Destructor.
inherited from ROAbstractRouteDefLoader
SUMOTime	getLastReadTimeStep () const throw ()
	Returns the time the current (last read) route starts at.
inherited from ROAbstractRouteDefLoader
bool	readRoutesAtLeastUntil (SUMOTime time, bool skipping) throw (ProcessError)
	Adds routes from the file until the given time is reached.
bool	ended () const throw ()
	Returns the information whether no routes are available from this loader anymore.
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.
bool	closeVehicle () throw ()
void	startAlternative (const SUMOSAXAttributes &attrs)
	Begins the parsing of the next route alternative in the file.
void	startRoute (const SUMOSAXAttributes &attrs)
	Begins the parsing of a route alternative of the opened route.
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.
virtual void	myEndElement (int element) throw (ProcessError)
	Called when a closing tag occurs.
inherited from ROTypedXMLRoutesLoader
bool	nextRouteRead () throw ()
void	beginNextRoute () throw ()
	Returns Initialises the reading of a further route.
Protected Attributes
bool	myAltIsValid
	Information whether the currently parsed alternatives set is valid.
SUMOTime	myBegin
	The time for which the first route shall be loaded.
const SUMOReal	myBeta
	gawron or logit beta - value
RGBColor *	myColor
	The color of the current route/vehicle.
SUMOReal	myCost
	The costs of the current alternative.
RORouteDef_Alternatives *	myCurrentAlternatives
	The currently parsed route alternatives.
SUMOTime	myCurrentDepart
	The currently read vehicle's depart.
bool	myCurrentIsOk
	Information whether the currently parsed item is valid.
RORouteDef_Complete *	myCurrentRoute
	The currently parsed route.
std::string	myCurrentRouteName
	The name of the currently parsed route.
SUMOVTypeParameter *	myCurrentVType
	The currently parsed vehicle type.
SUMOTime	myEnd
	The time for which the first route shall be loaded.
bool	myEnded
	Information whether the whole file has been parsed.
const SUMOReal	myGawronA
	gawron a - value
bool	myHaveNextRoute
	Information whether a further route has been read.
bool	myHaveWarnedAboutDeprecatedRoute
bool	myHaveWarnedAboutDeprecatedVType
const bool	myKeepRoutes
	Information whether all routes should be saved.
const SUMOReal	myLogitGamma
	logit gamma - value
int	myMaxRouteNumber
	The maximum route alternatives number.
RONet &	myNet
	The network to add routes to.
SAX2XMLReader *	myParser
	The parser used.
SUMOReal	myProbability
	The probability of the current alternative's usage.
const bool	mySkipRouteCalculation
	Information whether new routes should be calculated.
XMLPScanToken	myToken
	Information about the current position within the file.
bool	myTryRepair
	Information whether a read route shall be tried to be repaired.
SUMOVehicleParameter *	myVehicleParameter
	The parsed vehicle parameter.
const bool	myWithTaz
	Information whether zones (districts) are used as origins / destinations.
Private Member Functions
RORDLoader_SUMOBase &	operator= (const RORDLoader_SUMOBase &src)
	Invalidated assignment operator.
	RORDLoader_SUMOBase (const RORDLoader_SUMOBase &src)
	Invalidated copy constructor.

Detailed Description

The base class for SUMO-native route handlers.

As both the SUMO-routes and the SUMO-route alternatives handlers share a set of processing functions, we've joined these functions within a single class (this one).

Definition at line 61 of file RORDLoader_SUMOBase.h.

Constructor & Destructor Documentation

RORDLoader_SUMOBase::RORDLoader_SUMOBase	(	RONet &	net,
		SUMOTime	begin,
		SUMOTime	end,
		const SUMOReal	beta,
		const SUMOReal	gawronA,
		const SUMOReal	logitGamma,
		const int	maxRouteNumber,
		const bool	tryRepair,
		const bool	withTaz,
		const bool	keepRoutes,
		const bool	skipRouteCalculation,
		const std::string &	file = `""`
	)		throw (ProcessError)

Constructor.

Definition at line 52 of file RORDLoader_SUMOBase.cpp.

RORDLoader_SUMOBase::~RORDLoader_SUMOBase ( ) throw ()

Destructor.

Definition at line 67 of file RORDLoader_SUMOBase.cpp.

References myColor, myCurrentAlternatives, myCurrentRoute, and myVehicleParameter.

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

Invalidated copy constructor.

Member Function Documentation

void RORDLoader_SUMOBase::beginNextRoute ( ) throw () [protected, virtual]

Returns Initialises the reading of a further route.

Todo:: recheck/refactor

See also:: ROTypedXMLRoutesLoader::beginNextRoute

Implements ROTypedXMLRoutesLoader.

Definition at line 350 of file RORDLoader_SUMOBase.cpp.

References myHaveNextRoute.

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.

bool RORDLoader_SUMOBase::closeVehicle ( ) throw () [protected]

Definition at line 321 of file RORDLoader_SUMOBase.cpp.

References RONet::addVehicle(), SUMOVehicleParameter::depart, MsgHandler::getErrorInstance(), RONet::getRouteDef(), RONet::getVehicleTypeSecure(), SUMOVehicleParameter::id, ROAbstractRouteDefLoader::myBegin, myCurrentIsOk, ROAbstractRouteDefLoader::myEnd, ROAbstractRouteDefLoader::myNet, myVehicleParameter, SUMOVehicleParameter::routeid, SUMOVehicleParameter::vtypeid, and WRITE_ERROR.

void ROTypedXMLRoutesLoader::endDocument ( ) [inherited]

Called when the document has ended.

Todo:: Recheck usage of route loaders; it is not very fine to have one that use a parser and other that do not

Definition at line 84 of file ROTypedXMLRoutesLoader.cpp.

References ROTypedXMLRoutesLoader::myEnded.

bool ROTypedXMLRoutesLoader::ended ( ) const throw () [inline, virtual, inherited]

Returns the information whether no routes are available from this loader anymore.

Returns:: Whether the whole input has been processed

Implements ROAbstractRouteDefLoader.

Definition at line 97 of file ROTypedXMLRoutesLoader.h.

References ROTypedXMLRoutesLoader::myEnded.

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

SUMOTime RORDLoader_SUMOBase::getLastReadTimeStep ( ) const throw () [inline, virtual]

Returns the time the current (last read) route starts at.

Returns:: The least time step that was read by this reader

Implements ROAbstractRouteDefLoader.

Definition at line 83 of file RORDLoader_SUMOBase.h.

References myCurrentDepart.

void RORDLoader_SUMOBase::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 204 of file RORDLoader_SUMOBase.cpp.

References ROEdge::getID(), StringTokenizer::hasNext(), StringTokenizer::next(), SUMO_TAG_ROUTE, VEHPARS_TAZ_SET, and WRITE_ERROR.

Referenced by startRoute().

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

Called when a closing tag occurs.

Parameters:

[in] element ID of the currently opened element

Exceptions:

ProcessError If something fails

See also:: GenericSAXHandler::myEndElement

Reimplemented from GenericSAXHandler.

Definition at line 271 of file RORDLoader_SUMOBase.cpp.

References SUMOVehicleParserHelper::closeVTypeParsing(), SUMO_TAG_ROUTE, SUMO_TAG_ROUTE_DISTRIBUTION, SUMO_TAG_VEHICLE, SUMO_TAG_VTYPE, and SUMO_TAG_VTYPE__DEPRECATED.

void RORDLoader_SUMOBase::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 77 of file RORDLoader_SUMOBase.cpp.

References SUMOVehicleParserHelper::beginVTypeParsing(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMOVehicleParserHelper::parseVTypeEmbedded(), SUMO_TAG_ROUTE, SUMO_TAG_ROUTE_DISTRIBUTION, SUMO_TAG_VEHICLE, SUMO_TAG_VTYPE, SUMO_TAG_VTYPE__DEPRECATED, toString(), and WRITE_WARNING.

bool RORDLoader_SUMOBase::nextRouteRead ( ) throw () [inline, protected, virtual]

Returns the information whether a route was read

Returns:: Whether a further route was read

See also:: ROTypedXMLRoutesLoader::nextRouteRead

Implements ROTypedXMLRoutesLoader.

Definition at line 142 of file RORDLoader_SUMOBase.h.

References myHaveNextRoute.

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

Invalidated assignment operator.

bool ROTypedXMLRoutesLoader::readRoutesAtLeastUntil	(	SUMOTime	time,
		bool	skipping
	)		throw (ProcessError) `[virtual, inherited]`

Adds routes from the file until the given time is reached.

Parameters:

[in]	time	The time until which route definitions shall be loaded
[in]	skipping	Whether routes shall not be added

Returns:: Whether any errors occured

Exceptions:

ProcessError If a major error occured

See also:: ROAbstractRouteDefLoader::readRoutesAtLeastUntil

Implements ROAbstractRouteDefLoader.

Reimplemented in RORDGenerator_ODAmounts.

Definition at line 71 of file ROTypedXMLRoutesLoader.cpp.

References UNUSED_PARAMETER.

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 RORDLoader_SUMOBase::startAlternative ( const SUMOSAXAttributes & attrs ) [protected]

Begins the parsing of the next route alternative in the file.

Definition at line 173 of file RORDLoader_SUMOBase.cpp.

References SUMOSAXAttributes::getIntReporting(), SUMOSAXAttributes::getStringReporting(), SUMOVehicleParameter::id, myBeta, myCurrentAlternatives, myCurrentIsOk, myGawronA, myKeepRoutes, myLogitGamma, myMaxRouteNumber, mySkipRouteCalculation, myVehicleParameter, SUMO_ATTR_ID, SUMO_ATTR_LAST, and WRITE_ERROR.

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