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

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

#include <MSRouteHandler.h>

Inheritance diagram for MSRouteHandler:
SUMORouteHandler SUMOSAXHandler GenericSAXHandler DefaultHandler MSCalibrator NLHandler GUICalibrator

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured.
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed.
const std::string & getFileName () const
 returns the current file name
SUMOTime getLastDepart () const
 Returns the last loaded depart time.
 MSRouteHandler (const std::string &file, bool addVehiclesDirectly)
 standard constructor
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.
virtual ~MSRouteHandler ()
 standard destructor
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.

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

Protected Member Functions

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

Protected Attributes

MSPerson::MSPersonPlanmyActivePlan
 The plan of the current person.
MSEdgeVector myActiveRoute
 The current route.
const RGBColormyActiveRouteColor
 The currently parsed route's color.
std::string myActiveRouteID
 The id of the current route.
SUMOReal myActiveRouteProbability
 The id of the current route.
std::string myActiveRouteRefID
 The id of the route the current route references to.
std::vector
< SUMOVehicleParameter::Stop
myActiveRouteStops
 List of the stops on the parsed route.
bool myAddVehiclesDirectly
 Information whether vehicles shall be directly added to the network or kept within the buffer.
SUMOTime myBeginDefault
 The default value for flow begins.
RandomDistributor< const
MSRoute * > * 
myCurrentRouteDistribution
 The currently parsed distribution of routes (probability->route)
std::string myCurrentRouteDistributionID
 The id of the currently parsed route distribution.
SUMOVTypeParametermyCurrentVType
 The currently parsed vehicle type.
RandomDistributor
< MSVehicleType * > * 
myCurrentVTypeDistribution
 The currently parsed distribution of vehicle types (probability->vehicle type)
std::string myCurrentVTypeDistributionID
 The id of the currently parsed vehicle type distribution.
SUMOTime myEndDefault
 The default value for flow ends.
IDSupplier myIdSupplier
 generates numerical ids
SUMOTime myLastDepart
 The insertion time of the vehicle read last.
SUMOVehicleParametermyVehicleParameter
 Parameter of the current vehicle, trip, person, or flow.

Private Member Functions

 MSRouteHandler (const MSRouteHandler &s)
 Invalidated copy constructor.
MSRouteHandleroperator= (const MSRouteHandler &s)
 Invalidated assignment operator.

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 60 of file MSRouteHandler.h.

Constructor & Destructor Documentation

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

standard constructor

Definition at line 68 of file MSRouteHandler.cpp.

References myActiveRoute.

MSRouteHandler::~MSRouteHandler ( )
virtual

standard destructor

Definition at line 79 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

check start and end position of a stop

Definition at line 199 of file SUMORouteHandler.cpp.

Referenced by addStop(), RORouteHandler::addStop(), NLTriggerBuilder::parseAndBuildBusStop(), and RONetHandler::parseBusStop().

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

Returns the last loaded depart time.

Definition at line 70 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::myEndElement ( int  element)
protectedvirtual

Called when a closing tag occurs.

Parameters
[in]elementID of the currently opened element
Exceptions
ProcessErrorIf something fails
See Also
GenericSAXHandler::myEndElement

Reimplemented from SUMORouteHandler.

Reimplemented in NLHandler, and MSCalibrator.

Definition at line 327 of file MSRouteHandler.cpp.

References RandomDistributor< T >::add(), MSVehicleType::build(), MSVehicleType::getDefaultProbability(), MSVehicleType::getID(), MSNet::getInstance(), MSGlobals::gStateLoaded, SUMORouteHandler::myCurrentVType, myCurrentVTypeDistribution, and SUMO_TAG_VTYPE.

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 84 of file MSRouteHandler.cpp.

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

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

Invalidated assignment operator.

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

MSPerson::MSPersonPlan* MSRouteHandler::myActivePlan
protected

The plan of the current person.

Definition at line 133 of file MSRouteHandler.h.

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

MSEdgeVector MSRouteHandler::myActiveRoute
protected

The current route.

Definition at line 130 of file MSRouteHandler.h.

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

const RGBColor* SUMORouteHandler::myActiveRouteColor
protectedinherited

The currently parsed route's color.

Definition at line 161 of file SUMORouteHandler.h.

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

SUMOReal SUMORouteHandler::myActiveRouteProbability
protectedinherited

The id of the current route.

Definition at line 158 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 155 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 164 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 136 of file MSRouteHandler.h.

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

SUMOTime SUMORouteHandler::myBeginDefault
protectedinherited

The default value for flow begins.

Definition at line 173 of file SUMORouteHandler.h.

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

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

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

Definition at line 145 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 148 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 139 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 142 of file MSRouteHandler.h.

Referenced by closeVehicleTypeDistribution(), and openVehicleTypeDistribution().

SUMOTime SUMORouteHandler::myEndDefault
protectedinherited

The default value for flow ends.

Definition at line 176 of file SUMORouteHandler.h.

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

IDSupplier SUMORouteHandler::myIdSupplier
protectedinherited

generates numerical ids

Definition at line 170 of file SUMORouteHandler.h.

Referenced by SUMORouteHandler::myStartElement().

SUMOTime SUMORouteHandler::myLastDepart
protectedinherited

The insertion time of the vehicle read last.

Definition at line 149 of file SUMORouteHandler.h.

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


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