SUMO - Simulation of Urban MObility
RORDGenerator_ODAmounts Class Reference

#include <RORDGenerator_ODAmounts.h>

Inheritance diagram for RORDGenerator_ODAmounts:
RORDLoader_TripDefs ROTypedXMLRoutesLoader SUMOSAXHandler GenericSAXHandler DefaultHandler

Data Structures

class  FlowDef

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occured.
void endDocument ()
 Called when the document has ended.
bool ended () const
 Returns the information whether no routes are available from this loader anymore.
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
SUMOTime getLastReadTimeStep () const
 Returns the time the current (last read) route starts at.
bool readRoutesAtLeastUntil (SUMOTime until)
 Adds routes from the file until the given time is reached.
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed.
 RORDGenerator_ODAmounts (RONet &net, SUMOTime begin, SUMOTime end, bool emptyDestinationsAllowed, bool randomize, const std::string &file="")
 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.
 ~RORDGenerator_ODAmounts ()
 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.
ROEdgegetEdge (const SUMOSAXAttributes &attrs, const std::string &purpose, SumoXMLAttr which, const std::string &id, bool emptyAllowed)
 Parses a named edge frm the attributes.
std::string getVehicleID (const SUMOSAXAttributes &attrs)
 Parses the vehicle id.
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
void myEndFlowAmountDef ()
 Closes the trip amount parsing.
void parseFlowAmountDef (const SUMOSAXAttributes &attrs)
 Parses the trip amount definition.
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag;.
void myEndElement (int element)
 Called when a closing tag occurs.

Protected Attributes

SUMOTime myBegin
 The time for which the first route shall be loaded.
ROEdgemyBeginEdge
 The starting edge.
SUMOTime myCurrentDepart
 The currently read vehicle's depart.
SUMOVTypeParametermyCurrentVehicleType
 The currently parsed vehicle type.
const bool myEmptyDestinationsAllowed
 Information whether empty destinations are allowed This is a feature used for the handling of explicit routes within the jtrrouter where the destination is not necessary.
SUMOTime myEnd
 The time for which the first route shall be loaded.
bool myEnded
 Information whether the whole file has been parsed.
ROEdgemyEndEdge
 The end edge.
bool myHaveWarnedAboutDeprecatedTripDef
IDSupplier myIdSupplier
 generates numerical ids
RONetmyNet
 The network to add routes to.
bool myNextRouteRead
 The information whether the next route was read.
SUMOVehicleParametermyParameter
SAX2XMLReader * myParser
 The parser used.
XMLPScanToken myToken
 Information about the current position within the file.
const bool myWithTaz
 Information whether zones (districts) are used as origins / destinations.

Private Types

typedef std::vector< FlowDef * > FlowDefV
 Definition of a container for flo definitions (vector)

Private Member Functions

void buildForTimeStep (SUMOTime time)
 Builds the routes for the given time step.
RORDGenerator_ODAmountsoperator= (const RORDGenerator_ODAmounts &src)
 Invalidated assignment operator.
 RORDGenerator_ODAmounts (const RORDGenerator_ODAmounts &src)
 Invalidated copy constructor.

Private Attributes

SUMOTime myCurrentTimeStep
 The current time step read.
FlowDefV myFlows
 The definitions of the read flows.
bool myHaveWarnedAboutDeprecatedNumber
SUMOTime myIntervalBegin
 The begin of the interval current read.
SUMOTime myIntervalEnd
 The end of the interval current read.
std::set< std::string > myKnownIDs
 A storage for ids (!!! this should be done router-wide)
bool myRandom
 Information whether randomized departures are used.
SUMOTime myUpperIntervalBegin
 The begin of the embedding interval (if given)
SUMOTime myUpperIntervalEnd
 The end of the embedding interval (if given)
unsigned int myVehicle2InsertNumber
 The number of vehicles to insert.

Detailed Description

This class is a file-based generator. Within the first step, all route definitions are parsed into the memory from a file and then consecutively build on demand.

