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

Loader for the of turning percentages and source/sink definitions. More...

#include <ROJTRTurnDefLoader.h>

Inheritance diagram for ROJTRTurnDefLoader:
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.
 ROJTRTurnDefLoader (RONet &net)
 Constructor.
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 Attributes &attrs)
 The inherited method called when a new tag opens.
 ~ROJTRTurnDefLoader ()
 Destructor.
SAX ErrorHandler callbacks
void warning (const SAXParseException &exception)
 Handler for XML-warnings.
void error (const SAXParseException &exception)
 Handler for XML-errors.
void fatalError (const SAXParseException &exception)
 Handler for XML-errors.

Protected Member Functions

std::string buildErrorMessage (const SAXParseException &exception)
 Builds an error message.
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes.
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.
void myCharacters (int element, const std::string &chars)
 Called when characters occure.

Private Member Functions

void addToEdge (const SUMOSAXAttributes &attrs)
 Parses the probability to use a certain outgoing edge.
void beginFromEdge (const SUMOSAXAttributes &attrs)
 Begins the processing of a incoming edge definition.

Private Attributes

ROJTREdgemyEdge
 The current incoming edge the turning probabilities are set into.
bool myHaveWarnedAboutDeprecatedFromEdge
bool myHaveWarnedAboutDeprecatedSinks
bool myHaveWarnedAboutDeprecatedSources
 Whether the loader has warned about deprecated usage of characters.
bool myHaveWarnedAboutDeprecatedToEdge
SUMOTime myIntervalBegin
 The begin and the end of the current interval.
SUMOTime myIntervalEnd
RONetmyNet
 The network to set the information into.

Detailed Description

Loader for the of turning percentages and source/sink definitions.

This handler parses XML-descriptions of jtrrouter-definitions, including percentage ratios at junctions and definitions of sink/source edges.

All read values are stored directly into the given network's structures (edges).

Definition at line 62 of file ROJTRTurnDefLoader.h.


Constructor & Destructor Documentation

ROJTRTurnDefLoader::ROJTRTurnDefLoader ( RONet net)

Constructor.

Parameters:
[in]netThe net to add loaded turning percentages into

Definition at line 55 of file ROJTRTurnDefLoader.cpp.

ROJTRTurnDefLoader::~ROJTRTurnDefLoader ( )

Destructor.

Definition at line 64 of file ROJTRTurnDefLoader.cpp.


Member Function Documentation

void ROJTRTurnDefLoader::addToEdge ( const SUMOSAXAttributes attrs)
private

Parses the probability to use a certain outgoing edge.

Tries to retreive the outgoing edge and then the probability to use it. If one of both operations could not be accomplished, an error is generated.

If everything is ok, this means the destination edge is defined and known and the probability is valid, too, this probability is added to "myEdge", the last parsed incoming edge. As time, the previously parsed interval begin/end is used.

Parameters:
[in]attrsThe SAX-attributes to parse the destination edge and the probability to use it from

Definition at line 179 of file ROJTRTurnDefLoader.cpp.

References ROJTREdge::addFollowerProbability(), RONet::getEdge(), SUMOSAXAttributes::getStringReporting(), SUMOSAXAttributes::getSUMORealReporting(), myEdge, myIntervalBegin, myIntervalEnd, myNet, SUMO_ATTR_ID, SUMO_ATTR_PROB, SUMOReal, and WRITE_ERROR.

Referenced by myStartElement().

void ROJTRTurnDefLoader::beginFromEdge ( const SUMOSAXAttributes attrs)
private

Begins the processing of a incoming edge definition.

Tries to retrieve the currently described incoming edge. If the edge id is not given in the attributes or the edge is not known, an error is reported.

If everything is ok, the edge's address is stored in myEdge.

Parameters:
[in]attrsThe SAX-attributes to parse incoming edge from

Definition at line 161 of file ROJTRTurnDefLoader.cpp.

References RONet::getEdge(), SUMOSAXAttributes::getStringReporting(), myEdge, myNet, SUMO_ATTR_ID, and WRITE_ERROR.

Referenced by myStartElement().

std::string GenericSAXHandler::buildErrorMessage ( const 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 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 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 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 NLHandler::getLanesFromIndices().

void GenericSAXHandler::fatalError ( const 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 ROJTRTurnDefLoader::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtual

Called when characters occure.

Parameters:
[in]elementID of the last opened element
[in]charsThe read characters (complete)
Exceptions:
ProcessErrorIf something fails
See also:
GenericSAXHandler::myCharacters

Reimplemented from GenericSAXHandler.

Definition at line 127 of file ROJTRTurnDefLoader.cpp.

References ROEdge::ET_SINK, ROEdge::ET_SOURCE, RONet::getEdge(), myHaveWarnedAboutDeprecatedSinks, myHaveWarnedAboutDeprecatedSources, myNet, ROEdge::setType(), SUMO_TAG_SINK, SUMO_TAG_SOURCE, and WRITE_WARNING.

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

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 168 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

void GenericSAXHandler::setFileName ( const std::string &  name)
inherited
void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const 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 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 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

ROJTREdge* ROJTRTurnDefLoader::myEdge
private

The current incoming edge the turning probabilities are set into.

Definition at line 140 of file ROJTRTurnDefLoader.h.

Referenced by addToEdge(), and beginFromEdge().

bool ROJTRTurnDefLoader::myHaveWarnedAboutDeprecatedFromEdge
private

Definition at line 144 of file ROJTRTurnDefLoader.h.

Referenced by myStartElement().

bool ROJTRTurnDefLoader::myHaveWarnedAboutDeprecatedSinks
private

Definition at line 143 of file ROJTRTurnDefLoader.h.

Referenced by myCharacters().

bool ROJTRTurnDefLoader::myHaveWarnedAboutDeprecatedSources
private

Whether the loader has warned about deprecated usage of characters.

Definition at line 143 of file ROJTRTurnDefLoader.h.

Referenced by myCharacters().

bool ROJTRTurnDefLoader::myHaveWarnedAboutDeprecatedToEdge
private

Definition at line 144 of file ROJTRTurnDefLoader.h.

Referenced by myStartElement().

SUMOTime ROJTRTurnDefLoader::myIntervalBegin
private

The begin and the end of the current interval.

Definition at line 137 of file ROJTRTurnDefLoader.h.

Referenced by addToEdge(), and myStartElement().

SUMOTime ROJTRTurnDefLoader::myIntervalEnd
private

Definition at line 137 of file ROJTRTurnDefLoader.h.

Referenced by addToEdge(), and myStartElement().

RONet& ROJTRTurnDefLoader::myNet
private

The network to set the information into.

Definition at line 134 of file ROJTRTurnDefLoader.h.

Referenced by addToEdge(), beginFromEdge(), myCharacters(), and myStartElement().


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