Eclipse SUMO - Simulation of Urban MObility
AGActivityGenHandler Class Reference

#include <AGActivityGenHandler.h>

Inheritance diagram for AGActivityGenHandler:
Collaboration diagram for AGActivityGenHandler:

Public Member Functions

 AGActivityGenHandler (AGCity &city, RONet *net)
 Constructor. More...
 
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...
 
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 ~AGActivityGenHandler ()
 Destructor. More...
 

Protected Member Functions

inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 

called from myStartElement

AGCitymyCity
 The city to store the information into. More...
 
std::string myCurrentObject
 The name of the object that is currently processed. More...
 
AGBusLinecurrentBusLine
 
bool isRevStation
 indicator whether the current station (in bus line context) is a reverse station or not. More...
 
RONetnet
 The loaded network. More...
 
bool myProcess
 An indicator whether the next edge shall be read (internal edges are not read by now) More...
 
void parseGeneralCityInfo (const SUMOSAXAttributes &attrs)
 
void parseParameters (const SUMOSAXAttributes &attrs)
 
void parseStreets (const SUMOSAXAttributes &attrs)
 
void parseCityGates (const SUMOSAXAttributes &attrs)
 
void parseWorkHours ()
 
void parseOpeningHour (const SUMOSAXAttributes &attrs)
 
void parseClosingHour (const SUMOSAXAttributes &attrs)
 
void parseSchools ()
 
void parseSchool (const SUMOSAXAttributes &attrs)
 
void parseBusStation (const SUMOSAXAttributes &attrs)
 
void parseBusLine (const SUMOSAXAttributes &attrs)
 
void parseStations ()
 
void parseRevStations ()
 
void parseStation (const SUMOSAXAttributes &attrs)
 
void parseFrequency (const SUMOSAXAttributes &attrs)
 
void parsePopulation ()
 
void parseBracket (const SUMOSAXAttributes &attrs)
 
 AGActivityGenHandler (const AGActivityGenHandler &src)
 Invalidated copy constructor. More...
 
AGActivityGenHandleroperator= (const AGActivityGenHandler &src)
 Invalidated assignment operator. 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...
 
virtual void myEndElement (int element)
 Callback method for a closing tag 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

Definition at line 46 of file AGActivityGenHandler.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.

Constructor & Destructor Documentation

◆ AGActivityGenHandler() [1/2]

AGActivityGenHandler::AGActivityGenHandler ( AGCity city,
RONet net 
)

Constructor.

Parameters
[in]netThe City instance to fill

Definition at line 50 of file AGActivityGenHandler.cpp.

◆ ~AGActivityGenHandler()

AGActivityGenHandler::~AGActivityGenHandler ( )
virtual

Destructor.

Definition at line 55 of file AGActivityGenHandler.cpp.

◆ AGActivityGenHandler() [2/2]

AGActivityGenHandler::AGActivityGenHandler ( const AGActivityGenHandler src)
private

Invalidated copy constructor.

Member Function Documentation

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

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

◆ 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 MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::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()

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

◆ operator=()

AGActivityGenHandler& AGActivityGenHandler::operator= ( const AGActivityGenHandler src)
private

Invalidated assignment operator.

◆ parseBracket()

◆ parseBusLine()

◆ parseBusStation()

void AGActivityGenHandler::parseBusStation ( const SUMOSAXAttributes attrs)
protected

Bus stations and Bus extraction an additional computation have to be done to create buses' names and buses in the return way

Definition at line 274 of file AGActivityGenHandler.cpp.

References AGEN_TAG_BUSSTATION, AGDataAndStatistics::busStations, SUMOSAXAttributes::getFloat(), SUMOSAXAttributes::getInt(), AGCity::getStreet(), SUMOSAXAttributes::getString(), myCity, AGCity::statData, SUMO_ATTR_EDGE, SUMO_ATTR_ID, SUMO_ATTR_POSITION, SUMOXMLDefinitions::Tags, and WRITE_ERROR.

Referenced by myStartElement().

◆ parseCityGates()

void AGActivityGenHandler::parseCityGates ( const SUMOSAXAttributes attrs)
protected

◆ parseClosingHour()

◆ parseFrequency()

◆ parseGeneralCityInfo()

◆ parseOpeningHour()

◆ parseParameters()

◆ parsePopulation()

void AGActivityGenHandler::parsePopulation ( )
protected

population and children accompaniment bracket extraction then households and all population data will be computable

Definition at line 367 of file AGActivityGenHandler.cpp.

References myCurrentObject.

Referenced by myStartElement().

◆ parseRevStations()

void AGActivityGenHandler::parseRevStations ( )
protected

Definition at line 313 of file AGActivityGenHandler.cpp.

References isRevStation.

Referenced by myStartElement().

◆ parseSchool()

◆ parseSchools()

void AGActivityGenHandler::parseSchools ( )
protected

School extraction

Definition at line 247 of file AGActivityGenHandler.cpp.

References myCurrentObject.

Referenced by myStartElement().

◆ parseStation()

◆ parseStations()

void AGActivityGenHandler::parseStations ( )
protected

Definition at line 308 of file AGActivityGenHandler.cpp.

References isRevStation.

Referenced by myStartElement().

◆ parseStreets()

void AGActivityGenHandler::parseStreets ( const SUMOSAXAttributes attrs)
protected

streets are extracted: it fills the streets list of the City object an additional computation is needed to normalize the number of inhabitants (and workpositions) in each street

Definition at line 165 of file AGActivityGenHandler.cpp.

References AGEN_ATTR_OUT_WORKPOSITION, AGEN_ATTR_POPULATION, AGEN_TAG_STREET, RONet::getEdge(), SUMOSAXAttributes::getFloat(), ROEdge::getLength(), SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), myCity, net, AGStreet::setPopulation(), AGStreet::setWorkplaceNumber(), AGCity::streets, SUMO_ATTR_EDGE, SUMOXMLDefinitions::Tags, and WRITE_ERROR.

Referenced by myStartElement().

◆ parseWorkHours()

void AGActivityGenHandler::parseWorkHours ( )
protected

extraction of work opening and closing hours

Definition at line 212 of file AGActivityGenHandler.cpp.

References myCurrentObject.

Referenced by myStartElement().

◆ registerParent()

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

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string &  name)
inherited

◆ 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

◆ currentBusLine

AGBusLine* AGActivityGenHandler::currentBusLine
protected

Definition at line 147 of file AGActivityGenHandler.h.

Referenced by parseBusLine(), parseFrequency(), and parseStation().

◆ isRevStation

bool AGActivityGenHandler::isRevStation
protected

indicator whether the current station (in bus line context) is a reverse station or not.

Definition at line 150 of file AGActivityGenHandler.h.

Referenced by parseRevStations(), parseStation(), and parseStations().

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

◆ myCity

AGCity& AGActivityGenHandler::myCity
protected

◆ myCurrentObject

std::string AGActivityGenHandler::myCurrentObject
protected

The name of the object that is currently processed.

Definition at line 146 of file AGActivityGenHandler.h.

Referenced by parseBracket(), parseBusLine(), parseClosingHour(), parseFrequency(), parseOpeningHour(), parsePopulation(), parseSchools(), parseStation(), and parseWorkHours().

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

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

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

◆ myProcess

bool AGActivityGenHandler::myProcess
protected

An indicator whether the next edge shall be read (internal edges are not read by now)

Definition at line 156 of file AGActivityGenHandler.h.

◆ 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

◆ net

RONet* AGActivityGenHandler::net
protected

The loaded network.

Definition at line 153 of file AGActivityGenHandler.h.

Referenced by parseStreets().


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