Eclipse SUMO - Simulation of Urban MObility
SUMORouteHandler Class Referenceabstract

Parser for routes during their loading. More...

#include <SUMORouteHandler.h>

Inheritance diagram for SUMORouteHandler:
[legend]
Collaboration diagram for SUMORouteHandler:
[legend]

Public Types

enum  StopPos { STOPPOS_VALID , STOPPOS_INVALID_STARTPOS , STOPPOS_INVALID_ENDPOS , STOPPOS_INVALID_LANELENGTH }
 enum for stops More...
 

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occurred. More...
 
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed. More...
 
const std::string & getFileName () const
 returns the current file name More...
 
SUMOTime getFirstDepart () const
 returns the first departure time that was ever read More...
 
SUMOTime getLastDepart () const
 Returns the last loaded depart time. More...
 
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed. More...
 
void setFileName (const std::string &name)
 Sets the current file name. More...
 
void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
 The inherited method called when a new tag opens. More...
 
 SUMORouteHandler (const std::string &file, const std::string &expectedRoot, const bool hardFail)
 standard constructor More...
 
virtual ~SUMORouteHandler ()
 standard destructor More...
 

Static Public Member Functions

static StopPos checkStopPos (double &startPos, double &endPos, const double laneLength, const double minLength, const bool friendlyPos)
 check start and end position of a stop More...
 
static bool isStopPosValid (const double startPos, const double endPos, const double laneLength, const double minLength, const bool friendlyPos)
 check if start and end position of a stop is valid More...
 

Protected Member Functions

inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
virtual void myEndElement (int element)
 Called when a closing tag occurs. More...
 
open element functions
virtual void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)=0
 opens a type distribution for reading More...
 
virtual void closeVehicleTypeDistribution ()=0
 closes (ends) the building of a distribution More...
 
virtual void openRoute (const SUMOSAXAttributes &attrs)=0
 opens a route for reading More...
 
virtual void openFlow (const SUMOSAXAttributes &attrs)=0
 opens a flow for reading More...
 
virtual void openRouteFlow (const SUMOSAXAttributes &attrs)=0
 opens a route flow for reading More...
 
virtual void openTrip (const SUMOSAXAttributes &attrs)=0
 opens a trip for reading More...
 
close element functions
virtual void closeRoute (const bool mayBeDisconnected=false)=0
 
virtual void openRouteDistribution (const SUMOSAXAttributes &attrs)=0
 opens a route distribution for reading More...
 
virtual void closeRouteDistribution ()=0
 closes (ends) the building of a distribution More...
 
virtual void closeVehicle ()=0
 Ends the processing of a vehicle. More...
 
virtual void closeVType ()=0
 Ends the processing of a vehicle type. More...
 
virtual void closePerson ()=0
 Ends the processing of a person. More...
 
virtual void closePersonFlow ()=0
 Ends the processing of a person. More...
 
virtual void closeContainer ()=0
 Ends the processing of a container. More...
 
virtual void closeFlow ()=0
 Ends the processing of a flow. More...
 
virtual void closeTrip ()=0
 Ends the processing of a trip. More...
 

add element functions

const bool myHardFail
 flag to enable or disable hard fails More...
 
SUMOVehicleParametermyVehicleParameter
 Parameter of the current vehicle, trip, person, container or flow. More...
 
SUMOTime myLastDepart
 The insertion time of the vehicle read last. More...
 
std::string myActiveRouteID
 The id of the current route. More...
 
std::string myActiveRouteRefID
 The id of the route the current route references to. More...
 
double myActiveRouteProbability
 The probability of the current route. More...
 
const RGBColormyActiveRouteColor
 The currently parsed route's color. More...
 
double myCurrentCosts
 The currently parsed route costs. More...
 
std::vector< SUMOVehicleParameter::StopmyActiveRouteStops
 List of the stops on the parsed route. More...
 
SUMOVTypeParametermyCurrentVType
 The currently parsed vehicle type. More...
 
Parameterised myLoadedParameterised
 Parameterised used for saving loaded generic parameters that aren't saved in Vehicles or Vehicle Types. More...
 
IDSupplier myIdSupplier
 generates numerical ids More...
 
SUMOTime myBeginDefault
 The default value for flow begins. More...
 
