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

A reader for polygons and pois stored in XML-format. More...

#include <PCLoaderXML.h>

Inheritance diagram for PCLoaderXML:
SUMOSAXHandler GenericSAXHandler DefaultHandler

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
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.
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 void loadIfSet (OptionsCont &oc, PCPolyContainer &toFill, PCTypeMap &tm)
 Loads pois/polygons assumed to be stored as XML.

Protected Member Functions

std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message.
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes.
 PCLoaderXML (PCPolyContainer &toFill, PCTypeMap &tm, OptionsCont &oc)
 Constructor.
 ~PCLoaderXML ()
 Destructor.
inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.

Private Attributes

PCPolyContainermyCont
 The container to store the converted polygons/pois into.
OptionsContmyOptions
 Settings to use.
PCTypeMapmyTypeMap
 The type map to use.
Temporary storages used when parsing polygons
std::string myCurrentID
 The id of the currently parsed polygon.
std::string myCurrentType
 The type of the currently parsed polygon.
RGBColor myCurrentColor
 The color of the currently parsed polygon.
bool myCurrentIgnorePrunning
 Whether the current polygon must not be prunned.
SUMOReal myCurrentLayer
 The layer of the currently parsed polygon.

Detailed Description

A reader for polygons and pois stored in XML-format.

Reads pois stored as XML definition. The definitions must match the format POLYCONVERT generates.

Definition at line 58 of file PCLoaderXML.h.

Constructor & Destructor Documentation

PCLoaderXML::PCLoaderXML ( PCPolyContainer toFill,
PCTypeMap tm,
OptionsCont oc 
)
protected

Constructor.

Parameters
[in]toFillThe poly/pois container to add loaded polys/pois to
[in]tmThe type map to use for setting values of loaded polys/pois
[in]ocThe options container to get further options from

Definition at line 90 of file PCLoaderXML.cpp.

PCLoaderXML::~PCLoaderXML ( )
protected

Destructor.

Definition at line 96 of file PCLoaderXML.cpp.

Member Function Documentation

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.

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

void PCLoaderXML::loadIfSet ( OptionsCont oc,
PCPolyContainer toFill,
PCTypeMap tm 
)
static

Loads pois/polygons assumed to be stored as XML.

If the option "xml" is set within the given options container, an instance of PCLoaderXML is built and used as a handler for the files given in this option.

Parameters
[in]ocThe options container to get further options from
[in]toFillThe poly/pois container to add loaded polys/pois to
[in]tmThe type map to use for setting values of loaded polys/pois
Exceptions
ProcessErrorif something fails

Definition at line 65 of file PCLoaderXML.cpp.

References OptionsCont::getStringVector(), FileHelpers::isReadable(), OptionsCont::isSet(), PROGRESS_BEGIN_MESSAGE, PROGRESS_DONE_MESSAGE, and XMLSubSys::runParser().

Referenced by main().

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 GenericSAXHandler::myEndElement ( int  element)
protectedvirtualinherited
void PCLoaderXML::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual
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

PCPolyContainer& PCLoaderXML::myCont
private

The container to store the converted polygons/pois into.

Definition at line 106 of file PCLoaderXML.h.

Referenced by myStartElement().

RGBColor PCLoaderXML::myCurrentColor
private

The color of the currently parsed polygon.

Definition at line 125 of file PCLoaderXML.h.

Referenced by myStartElement().

std::string PCLoaderXML::myCurrentID
private

The id of the currently parsed polygon.

Definition at line 119 of file PCLoaderXML.h.

Referenced by myStartElement().

bool PCLoaderXML::myCurrentIgnorePrunning
private

Whether the current polygon must not be prunned.

Definition at line 128 of file PCLoaderXML.h.

Referenced by myStartElement().

SUMOReal PCLoaderXML::myCurrentLayer
private

The layer of the currently parsed polygon.

Definition at line 131 of file PCLoaderXML.h.

Referenced by myStartElement().

std::string PCLoaderXML::myCurrentType
private

The type of the currently parsed polygon.

Definition at line 122 of file PCLoaderXML.h.

Referenced by myStartElement().

OptionsCont& PCLoaderXML::myOptions
private

Settings to use.

Definition at line 112 of file PCLoaderXML.h.

Referenced by myStartElement().

PCTypeMap& PCLoaderXML::myTypeMap
private

The type map to use.

Definition at line 109 of file PCLoaderXML.h.

Referenced by myStartElement().


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