Eclipse SUMO - Simulation of Urban MObility
MSRouteHandler Class Reference

Parser and container for routes during their loading. More...

#include <MSRouteHandler.h>

Inheritance diagram for MSRouteHandler:
Collaboration diagram for MSRouteHandler:

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...
 
 MSRouteHandler (const std::string &file, bool addVehiclesDirectly)
 standard constructor 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...
 
virtual ~MSRouteHandler ()
 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 std::mt19937 * getParsingRNG ()
 get parsing RNG 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 myEndElement (int element)
 Called when a closing tag occurs. More...
 

inherited from GenericSAXHandler

ConstMSEdgeVector myActiveRoute
 The current route. More...
 
MSTransportable::MSTransportablePlanmyActivePlan
 The plan of the current person. More...
 
MSTransportable::MSTransportablePlanmyActiveContainerPlan
 The plan of the current container. More...
 
bool myAddVehiclesDirectly
 Information whether vehicles shall be directly added to the network or kept within the buffer. More...
 
RandomDistributor< MSVehicleType * > * myCurrentVTypeDistribution
 The currently parsed distribution of vehicle types (probability->vehicle type) More...
 
std::string myCurrentVTypeDistributionID
 The id of the currently parsed vehicle type distribution. More...
 
RandomDistributor< const MSRoute * > * myCurrentRouteDistribution
 The currently parsed distribution of routes (probability->route) More...
 
std::string myCurrentRouteDistributionID
 The id of the currently parsed route distribution. More...
 
bool myAmLoadingState
 whether a state file is being loaded More...
 
static std::mt19937 myParsingRNG
 A random number generator used to choose from vtype/route distributions and computing the speed factors. More...
 
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
void parseFromViaTo (std::string element, const SUMOSAXAttributes &attrs)
 Called for parsing from and to and the corresponding taz attributes. More...
 
void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)
 opens a type distribution for reading More...
 
void closeVehicleTypeDistribution ()
 closes (ends) the building of a distribution More...
 
void openRoute (const SUMOSAXAttributes &attrs)
 opens a route for reading More...
 
void openFlow (const SUMOSAXAttributes &attrs)
 opens a flow for reading More...
 
void openTrip (const SUMOSAXAttributes &attrs)
 opens a trip for reading More...
 
void closeRoute (const bool mayBeDisconnected=false)
 closes (ends) the building of a route. More...
 
void openRouteDistribution (const SUMOSAXAttributes &attrs)
 opens a route distribution for reading More...
 
void closeRouteDistribution ()
 closes (ends) the building of a distribution More...
 
virtual void closeVehicle ()
 Ends the processing of a vehicle (note: is virtual because is reimplemented in MSStateHandler) More...
 
void closeVType ()
 Ends the processing of a vehicle type. More...
 
void closePerson ()
 Ends the processing of a person. More...
 
void closePersonFlow ()
 Ends the processing of a personFlow. More...
 
void closeContainer ()
 Ends the processing of a container. More...
 
void closeFlow ()
 Ends the processing of a flow. More...
 
void closeTrip ()
 Ends the processing of a trip. More...
 
void addStop (const SUMOSAXAttributes &attrs)
 Processing of a stop. More...
 
void addPersonTrip (const SUMOSAXAttributes &attrs)
 add a routing request for a walking or intermodal person More...
 
void addWalk (const SUMOSAXAttributes &attrs)
 add a fully specified walk More...
 
void addPerson (const SUMOSAXAttributes &attrs)
 Processing of a person. More...
 
void addContainer (const SUMOSAXAttributes &attrs)
 Processing of a container. More...
 
void addRide (const SUMOSAXAttributes &attrs)
 Processing of a ride. More...
 
void addTransport (const SUMOSAXAttributes &attrs)
 Processing of a transport. More...
 
void addTranship (const SUMOSAXAttributes &attrs)
 Processing of a tranship. More...
 
void parseWalkPositions (const SUMOSAXAttributes &attrs, const std::string &personID, const MSEdge *fromEdge, const MSEdge *&toEdge, double &departPos, double &arrivalPos, MSStoppingPlace *&bs, const MSTransportable::Stage *const lastStage, bool &ok)
 @ brief parse depart- and arrival positions of a walk More...
 
