Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
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.
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 getFirstDepart () const
 returns the first departure time that was ever read
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 XERCES_CPP_NAMESPACE::Attributes &attrs)
 The inherited method called when a new tag opens.
 SUMORouteHandler (const std::string &file, const std::string &expectedRoot, const bool hardFail)
 standard constructor
virtual ~SUMORouteHandler ()
 standard destructor

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

Protected Member Functions

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.
open element functions
virtual void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)=0
 opens a type distribution for reading
virtual void closeVehicleTypeDistribution ()=0
 closes (ends) the building of a distribution
virtual void openRoute (const SUMOSAXAttributes &attrs)=0
 opens a route for reading
virtual void openFlow (const SUMOSAXAttributes &attrs)=0
 opens a flow for reading
virtual void openRouteFlow (const SUMOSAXAttributes &attrs)=0
 opens a route flow for reading
virtual void openTrip (const SUMOSAXAttributes &attrs)=0
 opens a trip for reading
close element functions
virtual void closeRoute (const bool mayBeDisconnected=false)=0
virtual void openRouteDistribution (const SUMOSAXAttributes &attrs)=0
 opens a route distribution for reading
virtual void closeRouteDistribution ()=0
 closes (ends) the building of a distribution
virtual void closeVehicle ()=0
 Ends the processing of a vehicle.
virtual void closeVType ()=0
 Ends the processing of a vehicle type.
virtual void closePerson ()=0
 Ends the processing of a person.
virtual void closePersonFlow ()=0
 Ends the processing of a person flow.
virtual void closeContainer ()=0
 Ends the processing of a container.
virtual void closeContainerFlow ()=0
 Ends the processing of a container flow.
virtual void closeFlow ()=0
 Ends the processing of a flow.
virtual void closeTrip ()=0
 Ends the processing of a trip.

add element functions

const bool myHardFail
 flag to enable or disable hard fails
SUMOVehicleParametermyVehicleParameter
 Parameter of the current vehicle, trip, person, container or flow.
std::vector< Parameterised * > myParamStack
 The stack of currently parsed parameterised objects.
SUMOTime myLastDepart
 The insertion time of the vehicle read last.
std::string myActiveRouteID
 The id of the current route.
std::string myActiveRouteRefID
 The id of the route the current route references to.
double myActiveRouteProbability
 The probability of the current route.
const RGBColormyActiveRouteColor
 The currently parsed route's color.
double myCurrentCosts
 The currently parsed route costs.
StopParVector myActiveRouteStops
 List of the stops on the parsed route.
SUMOVTypeParametermyCurrentVType
 The currently parsed vehicle type.
SUMOTime myBeginDefault
 The default value for flow begins.
SUMOTime myEndDefault
 The default value for flow ends.
SUMOTime myFirstDepart
 the first read departure time
int myInsertStopEdgesAt
 where stop edges can be inserted into the current route (-1 means no insertion)
std::vector< int > myElementStack
 hierarchy of elements being parsed
bool myAllowInternalRoutes
 whether references to internal routes are allowed in this context
std::set< std::string > mySkippedVehicles
 IDs of skipped vehicles to suppress errors for the triggered transportables within.
virtual void addTransportable (const SUMOSAXAttributes &attrs, const bool isPerson)
 Processing of a person or container.
virtual ParameterisedaddStop (const SUMOSAXAttributes &attrs)=0
 Processing of a stop.
virtual void addPersonTrip (const SUMOSAXAttributes &attrs)=0
 add a routing request for a walking or intermodal person
virtual void addWalk (const SUMOSAXAttributes &attrs)=0
 add a fully specified walk
virtual void addRide (const SUMOSAXAttributes &attrs)=0
 Processing of a ride.
virtual void addTransport (const SUMOSAXAttributes &attrs)=0
 Processing of a transport.
virtual void addTranship (const SUMOSAXAttributes &attrs)=0
 Processing of a tranship.
virtual bool checkLastDepart ()
 Checks whether the route file is sorted by departure time if needed.
void registerLastDepart ()
 save last depart (only to be used if vehicle is not discarded)
void addParam (const SUMOSAXAttributes &attrs)
 assign arbitrary vehicle parameters
