Eclipse SUMO - Simulation of Urban MObility
PCLoaderOSM Class Reference

A reader of pois and polygons stored in OSM-format. More...

#include <PCLoaderOSM.h>

Inheritance diagram for PCLoaderOSM:
Collaboration diagram for PCLoaderOSM:

Data Structures

class  EdgesHandler
 A class which extracts OSM-edges from a parsed OSM-file. More...
 
class  NodesHandler
 A class which extracts OSM-nodes from a parsed OSM-file. More...
 
struct  PCOSMEdge
 An internal definition of a loaded edge. More...
 
struct  PCOSMNode
 An internal representation of an OSM-node. More...
 
struct  PCOSMRelation
 An internal definition of a loaded relation. More...
 
class  RelationsHandler
 A class which extracts relevant way-ids from relations in a parsed OSM-file. More...
 

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

Static Public Member Functions

static void loadIfSet (OptionsCont &oc, PCPolyContainer &toFill, PCTypeMap &tm)
 Loads pois/polygons assumed to be stored as OSM-XML. More...
 

Protected Types

typedef std::map< long long int, PCOSMEdge * > EdgeMap
 
typedef std::vector< PCOSMRelation * > Relations
 
typedef std::map< long long int, PCOSMRelation * > RelationsMap
 

Static Protected Member Functions

static int addPOI (const PCOSMNode *node, const Position &pos, const PCTypeMap::TypeDef &def, const std::string &fullType, int index, bool useName, PCPolyContainer &toFill, bool ignorePruning, bool withAttributes)
 try add the POI and return the next index on success More...
 
static int addPolygon (const PCOSMEdge *edge, const PositionVector &vec, const PCTypeMap::TypeDef &def, const std::string &fullType, int index, bool useName, PCPolyContainer &toFill, bool ignorePruning, bool withAttributes)
 try add the polygon and return the next index on success More...
 

Static Protected Attributes

static const std::set< std::string > MyKeysToInclude
 

Static Private Member Functions

static Position convertNodePosition (PCOSMNode *n)
 retrieve cartesian coordinate for given node More...
 
static std::set< std::string > initMyKeysToInclude ()
 

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 myStartElement (int element, const SUMOSAXAttributes &attrs)
 Callback method for an opening tag to implement by derived classes. 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

A reader of pois and polygons stored in OSM-format.

Reads pois stored as XML definition as given by the OpenStreetMap-API.

Definition at line 49 of file PCLoaderOSM.h.

Member Typedef Documentation

◆ AttrMap

typedef std::map<int, XMLCh*> GenericSAXHandler::AttrMap
privateinherited

Definition at line 285 of file GenericSAXHandler.h.

◆ EdgeMap

typedef std::map<long long int, PCOSMEdge*> PCLoaderOSM::EdgeMap
protected

Definition at line 119 of file PCLoaderOSM.h.

◆ Relations

typedef std::vector<PCOSMRelation*> PCLoaderOSM::Relations
protected

Definition at line 117 of file PCLoaderOSM.h.

◆ RelationsMap

typedef std::map<long long int, PCOSMRelation*> PCLoaderOSM::RelationsMap
protected

Definition at line 118 of file PCLoaderOSM.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
privateinherited

Definition at line 299 of file GenericSAXHandler.h.

Member Function Documentation

◆ addPOI()

int PCLoaderOSM::addPOI ( const PCOSMNode node,
const Position pos,
const PCTypeMap::TypeDef def,
const std::string &  fullType,
int  index,
bool  useName,
PCPolyContainer toFill,
bool  ignorePruning,
bool  withAttributes 
)
staticprotected

◆ addPolygon()

int PCLoaderOSM::addPolygon ( const PCOSMEdge edge,
const PositionVector vec,
const PCTypeMap::TypeDef def,
const std::string &  fullType,
int  index,
bool  useName,
PCPolyContainer toFill,
bool  ignorePruning,
bool  withAttributes 
)
staticprotected

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

◆ convertNodePosition()

Position PCLoaderOSM::convertNodePosition ( PCOSMNode n)
staticprivate

retrieve cartesian coordinate for given node