void deleteActivePlans ()
 delete already created MSTransportablePlans if error occurs before handing over responsibility to a MSTransportable. More...
 
void addFlowPerson (SUMOTime depart, MSVehicleType *type, const std::string &baseID, int i)
 delete already created MSTransportablePlans if error occurs before handing over responsibility to a MSTransportable. More...
 
 MSRouteHandler (const MSRouteHandler &s)=delete
 Invalidated copy constructor. More...
 
MSRouteHandleroperator= (const MSRouteHandler &s)=delete
 Invalidated assignment operator. 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...
 
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...
 

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...
 
void setSchemaSeen (const bool schemaSeen=true)
 
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::map< int, XMLCh * > AttrMap
 
AttrMap myPredefinedTags
 
std::map< int, 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 mySchemaSeen
 whether the reader has already seen a schema More...
 

Detailed Description

Parser and container for routes during their loading.

MSRouteHandler is the container for routes while they are build until their transfering to the MSNet::RouteDict The result of the operations are single MSNet::Route-instances

Definition at line 53 of file MSRouteHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::map<int, XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 285 of file GenericSAXHandler.h.

◆ TagMap

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

Definition at line 299 of file GenericSAXHandler.h.

Member Enumeration Documentation

◆ StopPos

enum SUMORouteHandler::StopPos
inherited

enum for stops

Enumerator
STOPPOS_VALID 
STOPPOS_INVALID_STARTPOS 
STOPPOS_INVALID_ENDPOS 
STOPPOS_INVALID_LANELENGTH 

Definition at line 53 of file SUMORouteHandler.h.

Constructor & Destructor Documentation

◆ MSRouteHandler() [1/2]

MSRouteHandler::MSRouteHandler ( const std::string &  file,
bool  addVehiclesDirectly 
)

standard constructor

Definition at line 47 of file MSRouteHandler.cpp.

References myActiveRoute.

◆ ~MSRouteHandler()

MSRouteHandler::~MSRouteHandler ( )
virtual

standard destructor

Definition at line 59 of file MSRouteHandler.cpp.

◆ MSRouteHandler() [2/2]

MSRouteHandler::MSRouteHandler ( const MSRouteHandler s)
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ addContainer()

void MSRouteHandler::addContainer ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a container.

Implements SUMORouteHandler.

Definition at line 1250 of file MSRouteHandler.cpp.

◆ addFlowPerson()

void MSRouteHandler::addFlowPerson ( SUMOTime  depart,
MSVehicleType type,
const std::string &  baseID,
int  i 
)
private

◆ addParam()

◆ addPerson()

void MSRouteHandler::addPerson ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a person.

Implements SUMORouteHandler.

Definition at line 1245 of file MSRouteHandler.cpp.

◆ addPersonTrip()

◆ addRide()

void MSRouteHandler::addRide ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a ride.

Implements SUMORouteHandler.

Definition at line 1255 of file MSRouteHandler.cpp.

◆ addStop()

void MSRouteHandler::addStop ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a stop.

Implements SUMORouteHandler.

Definition at line 902 of file MSRouteHandler.cpp.

References SUMOVehicleParameter::Stop::busstop, SUMOVehicleParameter::Stop::chargingStation, SUMORouteHandler::checkStopPos(), SUMOVehicleParameter::Stop::containerstop, SUMOVehicleParameter::depart, SUMOVehicleParameter::departPos, MSLane::dictionary(), SUMOVehicleParameter::Stop::duration, SUMOVehicleParameter::Stop::endPos, MSStoppingPlace::getBeginLanePosition(), MSLane::getEdge(), MSStoppingPlace::getEndLanePosition(), MsgHandler::getErrorInstance(), Named::getID(), MSNet::getInstance(), MSStoppingPlace::getLane(), MSEdge::getLanes(), MSEdge::getLength(), SUMOSAXAttributes::getOpt(), MSNet::getStoppingPlace(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::id, SUMOVehicleParameter::interpretEdgePos(), SUMOVehicleParameter::Stop::lane, MAX2(), MIN_STOP_LENGTH, myActiveContainerPlan, myActivePlan, myActiveRoute, SUMORouteHandler::myActiveRouteID, SUMORouteHandler::myActiveRouteStops, SUMORouteHandler::myInsertStopEdgesAt, SUMORouteHandler::myVehicleParameter, NUMERICAL_EPS, SUMOVehicleParameter::Stop::parkingarea, SUMORouteHandler::parseStop(), POSITION_EPS, SUMOVehicleParameter::Stop::startPos, SUMOVehicleParameter::stops, SUMO_ATTR_ACTTYPE, SUMO_ATTR_ENDPOS, SUMO_ATTR_FRIENDLY_POS, SUMO_ATTR_LANE, SUMO_ATTR_POSITION, SUMO_ATTR_STARTPOS, SUMO_TAG_BUS_STOP, SUMO_TAG_CHARGING_STATION, SUMO_TAG_CONTAINER_STOP, SUMO_TAG_PARKING_AREA, toString(), SUMOVehicleParameter::Stop::until, VEHPARS_DEPARTPOS_SET, MSTransportable::WAITING, SUMOVehicleParameter::wasSet(), WRITE_ERROR, and WRITE_WARNING.

◆ addTranship()

void MSRouteHandler::addTranship ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a tranship.

Implements SUMORouteHandler.

Definition at line 1265 of file MSRouteHandler.cpp.

◆ addTransport()

void MSRouteHandler::addTransport ( const SUMOSAXAttributes attrs)
protectedvirtual

Processing of a transport.

Implements SUMORouteHandler.

Definition at line 1260 of file MSRouteHandler.cpp.

◆ addWalk()

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

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

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

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

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

◆ checkLastDepart()

bool SUMORouteHandler::checkLastDepart ( )
protectedinherited

◆ checkStopPos()

◆ closeContainer()

◆ closeFlow()

◆ closePerson()

◆ closePersonFlow()

◆ closeRoute()

void MSRouteHandler::closeRoute ( const bool  mayBeDisconnected = false)
protectedvirtual

◆ closeRouteDistribution()

void MSRouteHandler::closeRouteDistribution ( )
protectedvirtual

◆ closeTrip()

void MSRouteHandler::closeTrip ( )
protectedvirtual

◆ closeVehicle()

◆ closeVehicleTypeDistribution()

void MSRouteHandler::closeVehicleTypeDistribution ( )
protectedvirtual

◆ closeVType()

void MSRouteHandler::closeVType ( )
protectedvirtual

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

Referenced by GenericSAXHandler::GenericSAXHandler().

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

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

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

◆ deleteActivePlans()

void MSRouteHandler::deleteActivePlans ( )
private

delete already created MSTransportablePlans if error occurs before handing over responsibility to a MSTransportable.

Definition at line 63 of file MSRouteHandler.cpp.

References myActiveContainerPlan, and myActivePlan.

Referenced by addWalk(), closePerson(), closePersonFlow(), and myStartElement().

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

References GenericSAXHandler::buildErrorMessage().

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

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

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

◆ getFirstDepart()

SUMOTime SUMORouteHandler::getFirstDepart ( ) const
inherited

returns the first departure time that was ever read

Definition at line 330 of file SUMORouteHandler.cpp.

References SUMORouteHandler::myFirstDepart.

Referenced by SUMORouteLoader::getFirstDepart().

◆ getLastDepart()

SUMOTime SUMORouteHandler::getLastDepart ( ) const
inherited

Returns the last loaded depart time.

Definition at line 336 of file SUMORouteHandler.cpp.

References SUMORouteHandler::myLastDepart.

Referenced by SUMORouteLoader::loadUntil().

◆ getParsingRNG()

◆ isStopPosValid()

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

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

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

◆ myStartElement()

void MSRouteHandler::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 SUMORouteHandler.

Reimplemented in NLHandler, MSCalibrator, and MSStateHandler.

Definition at line 132 of file MSRouteHandler.cpp.

References DEFAULT_CONTAINER_TRANSHIP_SPEED, deleteActivePlans(), SUMOVehicleParameter::depart, DEPART_TRIGGERED, SUMOVehicleParameter::departPos, SUMOVehicleParameter::departProcedure, MSEdge::dictionary(), GenericSAXHandler::error(), MSGlobals::gCheckRoutes, SUMOSAXAttributes::get(), MSNet::getInstance(), MSVehicleType::getMaxSpeed(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptSUMOTimeReporting(), MSNet::getStoppingPlace(), MSVehicleControl::getVehicle(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::id, myActiveContainerPlan, myActivePlan, myActiveRoute, SUMORouteHandler::myActiveRouteID, SUMORouteHandler::myStartElement(), SUMORouteHandler::myVehicleParameter, NUMERICAL_EPS, MSEdge::parseEdgesList(), parseFromViaTo(), SUMO_ATTR_ARRIVALPOS, SUMO_ATTR_BUS_STOP, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_DEPART, SUMO_ATTR_DEPARTPOS, SUMO_ATTR_EDGES, SUMO_ATTR_FROM, SUMO_ATTR_INTENDED, SUMO_ATTR_LINES, SUMO_ATTR_SPEED, SUMO_ATTR_TO, SUMO_TAG_BUS_STOP, SUMO_TAG_CONTAINER, SUMO_TAG_CONTAINER_STOP, SUMO_TAG_FLOW, SUMO_TAG_PERSON, SUMO_TAG_PERSONFLOW, SUMO_TAG_PERSONTRIP, SUMO_TAG_RIDE, SUMO_TAG_STOP, SUMO_TAG_TRANSHIP, SUMO_TAG_TRANSPORT, SUMO_TAG_TRIP, SUMO_TAG_WALK, SUMOVehicleParameter::vtypeid, VTYPEPARS_MAXSPEED_SET, MSVehicleType::wasSet(), and WRITE_ERROR.

Referenced by MSStateHandler::myStartElement(), MSCalibrator::myStartElement(), and NLHandler::myStartElement().

◆ openFlow()

void MSRouteHandler::openFlow ( const SUMOSAXAttributes attrs)
protectedvirtual

opens a flow for reading

Implements SUMORouteHandler.

Definition at line 436 of file MSRouteHandler.cpp.

◆ openRoute()

◆ openRouteDistribution()

◆ openTrip()

void MSRouteHandler::openTrip ( const SUMOSAXAttributes attrs)
protectedvirtual

opens a trip for reading

Implements SUMORouteHandler.

Definition at line 442 of file MSRouteHandler.cpp.

◆ openVehicleTypeDistribution()

◆ operator=()

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

Invalidated assignment operator.

◆ parseFromViaTo()

◆ parseStop()

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

parses attributes common to all stops

Definition at line 362 of file SUMORouteHandler.cpp.

References SUMOVehicleParameter::Stop::awaitedContainers, SUMOVehicleParameter::Stop::awaitedPersons, SUMOVehicleParameter::Stop::busstop, SUMOVehicleParameter::Stop::chargingStation, SUMOVehicleParameter::Stop::containerstop, SUMOVehicleParameter::Stop::containerTriggered, SUMOVehicleParameter::Stop::duration, SUMOVehicleParameter::Stop::extension, SUMOSAXAttributes::get(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptStringVector(), SUMOSAXAttributes::getOptSUMOTimeReporting(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::Stop::index, MsgHandler::inform(), SUMOVehicleParameter::Stop::lane, SUMOVehicleParameter::Stop::line, SUMOVehicleParameter::Stop::parametersSet, SUMOVehicleParameter::Stop::parking, SUMOVehicleParameter::Stop::parkingarea, SUMOVehicleParameter::Stop::speed, 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_LINE_SET, STOP_PARKING_SET, STOP_SPEED_SET, STOP_START_SET, STOP_TRIGGER_SET, STOP_TRIP_ID_SET, STOP_UNTIL_SET, SUMO_ATTR_BUS_STOP, SUMO_ATTR_CHARGING_STATION, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_CONTAINER_TRIGGERED, SUMO_ATTR_DURATION, SUMO_ATTR_ENDPOS, SUMO_ATTR_EXPECTED, SUMO_ATTR_EXPECTED_CONTAINERS, SUMO_ATTR_EXTENSION, SUMO_ATTR_INDEX, SUMO_ATTR_LINE, SUMO_ATTR_PARKING, SUMO_ATTR_PARKING_AREA, SUMO_ATTR_SPEED, SUMO_ATTR_STARTPOS, SUMO_ATTR_TRIGGERED, SUMO_ATTR_TRIP_ID, SUMO_ATTR_UNTIL, SUMOVehicleParameter::Stop::triggered, SUMOVehicleParameter::Stop::tripId, SUMOVehicleParameter::Stop::until, and WRITE_WARNING.

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

◆ parseWalkPositions()

◆ registerLastDepart()

◆ registerParent()

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited

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

References GenericSAXHandler::myFileName.

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

◆ setSchemaSeen()

void GenericSAXHandler::setSchemaSeen ( const bool  schemaSeen = true)
inlineprotectedinherited

◆ 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 93 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::mySchemaSeen, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, and StringUtils::transcode().

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

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myActiveContainerPlan

MSTransportable::MSTransportablePlan* MSRouteHandler::myActiveContainerPlan
protected

The plan of the current container.

Definition at line 178 of file MSRouteHandler.h.

Referenced by addStop(), closeContainer(), deleteActivePlans(), and myStartElement().

◆ myActivePlan

MSTransportable::MSTransportablePlan* MSRouteHandler::myActivePlan
protected

The plan of the current person.

Definition at line 175 of file MSRouteHandler.h.

Referenced by addFlowPerson(), addPersonTrip(), addStop(), addWalk(), closePerson(), closePersonFlow(), deleteActivePlans(), and myStartElement().

◆ myActiveRoute

ConstMSEdgeVector MSRouteHandler::myActiveRoute
protected

The current route.

Definition at line 172 of file MSRouteHandler.h.

Referenced by addPersonTrip(), addStop(), addWalk(), closeRoute(), MSRouteHandler(), myStartElement(), openRoute(), and parseFromViaTo().

◆ myActiveRouteColor

const RGBColor* SUMORouteHandler::myActiveRouteColor
protectedinherited

The currently parsed route's color.

Definition at line 221 of file SUMORouteHandler.h.

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

◆ myActiveRouteID

◆ myActiveRouteProbability

double SUMORouteHandler::myActiveRouteProbability
protectedinherited

The probability of the current route.

Definition at line 218 of file SUMORouteHandler.h.

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

◆ myActiveRouteRefID

std::string SUMORouteHandler::myActiveRouteRefID
protectedinherited

The id of the route the current route references to.

Definition at line 215 of file SUMORouteHandler.h.

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

◆ myActiveRouteStops

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

List of the stops on the parsed route.

Definition at line 227 of file SUMORouteHandler.h.

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

◆ myAddVehiclesDirectly

bool MSRouteHandler::myAddVehiclesDirectly
protected

Information whether vehicles shall be directly added to the network or kept within the buffer.

Definition at line 181 of file MSRouteHandler.h.

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

◆ myAmLoadingState

bool MSRouteHandler::myAmLoadingState
protected

whether a state file is being loaded

Definition at line 196 of file MSRouteHandler.h.

Referenced by closePerson(), closePersonFlow(), closeVehicle(), and MSStateHandler::MSStateHandler().

◆ myBeginDefault

SUMOTime SUMORouteHandler::myBeginDefault
protectedinherited

The default value for flow begins.

Definition at line 239 of file SUMORouteHandler.h.

Referenced by SUMORouteHandler::myEndElement(), and SUMORouteHandler::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 306 of file GenericSAXHandler.h.

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

◆ myCurrentCosts

double SUMORouteHandler::myCurrentCosts
protectedinherited

The currently parsed route costs.

Definition at line 224 of file SUMORouteHandler.h.

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

◆ myCurrentRouteDistribution

RandomDistributor<const MSRoute*>* MSRouteHandler::myCurrentRouteDistribution
protected

The currently parsed distribution of routes (probability->route)

Definition at line 190 of file MSRouteHandler.h.

Referenced by closeRoute(), closeRouteDistribution(), openRoute(), and openRouteDistribution().

◆ myCurrentRouteDistributionID

std::string MSRouteHandler::myCurrentRouteDistributionID
protected

The id of the currently parsed route distribution.

Definition at line 193 of file MSRouteHandler.h.

Referenced by closeRouteDistribution(), openRoute(), and openRouteDistribution().

◆ myCurrentVType

◆ myCurrentVTypeDistribution

RandomDistributor<MSVehicleType*>* MSRouteHandler::myCurrentVTypeDistribution
protected

The currently parsed distribution of vehicle types (probability->vehicle type)

Definition at line 184 of file MSRouteHandler.h.

Referenced by closeVehicleTypeDistribution(), closeVType(), and openVehicleTypeDistribution().

◆ myCurrentVTypeDistributionID

std::string MSRouteHandler::myCurrentVTypeDistributionID
protected

The id of the currently parsed vehicle type distribution.

Definition at line 187 of file MSRouteHandler.h.

Referenced by closeVehicleTypeDistribution(), and openVehicleTypeDistribution().

◆ myEndDefault

SUMOTime SUMORouteHandler::myEndDefault
protectedinherited

The default value for flow ends.

Definition at line 242 of file SUMORouteHandler.h.

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

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
privateinherited

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

Definition at line 318 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
privateinherited

The name of the currently parsed file.

Definition at line 315 of file GenericSAXHandler.h.

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

◆ myFirstDepart

SUMOTime SUMORouteHandler::myFirstDepart
protectedinherited

the first read departure time

Definition at line 245 of file SUMORouteHandler.h.

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

◆ myHardFail

const bool SUMORouteHandler::myHardFail
protectedinherited

flag to enable or disable hard fails

Definition at line 203 of file SUMORouteHandler.h.

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

◆ myIdSupplier

IDSupplier SUMORouteHandler::myIdSupplier
protectedinherited

generates numerical ids

Definition at line 236 of file SUMORouteHandler.h.

◆ myInsertStopEdgesAt

int SUMORouteHandler::myInsertStopEdgesAt
protectedinherited

where stop edges can be inserted into the current route (-1 means no insertion)

Definition at line 248 of file SUMORouteHandler.h.

Referenced by addStop(), RORouteHandler::addStop(), closeFlow(), RORouteHandler::closeFlow(), SUMORouteHandler::myEndElement(), openRoute(), RORouteHandler::openRoute(), parseFromViaTo(), and RORouteHandler::parseFromViaTo().

◆ myLastDepart

SUMOTime SUMORouteHandler::myLastDepart
protectedinherited

The insertion time of the vehicle read last.

Definition at line 209 of file SUMORouteHandler.h.

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

◆ myLoadedParameterised

Parameterised SUMORouteHandler::myLoadedParameterised
protectedinherited

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

Definition at line 233 of file SUMORouteHandler.h.

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

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
privateinherited

The handler to give control back to.

Definition at line 309 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 312 of file GenericSAXHandler.h.

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

◆ myParsingRNG

std::mt19937 MSRouteHandler::myParsingRNG
staticprotected

A random number generator used to choose from vtype/route distributions and computing the speed factors.

Definition at line 199 of file MSRouteHandler.h.

Referenced by addFlowPerson(), addPersonTrip(), addWalk(), closeFlow(), closePerson(), closePersonFlow(), closeRoute(), closeRouteDistribution(), closeVehicle(), getParsingRNG(), openRoute(), openRouteDistribution(), openVehicleTypeDistribution(), and parseWalkPositions().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
privateinherited

◆ myPredefinedTagsMML

std::map<int, std::string> GenericSAXHandler::myPredefinedTagsMML
privateinherited

the map from ids to their string representation

Definition at line 291 of file GenericSAXHandler.h.

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

◆ mySchemaSeen

bool GenericSAXHandler::mySchemaSeen
privateinherited

whether the reader has already seen a schema

Definition at line 321 of file GenericSAXHandler.h.

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

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

◆ myVehicleParameter


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