bool parseStop (SUMOVehicleParameter::Stop &stop, const SUMOSAXAttributes &attrs, std::string errorSuffix, MsgHandler *const errorOutput)
 parses attributes common to all stops
 SUMORouteHandler (const SUMORouteHandler &s)=delete
 Invalidated copy constructor.
SUMORouteHandleroperator= (const SUMORouteHandler &s)=delete
 Invalidated assignment operator.

SAX ErrorHandler callbacks

void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings.
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
void setSection (const int element, const bool seen)
bool sectionFinished () const
std::pair< int, SUMOSAXAttributes * > retrieveNextSectionStart ()
void needsCharacterData (const bool value=true)
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message.
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
void callParentEnd (int element)
 signal endElement to the parent handler (special case for MSCalibrator)
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation.

attributes parsing

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

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.
GenericSAXHandlermyParentHandler
 The handler to give control back to.
int myParentIndicator
 The tag indicating that control should be given back.
std::string myFileName
 The name of the currently parsed file.
std::string myExpectedRoot
 The root element to expect, empty string disables the check.
bool myCollectCharacterData = false
 whether the reader should collect character data
bool myRootSeen = false
 whether the reader has already seen the root element
int mySection = -1
 The tag indicating the current section to parse.
bool mySectionSeen = false
 whether the reader has already seen the begin of the section
bool mySectionEnded = false
 whether the reader has already seen the end of the section
bool mySectionOpen = false
 whether an element of the current section is open
std::pair< int, SUMOSAXAttributes * > myNextSectionStart

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 303 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 317 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 39 of file SUMORouteHandler.cpp.

References myActiveRouteColor, myAllowInternalRoutes, myBeginDefault, myCurrentCosts, myCurrentVType, myEndDefault, myFirstDepart, myHardFail, myInsertStopEdgesAt, myLastDepart, myVehicleParameter, string2time(), and SUMOSAXHandler::SUMOSAXHandler().

Referenced by MSRouteHandler::MSRouteHandler(), operator=(), RORouteHandler::RORouteHandler(), SUMORouteHandler(), and VTypesHandler::VTypesHandler().

Here is the caller graph for this function:

◆ ~SUMORouteHandler()

SUMORouteHandler::~SUMORouteHandler ( )
virtual

standard destructor

Definition at line 55 of file SUMORouteHandler.cpp.

References myCurrentVType, and myVehicleParameter.

◆ SUMORouteHandler() [2/2]

SUMORouteHandler::SUMORouteHandler ( const SUMORouteHandler & s)
privatedelete

Invalidated copy constructor.

References SUMORouteHandler().

Member Function Documentation

◆ addParam()

void SUMORouteHandler::addParam ( const SUMOSAXAttributes & attrs)
protected

assign arbitrary vehicle parameters

Definition at line 376 of file SUMORouteHandler.cpp.

References FileHelpers::checkForRelativity(), SUMOSAXAttributes::get(), GenericSAXHandler::getFileName(), SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), myCurrentVType, myParamStack, myVehicleParameter, SUMO_ATTR_KEY, and SUMO_ATTR_VALUE.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addStop()

virtual Parameterised * SUMORouteHandler::addStop ( const SUMOSAXAttributes & attrs)
protectedpure virtual

Processing of a stop.

Implemented in MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ addTransportable()

virtual void SUMORouteHandler::addTransportable ( const SUMOSAXAttributes & attrs,
const bool isPerson )
inlineprotectedvirtual

Processing of a person or container.

Reimplemented in MSRouteHandler.

Definition at line 168 of file SUMORouteHandler.h.

References UNUSED_PARAMETER.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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

References getFileName(), and TL.

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

Here is the caller graph for this function:

◆ callParentEnd()

void GenericSAXHandler::callParentEnd ( int element)
protectedinherited

signal endElement to the parent handler (special case for MSCalibrator)

Definition at line 247 of file GenericSAXHandler.cpp.

References myParentHandler.

Referenced by MSCalibrator::myEndElement().

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

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

◆ checkLastDepart()

bool SUMORouteHandler::checkLastDepart ( )
protectedvirtual

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

Reimplemented in RORouteHandler.

Definition at line 62 of file SUMORouteHandler.cpp.

References GIVEN, myLastDepart, myVehicleParameter, TL, and WRITE_WARNINGF.

Referenced by RORouteHandler::checkLastDepart(), MSRouteHandler::closeFlow(), MSRouteHandler::closeTransportable(), MSRouteHandler::closeTransportableFlow(), and MSRouteHandler::closeVehicle().