SUMOTime myEndDefault
 The default value for flow ends. More...
 
SUMOTime myFirstDepart
 the first read departure time More...
 
int myInsertStopEdgesAt
 where stop edges can be inserted into the current route (-1 means no insertion) More...
 
virtual void addStop (const SUMOSAXAttributes &attrs)=0
 Processing of a stop. More...
 
virtual void addPersonTrip (const SUMOSAXAttributes &attrs)=0
 add a routing request for a walking or intermodal person More...
 
virtual void addWalk (const SUMOSAXAttributes &attrs)=0
 add a fully specified walk More...
 
virtual void addPerson (const SUMOSAXAttributes &attrs)=0
 Processing of a person. More...
 
virtual void addContainer (const SUMOSAXAttributes &attrs)=0
 Processing of a container. More...
 
virtual void addRide (const SUMOSAXAttributes &attrs)=0
 Processing of a ride. More...
 
virtual void addTransport (const SUMOSAXAttributes &attrs)=0
 Processing of a transport. More...
 
virtual void addTranship (const SUMOSAXAttributes &attrs)=0
 Processing of a tranship. More...
 
bool checkLastDepart ()
 Checks whether the route file is sorted by departure time if needed. More...
 
void registerLastDepart ()
 save last depart (only to be used if vehicle is not discarded) More...
 
void addParam (const SUMOSAXAttributes &attrs)
 assign arbitrary vehicle parameters More...
 
bool parseStop (SUMOVehicleParameter::Stop &stop, const SUMOSAXAttributes &attrs, std::string errorSuffix, MsgHandler *const errorOutput)
 parses attributes common to all stops More...
 
 SUMORouteHandler (const SUMORouteHandler &s)=delete
 Invalidated copy constructor. More...
 
SUMORouteHandleroperator= (const SUMORouteHandler &s)=delete
 Invalidated assignment operator. More...
 

SAX ErrorHandler callbacks

void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings. More...
 
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes. More...
 
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode More...
 
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation. More...
 

attributes parsing

typedef std::vector< XMLCh * > AttrMap
 
AttrMap myPredefinedTags
 
std::vector< std::string > myPredefinedTagsMML
 the map from ids to their string representation More...
 

elements parsing

typedef std::map< std::string, int > TagMap
 
TagMap myTagMap
 
std::vector< std::string > myCharactersVector
 A list of character strings obtained so far to build the complete characters string at the end. More...
 
GenericSAXHandlermyParentHandler
 The handler to give control back to. More...
 
int myParentIndicator
 The tag indicating that control should be given back. More...
 
std::string myFileName
 The name of the currently parsed file. More...
 
std::string myExpectedRoot
 The root element to expect, empty string disables the check. More...
 
bool myRootSeen
 whether the reader has already seen the root element More...
 

Detailed Description

Parser for routes during their loading.

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

Definition at line 48 of file SUMORouteHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 279 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
privateinherited

Definition at line 293 of file GenericSAXHandler.h.

Member Enumeration Documentation

◆ StopPos

enum for stops

Enumerator
STOPPOS_VALID 
STOPPOS_INVALID_STARTPOS 
STOPPOS_INVALID_ENDPOS 
STOPPOS_INVALID_LANELENGTH 

Definition at line 51 of file SUMORouteHandler.h.

Constructor & Destructor Documentation

◆ SUMORouteHandler() [1/2]

SUMORouteHandler::SUMORouteHandler ( const std::string &  file,
const std::string &  expectedRoot,
const bool  hardFail 
)

standard constructor

Definition at line 38 of file SUMORouteHandler.cpp.

◆ ~SUMORouteHandler()

SUMORouteHandler::~SUMORouteHandler ( )
virtual

standard destructor

Definition at line 53 of file SUMORouteHandler.cpp.

References myCurrentVType.

◆ SUMORouteHandler() [2/2]

SUMORouteHandler::SUMORouteHandler ( const SUMORouteHandler s)
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ addContainer()

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

Processing of a container.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addParam()

void SUMORouteHandler::addParam ( const SUMOSAXAttributes attrs)
protected

assign arbitrary vehicle parameters

Definition at line 345 of file SUMORouteHandler.cpp.

References SUMOSAXAttributes::get(), SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), myCurrentVType, myLoadedParameterised, myVehicleParameter, Parameterised::setParameter(), SUMO_ATTR_KEY, and SUMO_ATTR_VALUE.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addPerson()

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

Processing of a person.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addPersonTrip()

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

add a routing request for a walking or intermodal person

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addRide()

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

Processing of a ride.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addStop()

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

Processing of a stop.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addTranship()

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

Processing of a tranship.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addTransport()

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

Processing of a transport.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addWalk()

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

add a fully specified walk

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ buildErrorMessage()

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::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 188 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName(), and transcode().

Referenced by GenericSAXHandler::error(), GenericSAXHandler::fatalError(), and GenericSAXHandler::warning().

Here is the caller graph for this function:

◆ characters()

void GenericSAXHandler::characters ( const XMLCh *const  chars,
const XERCES3_SIZE_t  length 
)
inherited

The inherited method called when characters occurred.

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 171 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().

◆ checkLastDepart()

bool SUMORouteHandler::checkLastDepart ( )
protected

Checks whether the route file is sorted by departure time if needed.

Definition at line 59 of file SUMORouteHandler.cpp.

References SUMOVehicleParameter::depart, DEPART_GIVEN, SUMOVehicleParameter::departProcedure, SUMOVehicleParameter::id, myLastDepart, myVehicleParameter, and WRITE_WARNING.

Referenced by MSRouteHandler::closeContainer(), MSRouteHandler::closeFlow(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), and MSRouteHandler::closeVehicle().

Here is the caller graph for this function:

◆ checkStopPos()

◆ closeContainer()

virtual void SUMORouteHandler::closeContainer ( )
protectedpure virtual

Ends the processing of a container.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeFlow()

virtual void SUMORouteHandler::closeFlow ( )
protectedpure virtual

Ends the processing of a flow.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closePerson()

virtual void SUMORouteHandler::closePerson ( )
protectedpure virtual

Ends the processing of a person.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closePersonFlow()

virtual void SUMORouteHandler::closePersonFlow ( )
protectedpure virtual

Ends the processing of a person.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeRoute()

virtual void SUMORouteHandler::closeRoute ( const bool  mayBeDisconnected = false)
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 RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeRouteDistribution()

virtual void SUMORouteHandler::closeRouteDistribution ( )
protectedpure virtual

closes (ends) the building of a distribution

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeTrip()

virtual void SUMORouteHandler::closeTrip ( )
protectedpure virtual

Ends the processing of a trip.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeVehicle()

virtual void SUMORouteHandler::closeVehicle ( )
protectedpure virtual

Ends the processing of a vehicle.

Implemented in RORouteHandler, GNERouteHandler, MSStateHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeVehicleTypeDistribution()

virtual void SUMORouteHandler::closeVehicleTypeDistribution ( )
protectedpure virtual

closes (ends) the building of a distribution

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeVType()

virtual void SUMORouteHandler::closeVType ( )
protectedpure virtual

Ends the processing of a vehicle type.

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string &  name) const
privateinherited

converts from c++-string into unicode

Todo:
recheck encoding
Parameters
[in]nameThe string to convert
Returns
The string converted into a XMLCh-string

Definition at line 84 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::GenericSAXHandler().

Here is the caller graph for this function:

◆ convertTag()

int GenericSAXHandler::convertTag ( const std::string &  tag) const
privateinherited

Converts a tag from its string into its numerical representation.

Returns the enum-representation stored for the given tag. If the tag is not known, SUMO_TAG_NOTHING is returned.

Parameters
[in]tagThe string to convert
Returns
The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 178 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

Here is the caller graph for this function:

◆ endElement()

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, SUMO_TAG_NOTHING, and StringUtils::transcode().

◆ error()

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
inherited

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters
[in]exceptionThe occurred exception to process
Exceptions
ProcessErrorOn any call

Definition at line 207 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::myStartElement().

Here is the caller graph for this function:

◆ fatalError()

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::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 occurred exception to process

Definition at line 213 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

◆ getFirstDepart()

SUMOTime SUMORouteHandler::getFirstDepart ( ) const

returns the first departure time that was ever read

Definition at line 333 of file SUMORouteHandler.cpp.

References myFirstDepart.

Referenced by SUMORouteLoader::getFirstDepart().

Here is the caller graph for this function:

◆ getLastDepart()

SUMOTime SUMORouteHandler::getLastDepart ( ) const

Returns the last loaded depart time.

Definition at line 339 of file SUMORouteHandler.cpp.

References myLastDepart.

Referenced by SUMORouteLoader::loadUntil().

Here is the caller graph for this function:

◆ isStopPosValid()

bool SUMORouteHandler::isStopPosValid ( const double  startPos,
const double  endPos,
const double  laneLength,
const double  minLength,
const bool  friendlyPos 
)
static

check if start and end position of a stop is valid

Definition at line 323 of file SUMORouteHandler.cpp.

References checkStopPos(), and STOPPOS_VALID.

Referenced by GNEBusStop::isValid(), GNEChargingStation::isValid(), GNEContainerStop::isValid(), GNEParkingArea::isValid(), GNEPersonStop::isValid(), and GNEStop::isValid().

Here is the caller graph for this function:

◆ myCharacters()

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 @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 223 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

Here is the caller graph for this function:

◆ myEndElement()

void SUMORouteHandler::myEndElement ( int  element)
protectedvirtual

◆ myStartElement()

void SUMORouteHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

Called on the opening of a tag;.

Parameters
[in]elementID of the currently opened element
[in]attrsAttributes within the currently opened element
Exceptions
ProcessErrorIf something fails
See also
GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Reimplemented in RORouteHandler, NLHandler, MSCalibrator, MSStateHandler, and MSRouteHandler.

Definition at line 84 of file SUMORouteHandler.cpp.

References addContainer(), addParam(), addPerson(), addPersonTrip(), addRide(), addStop(), addTranship(), addTransport(), addWalk(), SUMOVehicleParserHelper::beginVTypeParsing(), GenericSAXHandler::getFileName(), SUMOSAXAttributes::getSUMOTimeReporting(), SUMOVehicleParameter::id, SUMOVTypeParameter::id, myActiveRouteID, myBeginDefault, myCurrentVType, myEndDefault, myHardFail, myVehicleParameter, openFlow(), openRoute(), openRouteDistribution(), openRouteFlow(), openTrip(), openVehicleTypeDistribution(), SUMOVehicleParameter::parametersSet, SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMOVehicleParserHelper::parseVTypeEmbedded(), SUMOVehicleParameter::routeid, SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_TAG_CONTAINER, SUMO_TAG_FLOW, SUMO_TAG_INTERVAL, SUMO_TAG_PARAM, SUMO_TAG_PERSON, SUMO_TAG_PERSONFLOW, SUMO_TAG_PERSONTRIP, SUMO_TAG_RIDE, SUMO_TAG_ROUTE, SUMO_TAG_ROUTE_DISTRIBUTION, SUMO_TAG_STOP, SUMO_TAG_TRANSHIP, SUMO_TAG_TRANSPORT, SUMO_TAG_TRIP, SUMO_TAG_VEHICLE, SUMO_TAG_VTYPE, SUMO_TAG_VTYPE_DISTRIBUTION, SUMO_TAG_WALK, VEHPARS_FORCE_REROUTE, WRITE_ERROR, and WRITE_WARNING.

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

Here is the caller graph for this function:

◆ openFlow()

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

opens a flow for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ openRoute()

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

opens a route for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ openRouteDistribution()

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

opens a route distribution for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ openRouteFlow()

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

opens a route flow for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ openTrip()

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

opens a trip for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ openVehicleTypeDistribution()

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

opens a type distribution for reading

Implemented in RORouteHandler, GNERouteHandler, and MSRouteHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ operator=()

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

Invalidated assignment operator.

◆ parseStop()

bool SUMORouteHandler::parseStop ( SUMOVehicleParameter::Stop stop,
const SUMOSAXAttributes attrs,
std::string  errorSuffix,
MsgHandler *const  errorOutput 
)
protected

parses attributes common to all stops

Definition at line 365 of file SUMORouteHandler.cpp.