Definition at line 54 of file RORDGenerator_ODAmounts.h.


Member Typedef Documentation

typedef std::vector<FlowDef*> RORDGenerator_ODAmounts::FlowDefV [private]

Definition of a container for flo definitions (vector)

Definition at line 185 of file RORDGenerator_ODAmounts.h.


Constructor & Destructor Documentation

RORDGenerator_ODAmounts::RORDGenerator_ODAmounts ( RONet net,
SUMOTime  begin,
SUMOTime  end,
bool  emptyDestinationsAllowed,
bool  randomize,
const std::string &  file = "" 
)

Destructor.

Definition at line 155 of file RORDGenerator_ODAmounts.cpp.

References myFlows.

Invalidated copy constructor.


Member Function Documentation

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException &  exception) [protected, inherited]

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.

Called when the document has ended.

Todo:
Recheck usage of route loaders; it is not very fine to have one that use a parser and other that do not

Definition at line 83 of file ROTypedXMLRoutesLoader.cpp.

References ROTypedXMLRoutesLoader::myEnded.

bool ROTypedXMLRoutesLoader::ended ( ) const [inline, inherited]

Returns the information whether no routes are available from this loader anymore.

Returns:
Whether the whole input has been processed

Definition at line 102 of file ROTypedXMLRoutesLoader.h.

References ROTypedXMLRoutesLoader::myEnded.

Referenced by ROTypedXMLRoutesLoader::readRoutesAtLeastUntil().

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

ROEdge * RORDLoader_TripDefs::getEdge ( const SUMOSAXAttributes attrs,
const std::string &  purpose,
SumoXMLAttr  which,
const std::string &  id,
bool  emptyAllowed 
) [protected, inherited]

Returns the time the current (last read) route starts at.

Returns:
The least time step that was read by this reader

Definition at line 93 of file ROTypedXMLRoutesLoader.h.

References ROTypedXMLRoutesLoader::myCurrentDepart.

Referenced by ROTypedXMLRoutesLoader::readRoutesAtLeastUntil().

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
) [protected, virtual, inherited]

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, NIImporter_SUMO, PCNetProjectionLoader, NIImporter_ITSUMO::Handler, PCLoaderXML, RORDLoader_SUMOBase, and ROJTRTurnDefLoader.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void RORDGenerator_ODAmounts::myEndElement ( int  element) [protected, virtual]

Called when a closing tag occurs.

Parameters:
[in]elementID of the currently opened element
Exceptions:
ProcessErrorIf something fails
See also:
GenericSAXHandler::myEndElement

Reimplemented from RORDLoader_TripDefs.

Definition at line 255 of file RORDGenerator_ODAmounts.cpp.

References myEndFlowAmountDef(), myUpperIntervalBegin, myUpperIntervalEnd, SUMO_TAG_FLOW, and SUMO_TAG_INTERVAL.

void RORDGenerator_ODAmounts::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
) [protected, virtual]

Called on the opening of a tag;.

Parameters:
[in]elementID of the currently opened element
[in]attrsAttributes within the currently opened element
Exceptions:
ProcessErrorIf something fails
See also:
GenericSAXHandler::myStartElement

Reimplemented from RORDLoader_TripDefs.

Definition at line 200 of file RORDGenerator_ODAmounts.cpp.

References SUMOSAXAttributes::getOptSUMOTimeReporting(), myUpperIntervalBegin, myUpperIntervalEnd, parseFlowAmountDef(), SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_TAG_FLOW, and SUMO_TAG_INTERVAL.

RORDGenerator_ODAmounts& RORDGenerator_ODAmounts::operator= ( const RORDGenerator_ODAmounts src) [private]

Invalidated assignment operator.

Adds routes from the file until the given time is reached.

Parameters:
[in]timeThe time until which route definitions shall be loaded
Returns:
Whether any errors occured
Exceptions:
ProcessErrorIf a major error occured
See also:
ROAbstractRouteDefLoader::readRoutesAtLeastUntil

Reimplemented from ROTypedXMLRoutesLoader.