Here is the caller graph for this function:

◆ checkStopPos()

SUMORouteHandler::StopPos SUMORouteHandler::checkStopPos ( double & startPos,
double & endPos,
const double laneLength,
const double minLength,
const bool friendlyPos )
static

check start and end position of a stop

return

Definition at line 317 of file SUMORouteHandler.cpp.

References STOPPOS_INVALID_ENDPOS, STOPPOS_INVALID_LANELENGTH, STOPPOS_INVALID_STARTPOS, and STOPPOS_VALID.

Referenced by MSRouteHandler::addStop(), RORouteHandler::addStop(), isStopPosValid(), RONetHandler::parseAccess(), and RONetHandler::parseStoppingPlace().

Here is the caller graph for this function:

◆ closeContainer()

virtual void SUMORouteHandler::closeContainer ( )
protectedpure virtual

Ends the processing of a container.

Implemented in MSRouteHandler, RORouteHandler, and VTypesHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closeContainerFlow()

virtual void SUMORouteHandler::closeContainerFlow ( )
protectedpure virtual

Ends the processing of a container flow.

Implemented in MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

Referenced by myEndElement().

Here is the caller graph for this function:

◆ closePersonFlow()

virtual void SUMORouteHandler::closePersonFlow ( )
protectedpure virtual

Ends the processing of a person flow.

Implemented in MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, MSStateHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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

Referenced by 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 195 of file GenericSAXHandler.cpp.

References myTagMap, and SUMO_TAG_NOTHING.

Referenced by endElement(), and 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 134 of file GenericSAXHandler.cpp.

References convertTag(), myCharacters(), myCharactersVector, myEndElement(), myParentHandler, myParentIndicator, mySection, mySectionOpen, 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 224 of file GenericSAXHandler.cpp.

References buildErrorMessage().

