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

Parser for routes during their loading. More...

#include <SUMORouteHandler.h>

Inheritance diagram for SUMORouteHandler:
SUMOSAXHandler GenericSAXHandler DefaultHandler MSRouteHandler NLHandler

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured.
bool checkStopPos (SUMOReal &startPos, SUMOReal &endPos, const SUMOReal laneLength, const SUMOReal minLength, const bool friendlyPos)
 check start and end position of a stop
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 getLastDepart () const
 Returns the last loaded depart time.
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)
 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.
 SUMORouteHandler (const std::string &file)
 standard constructor
virtual ~SUMORouteHandler ()
 standard 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

virtual void addStop (const SUMOSAXAttributes &attrs)=0
 Processing of a stop.
std::string buildErrorMessage (const SAXParseException &exception)
 Builds an error message.
bool checkLastDepart ()
 Checks whether the route file is sorted by departure time if needed.
virtual void closeFlow ()=0
 Ends the processing of a flow.
virtual void closePerson ()=0
 Ends the processing of a person.
virtual void closeRoute ()=0
virtual void closeRouteDistribution ()=0
virtual void closeVehicle ()=0
 Ends the processing of a vehicle.
virtual void closeVehicleTypeDistribution ()=0
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
virtual void openRoute (const SUMOSAXAttributes &attrs)=0
virtual void openRouteDistribution (const SUMOSAXAttributes &attrs)=0
virtual void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)=0
void registerLastDepart ()
 save last depart (only to be used if vehicle is not discarded)
inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.
virtual void myEndElement (int element)
 Called when a closing tag occurs.

Protected Attributes

RGBColor myActiveRouteColor
 The currently parsed route's color.
std::string myActiveRouteID
 The id of the current route.
SUMOReal myActiveRouteProbability
 The id of the current route.
std::string myActiveRouteRefID
 The id of the route the current route references to.
std::vector
< SUMOVehicleParameter::Stop
myActiveRouteStops
 List of the stops on the parsed route.
SUMOVTypeParametermyCurrentVType
 The currently parsed vehicle type.
SUMOTime myLastDepart
 The insertion time of the vehicle read last.
SUMOVehicleParametermyVehicleParameter
 Parameter of the current vehicle, trip, person, or flow.

Private Member Functions

SUMORouteHandleroperator= (const SUMORouteHandler &s)
 Invalidated assignment operator.
 SUMORouteHandler (const SUMORouteHandler &s)
 Invalidated copy constructor.

Detailed Description

Parser for routes during their loading.

SUMORouteHandler is the abstract super class for routers and simulation loading routes.

Definition at line 50 of file SUMORouteHandler.h.


Constructor & Destructor Documentation

SUMORouteHandler::SUMORouteHandler ( const std::string &  file)

standard constructor

Definition at line 54 of file SUMORouteHandler.cpp.

SUMORouteHandler::~SUMORouteHandler ( )
virtual

standard destructor

Definition at line 62 of file SUMORouteHandler.cpp.

SUMORouteHandler::SUMORouteHandler ( const SUMORouteHandler s)
private

Invalidated copy constructor.


Member Function Documentation

virtual void SUMORouteHandler::addStop ( const SUMOSAXAttributes attrs)
protectedpure virtual

Processing of a stop.

Implemented in MSRouteHandler.

Referenced by myStartElement().

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.

bool SUMORouteHandler::checkLastDepart ( )
protected
bool SUMORouteHandler::checkStopPos ( SUMOReal startPos,
SUMOReal endPos,
const SUMOReal  laneLength,
const SUMOReal  minLength,
const bool  friendlyPos 
)

check start and end position of a stop

Definition at line 178 of file SUMORouteHandler.cpp.

Referenced by MSRouteHandler::addStop().

virtual void SUMORouteHandler::closeFlow ( )
protectedpure virtual

Ends the processing of a flow.

Implemented in MSRouteHandler.

Referenced by myEndElement().

virtual void SUMORouteHandler::closePerson ( )
protectedpure virtual

Ends the processing of a person.

Implemented in MSRouteHandler.

Referenced by myEndElement().

virtual void SUMORouteHandler::closeRoute ( )
protectedpure virtual

closes (ends) the building of a route. Afterwards no edges may be added to it; this method may throw exceptions when a) the route is empty or b) another route with the same id already exists

Implemented in MSRouteHandler.

Referenced by myEndElement().

virtual void SUMORouteHandler::closeRouteDistribution ( )
protectedpure virtual

closes (ends) the building of a distribution

Implemented in MSRouteHandler.

Referenced by myEndElement().

virtual void SUMORouteHandler::closeVehicle ( )
protectedpure virtual

Ends the processing of a vehicle.

Implemented in MSRouteHandler.

Referenced by myEndElement().

virtual void SUMORouteHandler::closeVehicleTypeDistribution ( )
protectedpure virtual

closes (ends) the building of a distribution

Implemented in MSRouteHandler.

Referenced by myEndElement().

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

Returns the last loaded depart time.

Definition at line 67 of file SUMORouteHandler.cpp.

References myLastDepart.

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 SUMORouteHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual
virtual void SUMORouteHandler::openRoute ( const SUMOSAXAttributes attrs)
protectedpure virtual

opens a route for reading

Implemented in MSRouteHandler.

Referenced by myStartElement().

virtual void SUMORouteHandler::openRouteDistribution ( const SUMOSAXAttributes attrs)
protectedpure virtual

opens a route distribution for reading

Implemented in MSRouteHandler.

Referenced by myStartElement().

virtual void SUMORouteHandler::openVehicleTypeDistribution ( const SUMOSAXAttributes attrs)
protectedpure virtual

opens a type distribution for reading

Implemented in MSRouteHandler.

Referenced by myStartElement().

SUMORouteHandler& SUMORouteHandler::operator= ( const SUMORouteHandler s)
private

Invalidated assignment operator.

void SUMORouteHandler::registerLastDepart ( )
protected
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

RGBColor SUMORouteHandler::myActiveRouteColor
protected

The currently parsed route's color.

Definition at line 147 of file SUMORouteHandler.h.

Referenced by MSRouteHandler::closeRoute(), and MSRouteHandler::openRoute().

std::string SUMORouteHandler::myActiveRouteID
protected
SUMOReal SUMORouteHandler::myActiveRouteProbability
protected

The id of the current route.

Definition at line 144 of file SUMORouteHandler.h.

Referenced by MSRouteHandler::closeRoute(), and MSRouteHandler::openRoute().

std::string SUMORouteHandler::myActiveRouteRefID
protected

The id of the route the current route references to.

Definition at line 141 of file SUMORouteHandler.h.

Referenced by MSRouteHandler::closeRoute(), and MSRouteHandler::openRoute().

std::vector<SUMOVehicleParameter::Stop> SUMORouteHandler::myActiveRouteStops
protected

List of the stops on the parsed route.

Definition at line 150 of file SUMORouteHandler.h.

Referenced by MSRouteHandler::addStop(), and MSRouteHandler::closeRoute().

SUMOVTypeParameter* SUMORouteHandler::myCurrentVType
protected

The currently parsed vehicle type.

Definition at line 153 of file SUMORouteHandler.h.

Referenced by myEndElement(), MSRouteHandler::myEndElement(), myStartElement(), and MSRouteHandler::myStartElement().

SUMOTime SUMORouteHandler::myLastDepart
protected

The insertion time of the vehicle read last.

Definition at line 135 of file SUMORouteHandler.h.

Referenced by checkLastDepart(), getLastDepart(), and registerLastDepart().


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