Definition at line 163 of file RORDGenerator_ODAmounts.cpp.

References buildForTimeStep(), DELTA_T, ROTypedXMLRoutesLoader::myBegin, and ROTypedXMLRoutesLoader::myCurrentDepart.

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

SUMOTime ROTypedXMLRoutesLoader::myBegin [protected, inherited]

The time for which the first route shall be loaded.

Definition at line 119 of file ROTypedXMLRoutesLoader.h.

Referenced by RORDLoader_SUMOBase::closeVehicle(), myEndFlowAmountDef(), and readRoutesAtLeastUntil().

The current time step read.

Definition at line 182 of file RORDGenerator_ODAmounts.h.

The currently parsed vehicle type.

Definition at line 117 of file RORDLoader_TripDefs.h.

Referenced by RORDLoader_TripDefs::myEndElement(), and RORDLoader_TripDefs::myStartElement().

Information whether empty destinations are allowed This is a feature used for the handling of explicit routes within the jtrrouter where the destination is not necessary.

Definition at line 111 of file RORDLoader_TripDefs.h.

Referenced by RORDLoader_TripDefs::myStartElement(), and parseFlowAmountDef().

SUMOTime ROTypedXMLRoutesLoader::myEnd [protected, inherited]

The time for which the first route shall be loaded.

Definition at line 122 of file ROTypedXMLRoutesLoader.h.

Referenced by buildForTimeStep(), RORDLoader_SUMOBase::closeVehicle(), and RORDLoader_TripDefs::myEndElement().

bool ROTypedXMLRoutesLoader::myEnded [protected, inherited]

Information whether the whole file has been parsed.

Definition at line 137 of file ROTypedXMLRoutesLoader.h.

Referenced by buildForTimeStep(), ROTypedXMLRoutesLoader::endDocument(), and ROTypedXMLRoutesLoader::ended().

The definitions of the read flows.

Definition at line 188 of file RORDGenerator_ODAmounts.h.

Referenced by buildForTimeStep(), myEndFlowAmountDef(), and ~RORDGenerator_ODAmounts().

generates numerical ids

Definition at line 100 of file RORDLoader_TripDefs.h.

Referenced by RORDLoader_TripDefs::getVehicleID().

std::set<std::string> RORDGenerator_ODAmounts::myKnownIDs [private]

A storage for ids (!!! this should be done router-wide)

Definition at line 191 of file RORDGenerator_ODAmounts.h.

Referenced by parseFlowAmountDef().

Information whether randomized departures are used.

Definition at line 194 of file RORDGenerator_ODAmounts.h.

Referenced by RORDGenerator_ODAmounts::FlowDef::addRoutes(), and myEndFlowAmountDef().

XMLPScanToken ROTypedXMLRoutesLoader::myToken [protected, inherited]

Information about the current position within the file.

Definition at line 128 of file ROTypedXMLRoutesLoader.h.

Referenced by ROTypedXMLRoutesLoader::readRoutesAtLeastUntil(), RORDGenerator_ODAmounts(), and ROTypedXMLRoutesLoader::ROTypedXMLRoutesLoader().

The begin of the embedding interval (if given)

Definition at line 173 of file RORDGenerator_ODAmounts.h.

Referenced by myEndElement(), myStartElement(), and parseFlowAmountDef().

The end of the embedding interval (if given)

Definition at line 176 of file RORDGenerator_ODAmounts.h.

Referenced by myEndElement(), myStartElement(), and parseFlowAmountDef().

The number of vehicles to insert.

Definition at line 179 of file RORDGenerator_ODAmounts.h.

Referenced by RORDGenerator_ODAmounts::FlowDef::addRoutes(), myEndFlowAmountDef(), and parseFlowAmountDef().

const bool RORDLoader_TripDefs::myWithTaz [protected, inherited]

Information whether zones (districts) are used as origins / destinations.

Definition at line 114 of file RORDLoader_TripDefs.h.

Referenced by RORDLoader_TripDefs::myStartElement().


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines