SUMO - Simulation of Urban MObility
ShapeHandler Class Referenceabstract

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

#include <ShapeHandler.h>

Inheritance diagram for ShapeHandler:
Inheritance graph
Collaboration diagram for ShapeHandler:
Collaboration graph

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...
 
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)
 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...
 
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 loadFiles (const std::vector< std::string > &files, ShapeHandler &sh)
 loads all of the given files More...
 

Protected Member Functions

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...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
virtual Position getLanePos (const std::string &poiID, const std::string &laneID, SUMOReal lanePos)=0
 get position for a given laneID 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 setDefaults (const std::string &prefix, const RGBColor &color, const SUMOReal layer, const bool fill=false)
 
inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 

Protected Attributes

ShapeContainermyShapeContainer
 

Private Member Functions

ShapeHandleroperator= (const ShapeHandler &s)
 
 ShapeHandler (const ShapeHandler &s)
 

Private Attributes

RGBColor myDefaultColor
 The default color to use. More...
 
bool myDefaultFill
 Information whether polygons should be filled. More...
 
SUMOReal myDefaultLayer
 The default layer to use. More...
 
std::string myPrefix
 The prefix to use. 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 56 of file ShapeHandler.h.

Constructor & Destructor Documentation

§ ShapeHandler() [1/2]

ShapeHandler::ShapeHandler ( const std::string &  file,
ShapeContainer sc 
)

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 55 of file ShapeHandler.cpp.

§ ~ShapeHandler()

ShapeHandler::~ShapeHandler ( )
virtual

Destructor.

Definition at line 60 of file ShapeHandler.cpp.

§ ShapeHandler() [2/2]

ShapeHandler::ShapeHandler ( const ShapeHandler s)
private

invalid copy constructor

Member Function Documentation

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

References GenericSAXHandler::getFileName().

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

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

§ 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 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.

§ 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 occured exception to process
Exceptions
ProcessErrorOn any call

Definition at line 211 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), NIImporter_OpenDrive::geomFromSpiral(), MSRouteHandler::myStartElement(), and MSRouteHandler::parseWalkPos().

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

Definition at line 217 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

§ getFileName()

§ getLanePos()

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

get position for a given laneID

Implemented in GNEApplicationWindow::GNEShapeHandler, PCLoaderXML, and NLShapeHandler.

Referenced by addPOI().

§ loadFiles()

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

loads all of the given files

Definition at line 191 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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_ITSUMO::Handler.

Definition at line 227 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

§ myEndElement()

§ myStartElement()

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

Reimplemented from GenericSAXHandler.

Reimplemented in PCLoaderXML.

Definition at line 64 of file ShapeHandler.cpp.

References addPOI(), addPoly(), Shape::DEFAULT_LAYER, GLO_POI, myDefaultLayer, SUMO_TAG_POI, SUMO_TAG_POLY, SUMOReal, and WRITE_ERROR.

Referenced by NLHandler::networkVersion().

§ operator=()

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

invalid assignment operator

§ registerParent()

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

§ setDefaults()

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

Definition at line 203 of file ShapeHandler.cpp.

References myDefaultColor, myDefaultFill, myDefaultLayer, and myPrefix.

Referenced by PCLoaderXML::myStartElement().

§ setFileName()

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_Vissim::loadXML(), NILoader::loadXMLType(), main(), and XMLSubSys::runParser().

§ 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 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.

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

Definition at line 205 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

§ myDefaultColor

RGBColor ShapeHandler::myDefaultColor
private

The default color to use.

Definition at line 116 of file ShapeHandler.h.

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

§ myDefaultFill

bool ShapeHandler::myDefaultFill
private

Information whether polygons should be filled.

Definition at line 120 of file ShapeHandler.h.

Referenced by addPoly(), and setDefaults().

§ myDefaultLayer

SUMOReal ShapeHandler::myDefaultLayer
private

The default layer to use.

Definition at line 118 of file ShapeHandler.h.

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

§ myPrefix

std::string ShapeHandler::myPrefix
private

The prefix to use.

Definition at line 114 of file ShapeHandler.h.

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

§ myShapeContainer

ShapeContainer& ShapeHandler::myShapeContainer
protected

Definition at line 110 of file ShapeHandler.h.

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


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