Definition at line 342 of file PCLoaderOSM.cpp.

References GeoConvHelper::getProcessing(), PCLoaderOSM::PCOSMNode::lat, PCLoaderOSM::PCOSMNode::lon, and GeoConvHelper::x2cartesian().

Referenced by loadIfSet().

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

◆ initMyKeysToInclude()

std::set< std::string > PCLoaderOSM::initMyKeysToInclude ( )
staticprivate

Definition at line 58 of file PCLoaderOSM.cpp.

◆ loadIfSet()

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

Loads pois/polygons assumed to be stored as OSM-XML.

If the option "osm-files" is set within the given options container, an instance of PCLoaderOSM 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 91 of file PCLoaderOSM.cpp.

References addPOI(), addPolygon(), convertNodePosition(), PCTypeMap::TypeDef::discard, Position::distanceTo2D(), PCTypeMap::get(), OptionsCont::getBool(), PCTypeMap::getDefault(), MsgHandler::getErrorInstance(), OptionsCont::getFloat(), OptionsCont::getOptions(), GeoConvHelper::getProcessing(), OptionsCont::getStringVector(), MsgHandler::getWarningInstance(), PCTypeMap::has(), PCLoaderOSM::PCOSMNode::id, PCLoaderOSM::PCOSMEdge::id, Position::INVALID, OptionsCont::isInStringVector(), FileHelpers::isReadable(), OptionsCont::isSet(), PCLoaderOSM::PCOSMNode::lat, PCLoaderOSM::PCOSMNode::lon, PCLoaderOSM::PCOSMNode::myAttributes, PCLoaderOSM::PCOSMEdge::myAttributes, PCLoaderOSM::PCOSMEdge::myCurrentNodes, PCLoaderOSM::PCOSMEdge::myIsClosed, MyKeysToInclude, PCLoaderOSM::PCOSMEdge::name, PROGRESS_BEGIN_TIME_MESSAGE, PROGRESS_TIME_MESSAGE, PositionVector::push_back_noDoublePos(), XMLSubSys::runParser(), PCLoaderOSM::PCOSMEdge::standalone, toString(), WRITE_ERROR, WRITE_MESSAGE, and WRITE_WARNING.

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

void GenericSAXHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtualinherited

Callback method for an opening tag to implement by derived classes.

Called by "startElement" (see there).

Parameters
[in]elementThe element that contains the characters, given as a int
[in]attrsThe SAX-attributes, wrapped as SUMOSAXAttributes @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenStreetMap::RelationHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenDrive, NIImporter_Vissim::NIVissimXMLHandler_ConflictArea, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, GUINet::DiscoverAttributes, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, PCLoaderOSM::EdgesHandler, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, PCLoaderOSM::RelationsHandler, NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition, GNEParametersDialog::ParametersOptions::GNEParameterHandler, MSTriggeredRerouter, PCLoaderOSM::NodesHandler, SAXWeightsHandler, NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition, NIImporter_MATSim::EdgesHandler, NLHandler, MSCalibrator, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, MSLaneSpeedTrigger, NIImporter_SUMO, NIImporter_MATSim::NodesHandler, NIImporter_ITSUMO::Handler, PCLoaderXML, NIXMLEdgesHandler, NIXMLNodesHandler, SUMORouteHandler, TrajectoriesHandler, GNEAdditionalHandler, NIXMLPTHandler, PCNetProjectionLoader, RORouteHandler, ROJTRTurnDefLoader, ODDistrictHandler, ShapeHandler, MSRouteHandler, RONetHandler, MSStateHandler, NIXMLConnectionsHandler, ODAmitranHandler, NIXMLTrafficLightsHandler, NIXMLTypesHandler, PCTypeDefHandler, AGActivityGenHandler, GUISettingsHandler, ROMARouteHandler, and RODFDetectorHandler.

Definition at line 217 of file GenericSAXHandler.cpp.

Referenced by SUMOSAXReader::parseNext(), and GenericSAXHandler::startElement().

◆ 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

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

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

◆ MyKeysToInclude

const std::set< std::string > PCLoaderOSM::MyKeysToInclude
staticprotected

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

◆ 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

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