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

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

#include <MSRouteHandler.h>

Inheritance diagram for MSRouteHandler:
SUMORouteHandler SUMOSAXHandler GenericSAXHandler MSCalibrator NLHandler GUICalibrator

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured. 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...
 
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...
 

Static Public Member Functions

static bool checkStopPos (SUMOReal &startPos, SUMOReal &endPos, const SUMOReal laneLength, const SUMOReal minLength, const bool friendlyPos)
 check start and end position of a stop More...
 
static MTRandgetParsingRNG ()
 

Protected Member Functions

void addParam (const SUMOSAXAttributes &attrs)
 assign arbitrary vehicle parameters More...
 
void addStop (const SUMOSAXAttributes &attrs)
 Processing of a stop. More...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
bool checkLastDepart ()
 Checks whether the route file is sorted by departure time if needed. More...
 
void closeContainer ()
 Ends the processing of a container. More...
 
void closeFlow ()
 Ends the processing of a flow. More...
 
void closePerson ()
 Ends the processing of a person. More...
 
void closeRoute (const bool mayBeDisconnected=false)
 
void closeRouteDistribution ()
 
void closeVehicle ()
 Ends the processing of a vehicle. More...
 
void closeVehicleTypeDistribution ()
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes. More...
 
void openRoute (const SUMOSAXAttributes &attrs)
 
void openRouteDistribution (const SUMOSAXAttributes &attrs)
 
void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)
 
void parseFromViaTo (std::string element, const SUMOSAXAttributes &attrs)
 Called for parsing from and to and the corresponding taz attributes. More...
 
bool parseStop (SUMOVehicleParameter::Stop &stop, const SUMOSAXAttributes &attrs, std::string errorSuffix, MsgHandler *const errorOutput)
 parses attributes common to all stops More...
 
void registerLastDepart ()
 save last depart (only to be used if vehicle is not discarded) More...
 
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...
 

Protected Attributes

MSContainer::MSContainerPlanmyActiveContainerPlan
 The plan of the current container. More...
 
MSPerson::MSPersonPlanmyActivePlan
 The plan of the current person. More...
 
ConstMSEdgeVector myActiveRoute
 The current route. More...
 
const RGBColormyActiveRouteColor
 The currently parsed route's color. More...
 
std::string myActiveRouteID
 The id of the current route. More...
 
SUMOReal myActiveRouteProbability
 The probability of the current route. More...
 
std::string myActiveRouteRefID
 The id of the route the current route references to. More...
 
std::vector
< SUMOVehicleParameter::Stop
myActiveRouteStops
 List of the stops on the parsed route. More...
 
bool myAddVehiclesDirectly
 Information whether vehicles shall be directly added to the network or kept within the buffer. More...
 
SUMOTime myBeginDefault
 The default value for flow begins. More...
 
SUMOReal myCurrentCosts
 The currently parsed route costs. 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...
 
SUMOVTypeParametermyCurrentVType
 The currently parsed vehicle type. 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...
 
SUMOTime myEndDefault
 The default value for flow ends. More...
 
SUMOTime myFirstDepart
 the first read departure time More...
 
IDSupplier myIdSupplier
 generates numerical ids More...
 
int myInsertStopEdgesAt
 where stop edges can be inserted into the current route (-1 means no insertion) More...
 
SUMOTime myLastDepart
 The insertion time of the vehicle read last. More...
 
SUMOVehicleParametermyVehicleParameter
 Parameter of the current vehicle, trip, person, container or flow. More...
 

Static Protected Attributes

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

Private Member Functions

 MSRouteHandler (const MSRouteHandler &s)
 Invalidated copy constructor. More...
 
MSRouteHandleroperator= (const MSRouteHandler &s)
 Invalidated assignment operator. 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 61 of file MSRouteHandler.h.

Constructor & Destructor Documentation

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

standard constructor

Definition at line 76 of file MSRouteHandler.cpp.

References myActiveRoute.

MSRouteHandler::~MSRouteHandler ( )
virtual

standard destructor

Definition at line 88 of file MSRouteHandler.cpp.

MSRouteHandler::MSRouteHandler ( const MSRouteHandler s)
private

Invalidated copy constructor.

Member Function Documentation