References SUMOVehicleParameter::Stop::actualArrival, SUMOVehicleParameter::Stop::arrival, SUMOVehicleParameter::Stop::awaitedContainers, SUMOVehicleParameter::Stop::awaitedPersons, SUMOVehicleParameter::Stop::busstop, SUMOVehicleParameter::Stop::chargingStation, SUMOVehicleParameter::Stop::containerstop, SUMOVehicleParameter::Stop::containerTriggered, SUMOVehicleParameter::Stop::depart, SUMOVehicleParameter::Stop::duration, SUMOVehicleParameter::Stop::extension, SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptStringVector(), SUMOSAXAttributes::getOptSUMOTimeReporting(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::Stop::index, MsgHandler::inform(), SUMOVehicleParameter::Stop::join, SUMOVehicleParameter::Stop::lane, SUMOVehicleParameter::Stop::line, SUMOVehicleParameter::Stop::overheadWireSegment, SUMOVehicleParameter::Stop::parametersSet, SUMOVehicleParameter::Stop::parking, SUMOVehicleParameter::Stop::parkingarea, SUMOVehicleParameter::parseStopTriggers(), SUMOVehicleParameter::Stop::speed, SUMOVehicleParameter::Stop::split, STOP_ARRIVAL_SET, STOP_CONTAINER_TRIGGER_SET, STOP_DURATION_SET, STOP_END_SET, STOP_EXPECTED_CONTAINERS_SET, STOP_EXPECTED_SET, STOP_EXTENSION_SET, STOP_INDEX_END, STOP_INDEX_FIT, STOP_JOIN_SET, STOP_LINE_SET, STOP_PARKING_SET, STOP_SPEED_SET, STOP_SPLIT_SET, STOP_START_SET, STOP_TRIGGER_SET, STOP_TRIP_ID_SET, STOP_UNTIL_SET, SUMO_ATTR_ACTUALARRIVAL, SUMO_ATTR_ARRIVAL, SUMO_ATTR_BUS_STOP, SUMO_ATTR_CHARGING_STATION, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_CONTAINER_TRIGGERED, SUMO_ATTR_DEPART, SUMO_ATTR_DURATION, SUMO_ATTR_ENDPOS, SUMO_ATTR_EXPECTED, SUMO_ATTR_EXPECTED_CONTAINERS, SUMO_ATTR_EXTENSION, SUMO_ATTR_INDEX, SUMO_ATTR_JOIN, SUMO_ATTR_LINE, SUMO_ATTR_OVERHEAD_WIRE_SEGMENT, SUMO_ATTR_PARKING, SUMO_ATTR_PARKING_AREA, SUMO_ATTR_SPEED, SUMO_ATTR_SPLIT, SUMO_ATTR_STARTPOS, SUMO_ATTR_TRIGGERED, SUMO_ATTR_TRIP_ID, SUMO_ATTR_UNTIL, SUMO_TAG_CONTAINER, toString(), SUMOVehicleParameter::Stop::triggered, SUMOVehicleParameter::Stop::tripId, SUMOVehicleParameter::Stop::until, and WRITE_WARNING.

Referenced by MSRouteHandler::addStop(), GNERouteHandler::addStop(), and RORouteHandler::addStop().

Here is the caller graph for this function:

◆ registerLastDepart()

void SUMORouteHandler::registerLastDepart ( )
protected

◆ registerParent()

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 163 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

Here is the caller graph for this function:

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string &  name)
inherited

Sets the current file name.

