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

Base class for loading routes from XML-files. More...

#include <ROTypedXMLRoutesLoader.h>

Inheritance diagram for ROTypedXMLRoutesLoader:
SUMOSAXHandler GenericSAXHandler DefaultHandler RORDLoader_SUMOBase RORDLoader_TripDefs RORDGenerator_ODAmounts

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.
 ROTypedXMLRoutesLoader (RONet &net, SUMOTime begin, SUMOTime end, 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 ~ROTypedXMLRoutesLoader ()
 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.
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Callback method for an opening tag to implement by derived classes.

Protected Attributes

SUMOTime myBegin
 The time for which the first route shall be loaded.
SUMOTime myCurrentDepart
 The currently read vehicle's depart.
SUMOTime myEnd
 The time for which the first route shall be loaded.
bool myEnded
 Information whether the whole file has been parsed.
RONetmyNet
 The network to add routes to.
bool myNextRouteRead
 The information whether the next route was read.
SAX2XMLReader * myParser
 The parser used.
XMLPScanToken myToken
 Information about the current position within the file.

Private Member Functions

ROTypedXMLRoutesLoaderoperator= (const ROTypedXMLRoutesLoader &src)
 Invalidated assignment operator.
 ROTypedXMLRoutesLoader (const ROTypedXMLRoutesLoader &src)
 Invalidated copy constructor.

Detailed Description

Base class for loading routes from XML-files.

Base class for loaders which load route definitions which use XML-derived formats. Some methods as the initialisation and the file processing, together with the need for a parser are common to all such loaders.

Todo:
recheck/refactor

Definition at line 60 of file ROTypedXMLRoutesLoader.h.


Constructor & Destructor Documentation

ROTypedXMLRoutesLoader::ROTypedXMLRoutesLoader ( RONet net,
SUMOTime  begin,
SUMOTime  end,
const std::string &  file = "" 
)

Constructor.

Parameters:
[in]vbThe vehicle builder to use
[in]netThe network to add vehicles to
[in]beginThe time step import shall start at
[in]endThe time step import shall stop at
[in]fileName of the used input file
Exceptions:
ProcessErrorIf an error occured during initialisation of parsing the xml-file

Definition at line 50 of file ROTypedXMLRoutesLoader.cpp.

References GenericSAXHandler::getFileName(), XMLSubSys::getSAXReader(), myParser, and myToken.

ROTypedXMLRoutesLoader::~ROTypedXMLRoutesLoader ( )
virtual

Destructor.

Definition at line 65 of file ROTypedXMLRoutesLoader.cpp.

References myParser.

ROTypedXMLRoutesLoader::ROTypedXMLRoutesLoader ( const ROTypedXMLRoutesLoader 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 ( )

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 myEnded.

bool ROTypedXMLRoutesLoader::ended ( ) const
inline

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 myEnded.

Referenced by 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
inline

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 myCurrentDepart.

Referenced by readRoutesAtLeastUntil().

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtualinherited

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

Parameters:
[in]elementThe opened element, given as a int
[in]charsThe complete embedded character string ProcessError These method may throw a ProcessError if something fails

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

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void GenericSAXHandler::myEndElement ( int  element)
protectedvirtualinherited
ROTypedXMLRoutesLoader& ROTypedXMLRoutesLoader::operator= ( const ROTypedXMLRoutesLoader src)
private

Invalidated assignment operator.

bool ROTypedXMLRoutesLoader::readRoutesAtLeastUntil ( SUMOTime  time)
virtual

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 ended(), getLastReadTimeStep(), myNextRouteRead, myParser, and 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 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

SUMOTime ROTypedXMLRoutesLoader::myBegin
protected

The time for which the first route shall be loaded.

Definition at line 119 of file ROTypedXMLRoutesLoader.h.

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

SUMOTime ROTypedXMLRoutesLoader::myEnd
protected

The time for which the first route shall be loaded.

Definition at line 122 of file ROTypedXMLRoutesLoader.h.

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

bool ROTypedXMLRoutesLoader::myEnded
protected

Information whether the whole file has been parsed.

Definition at line 137 of file ROTypedXMLRoutesLoader.h.

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

bool ROTypedXMLRoutesLoader::myNextRouteRead
protected
SAX2XMLReader* ROTypedXMLRoutesLoader::myParser
protected
XMLPScanToken ROTypedXMLRoutesLoader::myToken
protected

Information about the current position within the file.

Definition at line 128 of file ROTypedXMLRoutesLoader.h.

Referenced by readRoutesAtLeastUntil(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), and ROTypedXMLRoutesLoader().


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