void SUMORouteHandler::addParam ( const SUMOSAXAttributes attrs)
protectedinherited
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 193 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName().

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

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

The inherited method called when characters occured.

The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon as the element ends.

Todo:

recheck/describe what happens with characters when a new element is opened

describe characters processing in the class' head

Definition at line 176 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), and GenericSAXHandler::myCharactersVector.

bool SUMORouteHandler::checkLastDepart ( )
protectedinherited
bool SUMORouteHandler::checkStopPos ( SUMOReal startPos,
SUMOReal endPos,
const SUMOReal  laneLength,
const SUMOReal  minLength,
const bool  friendlyPos 
)
staticinherited
void MSRouteHandler::closeRoute ( const bool  mayBeDisconnected = false)
protectedvirtual
void MSRouteHandler::closeRouteDistribution ( )
protectedvirtual
void MSRouteHandler::closeVehicleTypeDistribution ( )
protectedvirtual
void GenericSAXHandler::endElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname 
)
inherited

The inherited method called when a tag is being closed.

This method calls the user-implemented methods myCharacters with the previously collected and converted characters.

Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 126 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), GenericSAXHandler::convertTag(), GenericSAXHandler::myCharacters(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myEndElement(), GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, and SUMO_TAG_NOTHING.

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

Handler for XML-errors.

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

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

Definition at line 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by closeContainer(), closePerson(), and myStartElement().

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 occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

SUMOTime SUMORouteHandler::getFirstDepart ( ) const
inlineinherited

returns the first departure time that was ever read

Definition at line 74 of file SUMORouteHandler.h.

References SUMORouteHandler::myFirstDepart.

Referenced by SUMORouteLoader::getFirstDepart().

SUMOTime SUMORouteHandler::getLastDepart ( ) const
inherited

Returns the last loaded depart time.

Definition at line 71 of file SUMORouteHandler.cpp.

References SUMORouteHandler::myLastDepart.

Referenced by SUMORouteLoader::loadUntil().

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

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

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

Reimplemented in NIImporter_ITSUMO::Handler.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

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, and MSCalibrator.

Definition at line 141 of file MSRouteHandler.cpp.

References PedestrianRouter< E, L, N, INTERNALROUTER >::compute(), DEFAULT_CONTAINER_TRANSHIP_SPEED, DEFAULT_PEDESTRIAN_SPEED, SUMOVehicleParameter::depart, SUMOVehicleParameter::departPos, MSEdge::dictionary(), GenericSAXHandler::error(), SUMOSAXAttributes::get(), MSNet::getBusStop(), MSNet::getContainerStop(), MSNet::getInstance(), MSVehicleType::getMaxSpeed(), SUMOSAXAttributes::getOpt(), OptionsCont::getOptions(), SUMOSAXAttributes::getOptSUMOTimeReporting(), MSNet::getPedestrianRouter(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), SUMOSAXAttributes::hasAttribute(), SUMOVehicleParameter::id, SUMOVehicleParameter::interpretEdgePos(), myActiveContainerPlan, myActivePlan, myActiveRoute, SUMORouteHandler::myActiveRouteID, SUMORouteHandler::myCurrentVType, myParsingRNG, SUMORouteHandler::myStartElement(), SUMORouteHandler::myVehicleParameter, NUMERICAL_EPS, MSEdge::parseEdgesList(), parseFromViaTo(), SUMOVehicleParserHelper::parseVTypeEmbedded(), SUMO_ATTR_ARRIVALPOS, SUMO_ATTR_BUS_STOP, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_DEPARTPOS, SUMO_ATTR_DURATION, SUMO_ATTR_EDGES, SUMO_ATTR_FROM, SUMO_ATTR_LINES, SUMO_ATTR_SPEED, SUMO_ATTR_TO, SUMO_TAG_CONTAINER, SUMO_TAG_FLOW, SUMO_TAG_PARAM, SUMO_TAG_PERSON, SUMO_TAG_RIDE, SUMO_TAG_TRANSHIP, SUMO_TAG_TRANSPORT, SUMO_TAG_TRIP, SUMO_TAG_VTYPE, SUMO_TAG_WALK, SUMOReal, SUMOVehicleParameter::vtypeid, VTYPEPARS_MAXSPEED_SET, MSVehicleType::wasSet(), and WRITE_ERROR.

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

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

Invalidated assignment operator.

void MSRouteHandler::parseFromViaTo ( std::string  element,
const SUMOSAXAttributes attrs 
)
protected
void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited
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 80 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

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

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

References TplConvert::_2str(), GenericSAXHandler::convertTag(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myPredefinedTags, GenericSAXHandler::myPredefinedTagsMML, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, and SUMO_TAG_INCLUDE.

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

Definition at line 206 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

MSContainer::MSContainerPlan* MSRouteHandler::myActiveContainerPlan
protected

The plan of the current container.

Definition at line 154 of file MSRouteHandler.h.

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

MSPerson::MSPersonPlan* MSRouteHandler::myActivePlan
protected

The plan of the current person.

Definition at line 151 of file MSRouteHandler.h.

Referenced by addStop(), closePerson(), and myStartElement().

ConstMSEdgeVector MSRouteHandler::myActiveRoute
protected

The current route.

Definition at line 148 of file MSRouteHandler.h.

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

const RGBColor* SUMORouteHandler::myActiveRouteColor
protectedinherited

The currently parsed route's color.

Definition at line 169 of file SUMORouteHandler.h.

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

SUMOReal SUMORouteHandler::myActiveRouteProbability
protectedinherited

The probability of the current route.

Definition at line 166 of file SUMORouteHandler.h.

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

std::string SUMORouteHandler::myActiveRouteRefID
protectedinherited

The id of the route the current route references to.

Definition at line 163 of file SUMORouteHandler.h.

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

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

List of the stops on the parsed route.

Definition at line 175 of file SUMORouteHandler.h.

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

bool MSRouteHandler::myAddVehiclesDirectly
protected

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

Definition at line 157 of file MSRouteHandler.h.

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

SUMOTime SUMORouteHandler::myBeginDefault
protectedinherited

The default value for flow begins.

Definition at line 184 of file SUMORouteHandler.h.

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

SUMOReal SUMORouteHandler::myCurrentCosts
protectedinherited

The currently parsed route costs.

Definition at line 172 of file SUMORouteHandler.h.

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

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

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

Definition at line 166 of file MSRouteHandler.h.

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

std::string MSRouteHandler::myCurrentRouteDistributionID
protected

The id of the currently parsed route distribution.

Definition at line 169 of file MSRouteHandler.h.

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

SUMOVTypeParameter* SUMORouteHandler::myCurrentVType
protectedinherited
RandomDistributor<MSVehicleType*>* MSRouteHandler::myCurrentVTypeDistribution
protected

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

Definition at line 160 of file MSRouteHandler.h.

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

std::string MSRouteHandler::myCurrentVTypeDistributionID
protected

The id of the currently parsed vehicle type distribution.

Definition at line 163 of file MSRouteHandler.h.

Referenced by closeVehicleTypeDistribution(), and openVehicleTypeDistribution().

SUMOTime SUMORouteHandler::myEndDefault
protectedinherited

The default value for flow ends.

Definition at line 187 of file SUMORouteHandler.h.

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

SUMOTime SUMORouteHandler::myFirstDepart
protectedinherited

the first read departure time

Definition at line 190 of file SUMORouteHandler.h.

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

IDSupplier SUMORouteHandler::myIdSupplier
protectedinherited

generates numerical ids

Definition at line 181 of file SUMORouteHandler.h.

Referenced by SUMORouteHandler::myStartElement().

int SUMORouteHandler::myInsertStopEdgesAt
protectedinherited

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

Definition at line 193 of file SUMORouteHandler.h.

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

SUMOTime SUMORouteHandler::myLastDepart
protectedinherited

The insertion time of the vehicle read last.

Definition at line 157 of file SUMORouteHandler.h.

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

MTRand MSRouteHandler::myParsingRNG
staticprotected

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

Definition at line 172 of file MSRouteHandler.h.

Referenced by closeFlow(), closePerson(), closeRoute(), closeRouteDistribution(), closeVehicle(), getParsingRNG(), myStartElement(), openRoute(), openRouteDistribution(), and openVehicleTypeDistribution().


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