Parameters
[in]nameThe name of the currently processed file
Todo:
Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 72 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), PCNetProjectionLoader::load(), NITypeLoader::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), main(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ startElement()

void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const XERCES_CPP_NAMESPACE::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 97 of file GenericSAXHandler.cpp.

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

◆ warning()

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::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 occurred exception to process

Definition at line 201 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myActiveRouteColor

const RGBColor* SUMORouteHandler::myActiveRouteColor
protected

The currently parsed route's color.

Definition at line 222 of file SUMORouteHandler.h.

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

◆ myActiveRouteID

◆ myActiveRouteProbability

double SUMORouteHandler::myActiveRouteProbability
protected

◆ myActiveRouteRefID

std::string SUMORouteHandler::myActiveRouteRefID
protected

The id of the route the current route references to.

Definition at line 216 of file SUMORouteHandler.h.

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

◆ myActiveRouteStops

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

◆ myBeginDefault

SUMOTime SUMORouteHandler::myBeginDefault
protected

The default value for flow begins.

Definition at line 240 of file SUMORouteHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myCharactersVector

std::vector<std::string> GenericSAXHandler::myCharactersVector
privateinherited

A list of character strings obtained so far to build the complete characters string at the end.

Definition at line 300 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::characters(), GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

◆ myCurrentCosts

double SUMORouteHandler::myCurrentCosts
protected

The currently parsed route costs.

Definition at line 225 of file SUMORouteHandler.h.

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

◆ myCurrentVType

◆ myEndDefault

SUMOTime SUMORouteHandler::myEndDefault
protected

The default value for flow ends.

Definition at line 243 of file SUMORouteHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

The root element to expect, empty string disables the check.

Definition at line 312 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::getFileName(), and GenericSAXHandler::setFileName().

◆ myFirstDepart

SUMOTime SUMORouteHandler::myFirstDepart
protected

the first read departure time

Definition at line 246 of file SUMORouteHandler.h.

Referenced by getFirstDepart(), and registerLastDepart().

◆ myHardFail

const bool SUMORouteHandler::myHardFail
protected

flag to enable or disable hard fails

Definition at line 204 of file SUMORouteHandler.h.

Referenced by RORouteHandler::addWalk(), myStartElement(), MSRouteHandler::parseWalkPositions(), and RORouteHandler::parseWalkPositions().

◆ myIdSupplier

IDSupplier SUMORouteHandler::myIdSupplier
protected

generates numerical ids

Definition at line 237 of file SUMORouteHandler.h.

◆ myInsertStopEdgesAt

◆ myLastDepart

SUMOTime SUMORouteHandler::myLastDepart
protected

The insertion time of the vehicle read last.

Definition at line 210 of file SUMORouteHandler.h.

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

◆ myLoadedParameterised

Parameterised SUMORouteHandler::myLoadedParameterised
protected

Parameterised used for saving loaded generic parameters that aren't saved in Vehicles or Vehicle Types.

Definition at line 234 of file SUMORouteHandler.h.

Referenced by addParam(), and GNERouteHandler::closeRoute().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 303 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
privateinherited

The tag indicating that control should be given back.

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

◆ myPredefinedTagsMML

std::vector<std::string> GenericSAXHandler::myPredefinedTagsMML
privateinherited

the map from ids to their string representation

Definition at line 285 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::GenericSAXHandler(), and GenericSAXHandler::startElement().

◆ myRootSeen

bool GenericSAXHandler::myRootSeen
privateinherited

whether the reader has already seen the root element

Definition at line 315 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

◆ myVehicleParameter

SUMOVehicleParameter* SUMORouteHandler::myVehicleParameter
protected

Parameter of the current vehicle, trip, person, container or flow.

Definition at line 207 of file SUMORouteHandler.h.

Referenced by MSRouteHandler::addFlowPerson(), addParam(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), MSRouteHandler::addRide(), MSRouteHandler::addStop(), GNERouteHandler::addStop(), RORouteHandler::addStop(), MSRouteHandler::addTransport(), MSRouteHandler::addVehicleStopsToImplicitRoute(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), checkLastDepart(), MSRouteHandler::closeContainer(), RORouteHandler::closeContainer(), MSRouteHandler::closeFlow(), GNERouteHandler::closeFlow(), RORouteHandler::closeFlow(), MSRouteHandler::closePerson(), GNERouteHandler::closePerson(), RORouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), GNERouteHandler::closePersonFlow(), RORouteHandler::closePersonFlow(), MSRouteHandler::closeRoute(), GNERouteHandler::closeRoute(), RORouteHandler::closeRoute(), MSRouteHandler::closeRouteDistribution(), MSRouteHandler::closeTrip(), GNERouteHandler::closeTrip(), MSRouteHandler::closeVehicle(), MSStateHandler::closeVehicle(), GNERouteHandler::closeVehicle(), RORouteHandler::closeVehicle(), MSStateHandler::myEndElement(), myEndElement(), MSRouteHandler::myStartElement(), MSStateHandler::myStartElement(), RORouteHandler::myStartElement(), myStartElement(), GNERouteHandler::openFlow(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), GNERouteHandler::openTrip(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), RORouteHandler::parseGeoEdges(), and registerLastDepart().


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