Referenced by MSRouteHandler::addFlowTransportable(), MSRouteHandler::addTransportable(), MSRouteHandler::closeTransportable(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::interpretDepartPosLat().

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

References buildErrorMessage().

◆ getFileName()

◆ getFirstDepart()

SUMOTime SUMORouteHandler::getFirstDepart ( ) const

returns the first departure time that was ever read

Definition at line 364 of file SUMORouteHandler.cpp.

References myFirstDepart.

◆ getLastDepart()

SUMOTime SUMORouteHandler::getLastDepart ( ) const

Returns the last loaded depart time.

Definition at line 370 of file SUMORouteHandler.cpp.

References myLastDepart.

◆ 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 354 of file SUMORouteHandler.cpp.

References checkStopPos(), and STOPPOS_VALID.

◆ 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_ITSUMO::Handler, and NIImporter_OpenDrive.

Definition at line 240 of file GenericSAXHandler.cpp.

Referenced by endElement().

Here is the caller graph for this function:

◆ myEndElement()

◆ 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 MSCalibrator, MSRouteHandler, MSStateHandler, NLHandler, and RORouteHandler.

Definition at line 87 of file SUMORouteHandler.cpp.

References addParam(), addPersonTrip(), addRide(), addStop(), addTranship(), addTransport(), addTransportable(), addWalk(), SUMOVehicleParserHelper::beginVTypeParsing(), GenericSAXHandler::getFileName(), SUMOSAXAttributes::getSUMOTimeReporting(), myActiveRouteID, myAllowInternalRoutes, myBeginDefault, myCurrentVType, myElementStack, myEndDefault, myHardFail, myParamStack, myVehicleParameter, openFlow(), openRoute(), openRouteDistribution(), openRouteFlow(), openTrip(), openVehicleTypeDistribution(), SUMOVehicleParserHelper::parseCFMParams(), SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_TAG_CALIBRATOR, SUMO_TAG_CONTAINER, SUMO_TAG_CONTAINERFLOW, 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, TL, VEHPARS_FORCE_REROUTE, WRITE_ERROR, and WRITE_WARNINGF.

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

Here is the caller graph for this function:

◆ needsCharacterData()

void GenericSAXHandler::needsCharacterData ( const bool value = true)
inlineinherited

Definition at line 220 of file GenericSAXHandler.h.

References invalid_return< std::string >::value, and myCollectCharacterData.

Referenced by NIImporter_ITSUMO::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and NIImporter_OpenDrive::myCharacters().

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

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 MSRouteHandler, RORouteHandler, and VTypesHandler.

Referenced by myStartElement().

Here is the caller graph for this function:

◆ operator=()

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

Invalidated assignment operator.

References SUMORouteHandler().

◆ 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 397 of file SUMORouteHandler.cpp.

References SUMOVehicleParameter::Stop::actType, SUMOVehicleParameter::Stop::arrival, SUMOVehicleParameter::Stop::awaitedContainers, SUMOVehicleParameter::Stop::awaitedPersons, SUMOVehicleParameter::Stop::busstop, SUMOVehicleParameter::Stop::chargingStation, SUMOVehicleParameter::Stop::collision, SUMOVehicleParameter::Stop::containerstop, SUMOVehicleParameter::Stop::containerTriggered, SUMOVehicleParameter::Stop::duration, SUMOVehicleParameter::Stop::ended, SUMOVehicleParameter::Stop::extension, SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptSUMOTimeReporting(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::Stop::index, MsgHandler::inform(), INVALID_DOUBLE, SUMOVehicleParameter::Stop::join, SUMOVehicleParameter::Stop::jump, SUMOVehicleParameter::Stop::jumpUntil, SUMOVehicleParameter::Stop::line, OFFROAD, SUMOVehicleParameter::Stop::onDemand, ONROAD, SUMOVehicleParameter::Stop::overheadWireSegment, SUMOVehicleParameter::Stop::parametersSet, SUMOVehicleParameter::Stop::parking, SUMOVehicleParameter::Stop::parkingarea, SUMOVehicleParameter::parseStopTriggers(), SUMOVehicleParameter::Stop::permitted, SUMOVehicleParameter::Stop::posLat, SUMOVehicleParameter::Stop::priority, SUMOVehicleParameter::Stop::speed, SUMOVehicleParameter::Stop::split, SUMOVehicleParameter::Stop::started, STOP_ARRIVAL_SET, STOP_DURATION_SET, STOP_END_SET, STOP_ENDED_SET, STOP_EXPECTED_CONTAINERS_SET, STOP_EXPECTED_SET, STOP_EXTENSION_SET, STOP_INDEX_END, STOP_INDEX_FIT, STOP_JOIN_SET, STOP_JUMP_SET, STOP_JUMP_UNTIL_SET, STOP_LINE_SET, STOP_ONDEMAND_SET, STOP_PARKING_SET, STOP_PERMITTED_SET, STOP_POSLAT_SET, STOP_PRIORITY_SET, STOP_SPEED_SET, STOP_SPLIT_SET, STOP_START_SET, STOP_STARTED_SET, STOP_TRIGGER_SET, STOP_TRIP_ID_SET, STOP_UNTIL_SET, SUMO_ATTR_ACTTYPE, SUMO_ATTR_ARRIVAL, SUMO_ATTR_BUS_STOP, SUMO_ATTR_CHARGING_STATION, SUMO_ATTR_COLLISION, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_CONTAINER_TRIGGERED, SUMO_ATTR_DURATION, SUMO_ATTR_EDGE, SUMO_ATTR_ENDED, SUMO_ATTR_ENDPOS, SUMO_ATTR_EXPECTED, SUMO_ATTR_EXPECTED_CONTAINERS, SUMO_ATTR_EXTENSION, SUMO_ATTR_INDEX, SUMO_ATTR_JOIN, SUMO_ATTR_JUMP, SUMO_ATTR_JUMP_UNTIL, SUMO_ATTR_LANE, SUMO_ATTR_LINE, SUMO_ATTR_ONDEMAND, SUMO_ATTR_OVERHEAD_WIRE_SEGMENT, SUMO_ATTR_PARKING, SUMO_ATTR_PARKING_AREA, SUMO_ATTR_PERMITTED, SUMO_ATTR_POSITION_LAT, SUMO_ATTR_PRIORITY, SUMO_ATTR_SPEED, SUMO_ATTR_SPLIT, SUMO_ATTR_STARTED, SUMO_ATTR_STARTPOS, SUMO_ATTR_TRAIN_STOP, SUMO_ATTR_TRIGGERED, SUMO_ATTR_TRIP_ID, SUMO_ATTR_UNTIL, SUMO_TAG_CONTAINER, TL, TLF, toString(), SUMOVehicleParameter::Stop::triggered, SUMOVehicleParameter::Stop::tripId, SUMOVehicleParameter::Stop::until, and WRITE_WARNINGF.

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

Here is the caller graph for this function:

◆ registerLastDepart()

void SUMORouteHandler::registerLastDepart ( )
protected

save last depart (only to be used if vehicle is not discarded)

Definition at line 74 of file SUMORouteHandler.cpp.

References GIVEN, myFirstDepart, myLastDepart, and myVehicleParameter.

Referenced by RORouteHandler::addFlowPerson(), RORouteHandler::closeContainer(), RORouteHandler::closeContainerFlow(), MSRouteHandler::closeFlow(), RORouteHandler::closeFlow(), RORouteHandler::closePerson(), MSRouteHandler::closeTransportable(), MSRouteHandler::closeTransportableFlow(), MSRouteHandler::closeVehicle(), and RORouteHandler::closeVehicle().

Here is the caller graph for this function:

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

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

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

Here is the caller graph for this function:

◆ retrieveNextSectionStart()

std::pair< int, SUMOSAXAttributes * > GenericSAXHandler::retrieveNextSectionStart ( )
inlineinherited

Definition at line 213 of file GenericSAXHandler.h.

References myNextSectionStart.

◆ sectionFinished()

bool GenericSAXHandler::sectionFinished ( ) const
inlineinherited

Definition at line 209 of file GenericSAXHandler.h.

References mySectionEnded.

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

References myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), MSStateHandler::MSStateTimeHandler::getTime(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), NITypeLoader::load(), PCNetProjectionLoader::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:

◆ setSection()

void GenericSAXHandler::setSection ( const int element,
const bool seen )
inlineinherited

Definition at line 202 of file GenericSAXHandler.h.

References mySection, mySectionEnded, mySectionOpen, and mySectionSeen.

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

References convertTag(), FileHelpers::getConfigurationRelative(), getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), myCharactersVector, myExpectedRoot, myNextSectionStart, myPredefinedTags, myPredefinedTagsMML, myRootSeen, mySection, mySectionEnded, mySectionOpen, mySectionSeen, myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, TL, StringUtils::transcode(), and WRITE_WARNINGF.

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

References buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myActiveRouteColor

const RGBColor* SUMORouteHandler::myActiveRouteColor
protected

◆ 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 222 of file SUMORouteHandler.h.

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

◆ myActiveRouteStops

StopParVector SUMORouteHandler::myActiveRouteStops
protected

◆ myAllowInternalRoutes

bool SUMORouteHandler::myAllowInternalRoutes
protected

whether references to internal routes are allowed in this context

Definition at line 255 of file SUMORouteHandler.h.

Referenced by MSStateHandler::MSStateHandler(), myStartElement(), and SUMORouteHandler().

◆ myBeginDefault

SUMOTime SUMORouteHandler::myBeginDefault
protected

The default value for flow begins.

Definition at line 240 of file SUMORouteHandler.h.

Referenced by myEndElement(), myStartElement(), and SUMORouteHandler().

◆ 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 324 of file GenericSAXHandler.h.

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

◆ myCollectCharacterData

bool GenericSAXHandler::myCollectCharacterData = false
privateinherited

whether the reader should collect character data

Definition at line 339 of file GenericSAXHandler.h.

Referenced by characters(), and needsCharacterData().

◆ myCurrentCosts

double SUMORouteHandler::myCurrentCosts
protected

◆ myCurrentVType

◆ myElementStack

std::vector<int> SUMORouteHandler::myElementStack
protected

hierarchy of elements being parsed

Definition at line 252 of file SUMORouteHandler.h.

Referenced by myEndElement(), and myStartElement().

◆ myEndDefault

SUMOTime SUMORouteHandler::myEndDefault
protected

The default value for flow ends.

Definition at line 243 of file SUMORouteHandler.h.

Referenced by myEndElement(), myStartElement(), and SUMORouteHandler().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 336 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), and startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 333 of file GenericSAXHandler.h.

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

◆ myFirstDepart

SUMOTime SUMORouteHandler::myFirstDepart
protected

the first read departure time

Definition at line 246 of file SUMORouteHandler.h.

Referenced by getFirstDepart(), registerLastDepart(), and SUMORouteHandler().

◆ myHardFail

const bool SUMORouteHandler::myHardFail
protected

◆ myInsertStopEdgesAt

◆ myLastDepart

SUMOTime SUMORouteHandler::myLastDepart
protected

The insertion time of the vehicle read last.

Definition at line 216 of file SUMORouteHandler.h.

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

◆ myNextSectionStart

std::pair<int, SUMOSAXAttributes*> GenericSAXHandler::myNextSectionStart
privateinherited

◆ myParamStack

std::vector<Parameterised*> SUMORouteHandler::myParamStack
protected

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 327 of file GenericSAXHandler.h.

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

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
privateinherited

The tag indicating that control should be given back.

Definition at line 330 of file GenericSAXHandler.h.

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

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

Definition at line 306 of file GenericSAXHandler.h.

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

◆ myPredefinedTagsMML

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

the map from ids to their string representation

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), and startElement().

◆ myRootSeen

bool GenericSAXHandler::myRootSeen = false
privateinherited

whether the reader has already seen the root element

Definition at line 342 of file GenericSAXHandler.h.

Referenced by startElement().

◆ mySection

int GenericSAXHandler::mySection = -1
privateinherited

The tag indicating the current section to parse.

Definition at line 345 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionEnded

bool GenericSAXHandler::mySectionEnded = false
privateinherited

whether the reader has already seen the end of the section

Definition at line 351 of file GenericSAXHandler.h.

Referenced by sectionFinished(), setSection(), and startElement().

◆ mySectionOpen

bool GenericSAXHandler::mySectionOpen = false
privateinherited

whether an element of the current section is open

Definition at line 354 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionSeen

bool GenericSAXHandler::mySectionSeen = false
privateinherited

whether the reader has already seen the begin of the section

Definition at line 348 of file GenericSAXHandler.h.

Referenced by setSection(), and startElement().

◆ mySkippedVehicles

std::set<std::string> SUMORouteHandler::mySkippedVehicles
protected

IDs of skipped vehicles to suppress errors for the triggered transportables within.

Definition at line 258 of file SUMORouteHandler.h.

Referenced by RORouteHandler::addRide(), MSRouteHandler::addRideOrTransport(), RORouteHandler::addTransport(), MSRouteHandler::closeVehicle(), and RORouteHandler::closeVehicle().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

Definition at line 320 of file GenericSAXHandler.h.

Referenced by convertTag(), and GenericSAXHandler().

◆ myVehicleParameter

SUMOVehicleParameter* SUMORouteHandler::myVehicleParameter
protected

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

Definition at line 210 of file SUMORouteHandler.h.

Referenced by RORouteHandler::addFlowPerson(), MSRouteHandler::addFlowTransportable(), addParam(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), RORouteHandler::addRide(), MSRouteHandler::addRideOrTransport(), MSRouteHandler::addStop(), RORouteHandler::addStop(), MSRouteHandler::addTranship(), RORouteHandler::addTransport(), MSRouteHandler::addTransportable(), MSRouteHandler::addVehicleStopsToImplicitRoute(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), checkLastDepart(), RORouteHandler::closeContainer(), RORouteHandler::closeContainerFlow(), MSRouteHandler::closeFlow(), RORouteHandler::closeFlow(), RORouteHandler::closePerson(), RORouteHandler::closePersonFlow(), MSRouteHandler::closeRoute(), RORouteHandler::closeRoute(), MSRouteHandler::closeRouteDistribution(), RORouteHandler::closeRouteDistribution(), MSRouteHandler::closeTransportable(), MSRouteHandler::closeTransportableFlow(), MSRouteHandler::closeTrip(), MSRouteHandler::closeVehicle(), MSStateHandler::closeVehicle(), RORouteHandler::closeVehicle(), MSRouteHandler::deleteActivePlanAndVehicleParameter(), RORouteHandler::deleteActivePlanAndVehicleParameter(), MSRouteHandler::interpretDepartPosLat(), MSStateHandler::myEndElement(), myEndElement(), MSRouteHandler::myStartElement(), MSStateHandler::myStartElement(), RORouteHandler::myStartElement(), myStartElement(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), RORouteHandler::parseWalkPositions(), registerLastDepart(), MSRouteHandler::resetActivePlanAndVehicleParameter(), SUMORouteHandler(), and ~SUMORouteHandler().


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