SUMO - Simulation of Urban MObility
MSRouteHandler Class Reference

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

#include <MSRouteHandler.h>

Inheritance diagram for MSRouteHandler:
SUMORouteHandler SUMOSAXHandler GenericSAXHandler DefaultHandler NLHandler

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured.
bool checkStopPos (SUMOReal &startPos, SUMOReal &endPos, const SUMOReal laneLength, const SUMOReal minLength, const bool friendlyPos)
 check start and end position of a stop
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 Attributes &attrs)
 The inherited method called when a new tag opens.
virtual ~MSRouteHandler ()
 standard destructor
SAX ErrorHandler callbacks
void warning (const SAXParseException &exception)
 Handler for XML-warnings.
void error (const SAXParseException &exception)
 Handler for XML-errors.
void fatalError (const SAXParseException &exception)
 Handler for XML-errors.

Protected Member Functions

void addStop (const SUMOSAXAttributes &attrs)
 Processing of a stop.
std::string buildErrorMessage (const 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 ()
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)
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.
RGBColor myActiveRouteColor
 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.
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 myLastDepart
 The insertion time of the vehicle read last.
SUMOReal myScale
 The scaling factor (especially for inc-dua)
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 destructor

Definition at line 86 of file MSRouteHandler.cpp.

Invalidated copy constructor.


Member Function Documentation

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException &  exception) [protected, inherited]

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 GenericSAXHandler::myCharactersVector.

bool SUMORouteHandler::checkStopPos ( SUMOReal startPos,
SUMOReal endPos,
const SUMOReal  laneLength,
const SUMOReal  minLength,
const bool  friendlyPos 
) [inherited]

check start and end position of a stop

Definition at line 178 of file SUMORouteHandler.cpp.

Referenced by addStop().

void MSRouteHandler::closeRoute ( ) [protected, virtual]
void MSRouteHandler::closeRouteDistribution ( ) [protected, virtual]

closes (ends) the building of a distribution

Implements SUMORouteHandler.

Definition at line 371 of file MSRouteHandler.cpp.

References MSRoute::dictionary(), RandomDistributor< T >::getOverallProb(), myCurrentRouteDistribution, myCurrentRouteDistributionID, and WRITE_ERROR.

void MSRouteHandler::closeVehicleTypeDistribution ( ) [protected, virtual]

closes (ends) the building of a distribution

Implements SUMORouteHandler.

Definition at line 211 of file MSRouteHandler.cpp.

References MSNet::getInstance(), RandomDistributor< T >::getOverallProb(), myCurrentVTypeDistribution, myCurrentVTypeDistributionID, and WRITE_ERROR.

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 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 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 NLHandler::getLanesFromIndices().

void GenericSAXHandler::fatalError ( const 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().

Returns the last loaded depart time.

Definition at line 67 of file SUMORouteHandler.cpp.

References SUMORouteHandler::myLastDepart.

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
) [protected, virtual, inherited]

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_OpenDrive, NIImporter_SUMO, PCNetProjectionLoader, NIImporter_ITSUMO::Handler, PCLoaderXML, RORDLoader_SUMOBase, and ROJTRTurnDefLoader.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void MSRouteHandler::myEndElement ( int  element) [protected, virtual]

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.

Definition at line 264 of file MSRouteHandler.cpp.

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

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

Invalidated assignment operator.

void SUMORouteHandler::registerLastDepart ( ) [protected, inherited]

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

Definition at line 85 of file SUMORouteHandler.cpp.

References SUMOVehicleParameter::depart, DEPART_GIVEN, SUMOVehicleParameter::departProcedure, SUMORouteHandler::myLastDepart, and SUMORouteHandler::myVehicleParameter.

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

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

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

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

void GenericSAXHandler::setFileName ( const std::string &  name) [inherited]
void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const 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 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 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

The plan of the current person.

Definition at line 133 of file MSRouteHandler.h.

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

The current route.

Definition at line 130 of file MSRouteHandler.h.

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

The currently parsed route's color.

Definition at line 147 of file SUMORouteHandler.h.

Referenced by closeRoute(), and openRoute().

std::string SUMORouteHandler::myActiveRouteID [protected, inherited]

The id of the current route.

Definition at line 138 of file SUMORouteHandler.h.

Referenced by addStop(), closeFlow(), closeRoute(), closeVehicle(), SUMORouteHandler::myStartElement(), myStartElement(), and openRoute().

The id of the current route.

Definition at line 144 of file SUMORouteHandler.h.

Referenced by closeRoute(), and openRoute().

std::string SUMORouteHandler::myActiveRouteRefID [protected, inherited]

The id of the route the current route references to.

Definition at line 141 of file SUMORouteHandler.h.

Referenced by closeRoute(), and openRoute().

List of the stops on the parsed route.

Definition at line 150 of file SUMORouteHandler.h.

Referenced by addStop(), and closeRoute().

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().

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

Definition at line 145 of file MSRouteHandler.h.

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

The id of the currently parsed route distribution.

Definition at line 148 of file MSRouteHandler.h.

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

The currently parsed vehicle type.

Definition at line 153 of file SUMORouteHandler.h.

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

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

Definition at line 139 of file MSRouteHandler.h.

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

The id of the currently parsed vehicle type distribution.

Definition at line 142 of file MSRouteHandler.h.

Referenced by closeVehicleTypeDistribution(), and openVehicleTypeDistribution().

SUMOTime SUMORouteHandler::myLastDepart [protected, inherited]

The insertion time of the vehicle read last.

Definition at line 135 of file SUMORouteHandler.h.

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

The scaling factor (especially for inc-dua)

Definition at line 151 of file MSRouteHandler.h.

Referenced by closeVehicle(), and MSRouteHandler().


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines