SUMO - Simulation of Urban MObility
TrajectoriesHandler Class Reference

An XML-Handler for amitran and netstate trajectories. More...

#include <TrajectoriesHandler.h>

Inheritance diagram for TrajectoriesHandler:
SUMOSAXHandler GenericSAXHandler

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured. More...
 
const PollutantsInterface::Emissions computeEmissions (const std::string id, const SUMOEmissionClass c, const SUMOReal v, SUMOReal &a, SUMOReal &s)
 
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...
 
 TrajectoriesHandler (const bool computeA, const SUMOEmissionClass defaultClass, const SUMOReal defaultSlope, OutputDevice *xmlOut)
 Constructor. More...
 
void writeEmissions (std::ostream &o, const std::string id, const SUMOEmissionClass c, const SUMOReal t, const SUMOReal v, SUMOReal a=INVALID_VALUE, SUMOReal s=INVALID_VALUE)
 
void writeSums (std::ostream &o, const std::string id)
 
void writeXMLEmissions (const std::string id, const SUMOEmissionClass c, const SUMOTime t, const SUMOReal v, SUMOReal a=INVALID_VALUE, SUMOReal s=INVALID_VALUE)
 
 ~TrajectoriesHandler ()
 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 Attributes

static const int INVALID_VALUE = -999999
 

Protected Member Functions

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...
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes. More...
 
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called when an opening-tag occurs. More...
 

Private Member Functions

TrajectoriesHandleroperator= (const TrajectoriesHandler &s)
 invalidated assignment operator More...
 
 TrajectoriesHandler (const TrajectoriesHandler &s)
 invalidated copy constructor More...
 

Private Attributes

const bool myComputeA
 
SUMOTime myCurrentTime
 
const SUMOEmissionClass myDefaultClass
 
const SUMOReal myDefaultSlope
 
std::map< std::string, SUMOEmissionClassmyEmissionClassByType
 
std::map< std::string, SUMOEmissionClassmyEmissionClassByVehicle
 
std::map< std::string, SUMORealmyLastV
 
std::map< std::string, PollutantsInterface::EmissionsmySums
 
OutputDevicemyXMLOut
 

Detailed Description

An XML-Handler for amitran and netstate trajectories.

This SUMOSAXHandler parses vehicles and their speeds.

Definition at line 47 of file TrajectoriesHandler.h.

Constructor & Destructor Documentation

TrajectoriesHandler::TrajectoriesHandler ( const bool  computeA,
const SUMOEmissionClass  defaultClass,
const SUMOReal  defaultSlope,
OutputDevice xmlOut 
)

Constructor.

Parameters
[in]fileThe file that will be processed

Definition at line 51 of file TrajectoriesHandler.cpp.

TrajectoriesHandler::~TrajectoriesHandler ( )

Destructor.

Definition at line 57 of file TrajectoriesHandler.cpp.

TrajectoriesHandler::TrajectoriesHandler ( const TrajectoriesHandler s)
private

invalidated copy constructor

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.

const PollutantsInterface::Emissions TrajectoriesHandler::computeEmissions ( const std::string  id,
const SUMOEmissionClass  c,
const SUMOReal  v,
SUMOReal a,
SUMOReal s 
)
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 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 TrajectoriesHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual
TrajectoriesHandler& TrajectoriesHandler::operator= ( const TrajectoriesHandler s)
private

invalidated assignment operator

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.

void TrajectoriesHandler::writeSums ( std::ostream &  o,
const std::string  id 
)

Definition at line 159 of file TrajectoriesHandler.cpp.

References mySums.

Field Documentation

const int TrajectoriesHandler::INVALID_VALUE = -999999
static

Definition at line 49 of file TrajectoriesHandler.h.

Referenced by computeEmissions(), main(), and myStartElement().

const bool TrajectoriesHandler::myComputeA
private

Definition at line 99 of file TrajectoriesHandler.h.

Referenced by computeEmissions().

SUMOTime TrajectoriesHandler::myCurrentTime
private

Definition at line 104 of file TrajectoriesHandler.h.

Referenced by myStartElement(), and writeXMLEmissions().

const SUMOEmissionClass TrajectoriesHandler::myDefaultClass
private

Definition at line 100 of file TrajectoriesHandler.h.

Referenced by myStartElement().

const SUMOReal TrajectoriesHandler::myDefaultSlope
private

Definition at line 101 of file TrajectoriesHandler.h.

Referenced by computeEmissions().

std::map<std::string, SUMOEmissionClass> TrajectoriesHandler::myEmissionClassByType
private

Definition at line 106 of file TrajectoriesHandler.h.

Referenced by myStartElement().

std::map<std::string, SUMOEmissionClass> TrajectoriesHandler::myEmissionClassByVehicle
private

Definition at line 107 of file TrajectoriesHandler.h.

Referenced by myStartElement().

std::map<std::string, SUMOReal> TrajectoriesHandler::myLastV
private

Definition at line 103 of file TrajectoriesHandler.h.

Referenced by computeEmissions().

std::map<std::string, PollutantsInterface::Emissions> TrajectoriesHandler::mySums
private

Definition at line 105 of file TrajectoriesHandler.h.

Referenced by computeEmissions(), and writeSums().

OutputDevice* TrajectoriesHandler::myXMLOut
private

Definition at line 102 of file TrajectoriesHandler.h.

Referenced by myStartElement(), and writeXMLEmissions().


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