Eclipse SUMO - Simulation of Urban MObility
PCLoaderXML Class Reference

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

#include <PCLoaderXML.h>

Inheritance diagram for PCLoaderXML:
Collaboration diagram for PCLoaderXML:

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...
 
Position getLanePos (const std::string &poiID, const std::string &laneID, double lanePos, double lanePosLat)
 get position for a given laneID (Has to be implemented in all child) 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...
 
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...
 
static void loadIfSet (OptionsCont &oc, PCPolyContainer &toFill, PCTypeMap &tm)
 Loads pois/polygons assumed to be stored as XML. More...
 

Protected Member Functions

virtual bool addLanePosParams ()
 Whether some input attributes shall be automatically added as params (Can be implemented in all child) 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...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
ParameterisedgetLastParameterised () const
 get last parameterised object More...
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes. More...
 
 PCLoaderXML (PCPolyContainer &toFill, PCTypeMap &tm, OptionsCont &oc)
 Constructor. More...
 
void setDefaults (const std::string &prefix, const RGBColor &color, const double layer, const bool fill=false)
 set default values More...
 
void setSchemaSeen (const bool schemaSeen=true)
 
 ~PCLoaderXML ()
 Destructor. More...
 
inherited from GenericSAXHandler
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;. More...
 
inherited from GenericSAXHandler
virtual void myEndElement (int element)
 Called when a closing tag occurs. More...
 

Protected Attributes

RGBColor myDefaultColor
 The default color to use. More...
 
bool myDefaultFill
 Information whether polygons should be filled. More...
 
double myDefaultLayer
 The default layer to use. More...
 
const GeoConvHelpermyGeoConvHelper
 geo-conversion to use during loading More...
 
ParameterisedmyLastParameterised
 element to receive parameters More...
 
std::string myPrefix
 The prefix to use. More...
 
ShapeContainermyShapeContainer
 reference to shape container in which all Shares are being added More...
 

Private Attributes

OptionsContmyOptions
 Settings to use. More...
 
PCTypeMapmyTypeMap
 The type map to use. More...
 

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 51 of file PCLoaderXML.h.

Constructor & Destructor Documentation

◆ PCLoaderXML()

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 81 of file PCLoaderXML.cpp.

◆ ~PCLoaderXML()

PCLoaderXML::~PCLoaderXML ( )
protected

Destructor.

Definition at line 87 of file PCLoaderXML.cpp.

Member Function Documentation

◆ addLanePosParams()

bool ShapeHandler::addLanePosParams ( )
protectedvirtualinherited

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

Reimplemented in NLShapeHandler, and NIXMLShapeHandler.

Definition at line 274 of file ShapeHandler.cpp.

Referenced by ShapeHandler::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 187 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 170 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().

◆ 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 121 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 206 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 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

◆ getLanePos()

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

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

Implements ShapeHandler.

Definition at line 125 of file PCLoaderXML.cpp.

References Position::INVALID, and ShapeHandler::myShapeContainer.

◆ getLastParameterised()

Parameterised * ShapeHandler::getLastParameterised ( ) const
protectedinherited

get last parameterised object

Definition at line 247 of file ShapeHandler.cpp.

References ShapeHandler::myLastParameterised.

Referenced by GNEAdditionalHandler::parseGenericParameter().

◆ loadFiles()

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

loads all of the given files

Definition at line 253 of file ShapeHandler.cpp.

References XMLSubSys::runParser(), and WRITE_MESSAGE.

Referenced by NLBuilder::build().

◆ loadIfSet()

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

References SysUtils::getCurrentMillis(), OptionsCont::getStringVector(), FileHelpers::isReadable(), OptionsCont::isSet(), PROGRESS_BEGIN_MESSAGE, PROGRESS_TIME_MESSAGE, and XMLSubSys::runParser().

Referenced by main().

◆ 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_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 222 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

◆ myEndElement()

void ShapeHandler::myEndElement ( int  element)
protectedvirtualinherited

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

References ShapeHandler::myLastParameterised, and SUMO_TAG_PARAM.

Referenced by GNEAdditionalHandler::myEndElement(), and NLHandler::networkVersion().

◆ myStartElement()

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

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

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

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), PCNetProjectionLoader::load(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NILoader::loadXMLType(), main(), and XMLSubSys::runParser().

◆ 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 94 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 200 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myDefaultColor

RGBColor ShapeHandler::myDefaultColor
protectedinherited

The default color to use.

Definition at line 118 of file ShapeHandler.h.

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

◆ myDefaultFill

bool ShapeHandler::myDefaultFill
protectedinherited

Information whether polygons should be filled.

Definition at line 124 of file ShapeHandler.h.

Referenced by ShapeHandler::addPoly(), and ShapeHandler::setDefaults().

◆ myDefaultLayer

double ShapeHandler::myDefaultLayer
protectedinherited

The default layer to use.

Definition at line 121 of file ShapeHandler.h.

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

◆ myGeoConvHelper

const GeoConvHelper* ShapeHandler::myGeoConvHelper
protectedinherited

geo-conversion to use during loading

Definition at line 130 of file ShapeHandler.h.

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

◆ myLastParameterised

◆ myOptions

OptionsCont& PCLoaderXML::myOptions
private

Settings to use.

Definition at line 104 of file PCLoaderXML.h.

Referenced by myStartElement().

◆ myPrefix

std::string ShapeHandler::myPrefix
protectedinherited

The prefix to use.

Definition at line 115 of file ShapeHandler.h.

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

◆ myShapeContainer

ShapeContainer& ShapeHandler::myShapeContainer
protectedinherited

reference to shape container in which all Shares are being added

Definition at line 112 of file ShapeHandler.h.

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

◆ myTypeMap

PCTypeMap& PCLoaderXML::myTypeMap
private

The type map to use.

Definition at line 101 of file PCLoaderXML.h.

Referenced by myStartElement().


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