SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RORDLoader_SUMOBase Class Reference

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

#include <RORDLoader_SUMOBase.h>

Inheritance diagram for RORDLoader_SUMOBase:
ROTypedXMLRoutesLoader SUMOSAXHandler GenericSAXHandler DefaultHandler

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.
bool ended () const
 Returns the information whether no routes are available from this loader anymore.
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
SUMOTime getLastReadTimeStep () const
 Returns the time the current (last read) route starts at.
virtual bool readRoutesAtLeastUntil (SUMOTime time)
 Adds routes from the file until the given time is reached.
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 int maxRouteNumber, const bool tryRepair, const bool withTaz, const bool keepRoutes, const bool skipRouteCalculation, 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.
 ~RORDLoader_SUMOBase ()
 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.
bool closeVehicle ()
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)
 Called on the opening of a tag;.
void myCharacters (int element, const std::string &chars)
 Called when characters occure.
virtual void myEndElement (int element)
 Called when a closing tag occurs.

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.
RGBColormyColor
 The color of the current route/vehicle.
SUMOReal myCost
 The costs of the current alternative.
RORouteDef_AlternativesmyCurrentAlternatives
 The currently parsed route alternatives.
SUMOTime myCurrentDepart
 The currently read vehicle's depart.
bool myCurrentIsOk
 Information whether the currently parsed item is valid.
RORouteDef_CompletemyCurrentRoute
 The currently parsed route.
std::string myCurrentRouteName
 The name of the currently parsed route.
SUMOVTypeParametermyCurrentVType
 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.
bool myHaveWarnedAboutDeprecatedRoute
bool myHaveWarnedAboutDeprecatedVType
const bool myKeepRoutes
 Information whether all routes should be saved.
int myMaxRouteNumber
 The maximum route alternatives number.
RONetmyNet
 The network to add routes to.
bool myNextRouteRead
 The information whether the next route was read.
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.
SUMOVehicleParametermyVehicleParameter
 The parsed vehicle parameter.
const bool myWithTaz
 Information whether zones (districts) are used as origins / destinations.

Private Member Functions

RORDLoader_SUMOBaseoperator= (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 64 of file RORDLoader_SUMOBase.h.

Constructor & Destructor Documentation

RORDLoader_SUMOBase::RORDLoader_SUMOBase ( RONet net,
SUMOTime  begin,
SUMOTime  end,
const int  maxRouteNumber,
const bool  tryRepair,
const bool  withTaz,
const bool  keepRoutes,
const bool  skipRouteCalculation,
const std::string &  file = "" 
)

Constructor.

Definition at line 55 of file RORDLoader_SUMOBase.cpp.

RORDLoader_SUMOBase::~RORDLoader_SUMOBase ( )

Destructor.

Definition at line 68 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

std::string GenericSAXHandler::buildErrorMessage ( const 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]exceptionThe 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 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 83 of file ROTypedXMLRoutesLoader.cpp.

References ROTypedXMLRoutesLoader::myEnded.

bool ROTypedXMLRoutesLoader::ended ( ) const
inlineinherited

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

Returns
Whether the whole input has been processed

Definition at line 102 of file ROTypedXMLRoutesLoader.h.

References ROTypedXMLRoutesLoader::myEnded.

Referenced by ROTypedXMLRoutesLoader::readRoutesAtLeastUntil().

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]exceptionThe occured exception to process
Exceptions
ProcessErrorOn 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
ProcessErrorOn any call
Parameters
[in]exceptionThe occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

SUMOTime ROTypedXMLRoutesLoader::getLastReadTimeStep ( ) const
inlineinherited

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

Returns
The least time step that was read by this reader

Definition at line 93 of file ROTypedXMLRoutesLoader.h.

References ROTypedXMLRoutesLoader::myCurrentDepart.

Referenced by ROTypedXMLRoutesLoader::readRoutesAtLeastUntil().

void RORDLoader_SUMOBase::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtual
void RORDLoader_SUMOBase::myEndElement ( int  element)
protectedvirtual
void RORDLoader_SUMOBase::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual
RORDLoader_SUMOBase& RORDLoader_SUMOBase::operator= ( const RORDLoader_SUMOBase src)
private

Invalidated assignment operator.

bool ROTypedXMLRoutesLoader::readRoutesAtLeastUntil ( SUMOTime  time)
virtualinherited

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

Parameters
[in]timeThe time until which route definitions shall be loaded
Returns
Whether any errors occured
Exceptions
ProcessErrorIf a major error occured
See Also
ROAbstractRouteDefLoader::readRoutesAtLeastUntil

Reimplemented in RORDGenerator_ODAmounts.

Definition at line 71 of file ROTypedXMLRoutesLoader.cpp.

References ROTypedXMLRoutesLoader::ended(), ROTypedXMLRoutesLoader::getLastReadTimeStep(), ROTypedXMLRoutesLoader::myNextRouteRead, ROTypedXMLRoutesLoader::myParser, and ROTypedXMLRoutesLoader::myToken.

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
void RORDLoader_SUMOBase::startAlternative ( const SUMOSAXAttributes attrs)
protected
void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const 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 105 of file GenericSAXHandler.cpp.

References GenericSAXHandler::convertTag(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myPredefinedTags, GenericSAXHandler::myPredefinedTagsMML, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, and SUMO_TAG_INCLUDE.

void GenericSAXHandler::warning ( const SAXParseException &  exception)
inherited

Handler for XML-warnings.

The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.

Parameters
[in]exceptionThe occured exception to process

Definition at line 206 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

bool RORDLoader_SUMOBase::myAltIsValid
protected

Information whether the currently parsed alternatives set is valid.

Definition at line 133 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), myEndElement(), myStartElement(), and startRoute().

SUMOTime ROTypedXMLRoutesLoader::myBegin
protectedinherited

The time for which the first route shall be loaded.

Definition at line 119 of file ROTypedXMLRoutesLoader.h.

Referenced by closeVehicle(), RORDGenerator_ODAmounts::myEndFlowAmountDef(), and RORDGenerator_ODAmounts::readRoutesAtLeastUntil().

RGBColor* RORDLoader_SUMOBase::myColor
protected

The color of the current route/vehicle.

Definition at line 127 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), startRoute(), and ~RORDLoader_SUMOBase().

SUMOReal RORDLoader_SUMOBase::myCost
protected

The costs of the current alternative.

Definition at line 139 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), and startRoute().

RORouteDef_Alternatives* RORDLoader_SUMOBase::myCurrentAlternatives
protected

The currently parsed route alternatives.

Definition at line 136 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), myEndElement(), startAlternative(), startRoute(), and ~RORDLoader_SUMOBase().

SUMOTime ROTypedXMLRoutesLoader::myCurrentDepart
protectedinherited
bool RORDLoader_SUMOBase::myCurrentIsOk
protected

Information whether the currently parsed item is valid.

Definition at line 130 of file RORDLoader_SUMOBase.h.

Referenced by closeVehicle(), myCharacters(), myEndElement(), myStartElement(), startAlternative(), and startRoute().

RORouteDef_Complete* RORDLoader_SUMOBase::myCurrentRoute
protected

The currently parsed route.

Definition at line 160 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), myEndElement(), and ~RORDLoader_SUMOBase().

std::string RORDLoader_SUMOBase::myCurrentRouteName
protected

The name of the currently parsed route.

Definition at line 163 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), and startRoute().

SUMOVTypeParameter* RORDLoader_SUMOBase::myCurrentVType
protected

The currently parsed vehicle type.

Definition at line 166 of file RORDLoader_SUMOBase.h.

Referenced by myEndElement(), and myStartElement().

SUMOTime ROTypedXMLRoutesLoader::myEnd
protectedinherited

The time for which the first route shall be loaded.

Definition at line 122 of file ROTypedXMLRoutesLoader.h.

Referenced by RORDGenerator_ODAmounts::buildForTimeStep(), closeVehicle(), and RORDLoader_TripDefs::myEndElement().

bool ROTypedXMLRoutesLoader::myEnded
protectedinherited

Information whether the whole file has been parsed.

Definition at line 137 of file ROTypedXMLRoutesLoader.h.

Referenced by RORDGenerator_ODAmounts::buildForTimeStep(), ROTypedXMLRoutesLoader::endDocument(), and ROTypedXMLRoutesLoader::ended().

bool RORDLoader_SUMOBase::myHaveWarnedAboutDeprecatedRoute
protected

Definition at line 169 of file RORDLoader_SUMOBase.h.

Referenced by startRoute().

bool RORDLoader_SUMOBase::myHaveWarnedAboutDeprecatedVType
protected

Definition at line 168 of file RORDLoader_SUMOBase.h.

Referenced by myStartElement().

const bool RORDLoader_SUMOBase::myKeepRoutes
protected

Information whether all routes should be saved.

Definition at line 154 of file RORDLoader_SUMOBase.h.

Referenced by startAlternative().

int RORDLoader_SUMOBase::myMaxRouteNumber
protected

The maximum route alternatives number.

Definition at line 145 of file RORDLoader_SUMOBase.h.

Referenced by startAlternative().

bool ROTypedXMLRoutesLoader::myNextRouteRead
protectedinherited
SUMOReal RORDLoader_SUMOBase::myProbability
protected

The probability of the current alternative's usage.

Definition at line 142 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters(), and startRoute().

const bool RORDLoader_SUMOBase::mySkipRouteCalculation
protected

Information whether new routes should be calculated.

Definition at line 157 of file RORDLoader_SUMOBase.h.

Referenced by startAlternative().

XMLPScanToken ROTypedXMLRoutesLoader::myToken
protectedinherited
bool RORDLoader_SUMOBase::myTryRepair
protected

Information whether a read route shall be tried to be repaired.

Definition at line 148 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters().

SUMOVehicleParameter* RORDLoader_SUMOBase::myVehicleParameter
protected

The parsed vehicle parameter.

Definition at line 124 of file RORDLoader_SUMOBase.h.

Referenced by closeVehicle(), myCharacters(), myEndElement(), myStartElement(), startAlternative(), startRoute(), and ~RORDLoader_SUMOBase().

const bool RORDLoader_SUMOBase::myWithTaz
protected

Information whether zones (districts) are used as origins / destinations.

Definition at line 151 of file RORDLoader_SUMOBase.h.

Referenced by myCharacters().


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