Eclipse SUMO - Simulation of Urban MObility
ShapeHandler Class Referenceabstract

The XML-Handler for network loading. More...

#include <ShapeHandler.h>

Inheritance diagram for ShapeHandler:
Collaboration diagram for ShapeHandler:

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...
 
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...
 
 ShapeHandler (const std::string &file, ShapeContainer &sc, const GeoConvHelper *=nullptr)
 Constructor. 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 ~ShapeHandler ()
 Destructor. More...
 

Static Public Member Functions

static bool loadFiles (const std::vector< std::string > &files, ShapeHandler &sh)
 loads all of the given files More...
 

inherited from GenericSAXHandler

ShapeContainermyShapeContainer
 reference to shape container in which all Shares are being added More...
 
std::string myPrefix
 The prefix to use. More...
 
RGBColor myDefaultColor
 The default color to use. More...
 
double myDefaultLayer
 The default layer to use. More...
 
bool myDefaultFill
 Information whether polygons should be filled. More...
 
ParameterisedmyLastParameterised
 element to receive parameters More...
 
const GeoConvHelpermyGeoConvHelper
 geo-conversion to use during loading More...
 
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...
 
virtual Position getLanePos (const std::string &poiID, const std::string &laneID, double lanePos, double lanePosLat)=0
 get position for a given laneID (Has to be implemented in all child) More...
 
virtual bool addLanePosParams ()
 Whether some input attributes shall be automatically added as params (Can be implemented in all child) More...
 
void setDefaults (const std::string &prefix, const RGBColor &color, const double layer, const bool fill=false)
 set default values More...
 
void addPOI (const SUMOSAXAttributes &attrs, const bool ignorePruning, const bool useProcessing)
 adds a POI More...
 
void addPoly (const SUMOSAXAttributes &attrs, const bool ignorePruning, const bool useProcessing)
 adds a polygon More...
 
ParameterisedgetLastParameterised () const
 get last parameterised object More...
 
 ShapeHandler (const ShapeHandler &s)=delete
 invalidate copy constructor More...
 
ShapeHandleroperator= (const ShapeHandler &s)=delete
 invalidate 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...
 
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

The XML-Handler for network loading.

The SAX2-handler responsible for parsing networks and routes to load. This is an extension of the MSRouteHandler as routes and vehicles may also be loaded from network descriptions.

Definition at line 49 of file ShapeHandler.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

◆ ShapeHandler() [1/2]

ShapeHandler::ShapeHandler ( const std::string &  file,
ShapeContainer sc,
const GeoConvHelper geoConvHelper = nullptr 
)

Constructor.

Parameters
[in]fileName of the parsed file
[in,out]netThe network to fill
[in]detBuilderThe detector builder to use
[in]triggerBuilderThe trigger builder to use
[in]edgeBuilderThe builder of edges to use
[in]junctionBuilderThe builder of junctions to use

Definition at line 44 of file ShapeHandler.cpp.

◆ ~ShapeHandler()

ShapeHandler::~ShapeHandler ( )
virtual

Destructor.

Definition at line 56 of file ShapeHandler.cpp.

◆ ShapeHandler() [2/2]

ShapeHandler::ShapeHandler ( const ShapeHandler s)
protecteddelete

invalidate copy constructor

Member Function Documentation

◆ addLanePosParams()

bool ShapeHandler::addLanePosParams ( )
protectedvirtual

Whether some input attributes shall be automatically added as params (Can be implemented in all child)

Reimplemented in NLShapeHandler, and NIXMLShapeHandler.

Definition at line 294 of file ShapeHandler.cpp.

Referenced by addPOI().

◆ addPOI()

◆ addPoly()

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

◆ getLanePos()

virtual Position ShapeHandler::getLanePos ( const std::string &  poiID,
const std::string &  laneID,
double  lanePos,
double  lanePosLat 
)
protectedpure virtual

get position for a given laneID (Has to be implemented in all child)

Implemented in PCLoaderXML, NLShapeHandler, NIXMLShapeHandler, and GNEAdditionalHandler.

Referenced by addPOI().

◆ getLastParameterised()

Parameterised * ShapeHandler::getLastParameterised ( ) const
protected

get last parameterised object

Definition at line 267 of file ShapeHandler.cpp.

References myLastParameterised.

Referenced by GNEAdditionalHandler::parseParameter().

◆ loadFiles()

bool ShapeHandler::loadFiles ( const std::vector< std::string > &  files,
ShapeHandler sh 
)
static

loads all of the given files

Definition at line 273 of file ShapeHandler.cpp.

References XMLSubSys::runParser(), and WRITE_MESSAGE.

Referenced by NLBuilder::build().

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

void ShapeHandler::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
Todo:
Refactor/describe

Reimplemented from GenericSAXHandler.

Reimplemented in GNEAdditionalHandler.

Definition at line 104 of file ShapeHandler.cpp.

References myLastParameterised, and SUMO_TAG_PARAM.

Referenced by GNEAdditionalHandler::myEndElement().

◆ myStartElement()

void ShapeHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

◆ operator=()

ShapeHandler& ShapeHandler::operator= ( const ShapeHandler s)
protecteddelete

invalidate assignment operator

◆ registerParent()

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

◆ setDefaults()

void ShapeHandler::setDefaults ( const std::string &  prefix,
const RGBColor color,
const double  layer,
const bool  fill = false 
)
protected

set default values

Definition at line 285 of file ShapeHandler.cpp.

References myDefaultColor, myDefaultFill, myDefaultLayer, and myPrefix.

Referenced by GNEAdditionalHandler::GNEAdditionalHandler(), and PCLoaderXML::myStartElement().

◆ 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
Todo:
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

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

◆ myDefaultColor

RGBColor ShapeHandler::myDefaultColor
protected

The default color to use.

Definition at line 117 of file ShapeHandler.h.

Referenced by addPOI(), addPoly(), and setDefaults().

◆ myDefaultFill

bool ShapeHandler::myDefaultFill
protected

Information whether polygons should be filled.

Definition at line 123 of file ShapeHandler.h.

Referenced by addPoly(), and setDefaults().

◆ myDefaultLayer

double ShapeHandler::myDefaultLayer
protected

The default layer to use.

Definition at line 120 of file ShapeHandler.h.

Referenced by addPOI(), addPoly(), myStartElement(), and setDefaults().

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

◆ myGeoConvHelper

const GeoConvHelper* ShapeHandler::myGeoConvHelper
protected

geo-conversion to use during loading

Definition at line 129 of file ShapeHandler.h.

Referenced by addPOI(), addPoly(), and GNEAdditionalHandler::parseAndBuildPoly().

◆ myLastParameterised

Parameterised* ShapeHandler::myLastParameterised
protected

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

◆ myPrefix

std::string ShapeHandler::myPrefix
protected

The prefix to use.

Definition at line 114 of file ShapeHandler.h.

Referenced by addPOI(), addPoly(), and setDefaults().

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

◆ myShapeContainer

ShapeContainer& ShapeHandler::myShapeContainer
protected

reference to shape container in which all Shares are being added

Definition at line 111 of file ShapeHandler.h.

Referenced by addPOI(), addPoly(), PCLoaderXML::getLanePos(), GNEAdditionalHandler::parseAndBuildPOI(), and GNEAdditionalHandler::parseAndBuildPoly().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
privateinherited

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