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

The data loader. More...

#include <ROLoader.h>

Data Structures

class  EdgeFloatTimeLineRetriever_EdgeTravelTime
 Obtains edge travel times from a weights handler and stores them within the edges. More...
 
class  EdgeFloatTimeLineRetriever_EdgeWeight
 Obtains edge weights from a weights handler and stores them within the edges. More...
 

Public Member Functions

virtual void loadNet (RONet &toFill, ROAbstractEdgeBuilder &eb)
 Loads the network. More...
 
bool loadWeights (RONet &net, const std::string &optionName, const std::string &measure, bool useLanes)
 Loads the net weights. More...
 
bool makeSingleStep (SUMOTime end, RONet &net, SUMOAbstractRouter< ROEdge, ROVehicle > &router)
 
unsigned int openRoutes (RONet &net)
 Builds and opens all route loaders Route loaders are derived from ROTypedXMLRoutesLoader. More...
 
void processAllRoutes (SUMOTime start, SUMOTime end, RONet &net, SUMOAbstractRouter< ROEdge, ROVehicle > &router)
 Loads all routes at once This is done for all previously build route loaders. More...
 
void processRoutesStepWise (SUMOTime start, SUMOTime end, RONet &net, SUMOAbstractRouter< ROEdge, ROVehicle > &router)
 Loads routes stepwise This is done for all previously build route loaders. More...
 
 ROLoader (OptionsCont &oc, bool emptyDestinationsAllowed)
 Constructor. More...
 
virtual ~ROLoader ()
 Destructor. More...
 

Protected Types

typedef std::vector
< ROTypedXMLRoutesLoader * > 
RouteLoaderCont
 Definition of route loader list. More...
 

Protected Member Functions

ROTypedXMLRoutesLoaderbuildNamedHandler (const std::string &optionName, const std::string &file, RONet &net)
 
void destroyHandlers ()
 Deletes all handlers and clears their container ("myHandler") More...
 
SUMOTime getMinTimeStep () const
 Returns the first time step known by the built handlers. More...
 
bool openTypedRoutes (const std::string &optionName, RONet &net)
 Opens route handler of the given type. More...
 
void writeStats (SUMOTime time, SUMOTime start, int absNo)
 

Protected Attributes

bool myEmptyDestinationsAllowed
 Information whether empty destinations are allowed. More...
 
RouteLoaderCont myHandler
 List of route loaders. More...
 
OptionsContmyOptions
 Options to use. More...
 

Private Member Functions

ROLoaderoperator= (const ROLoader &src)
 Invalidated assignment operator. More...
 
 ROLoader (const ROLoader &src)
 Invalidated copy constructor. More...
 

Private Attributes

bool myLogSteps
 Information whether the routing steps should be logged. More...
 

Detailed Description

The data loader.

Loads the network and route descriptions using further classes.

Is capable to either load all routes in one step or go through them step wise.

Definition at line 65 of file ROLoader.h.

Member Typedef Documentation

typedef std::vector<ROTypedXMLRoutesLoader*> ROLoader::RouteLoaderCont
protected

Definition of route loader list.

Definition at line 226 of file ROLoader.h.

Constructor & Destructor Documentation

ROLoader::ROLoader ( OptionsCont oc,
bool  emptyDestinationsAllowed 
)

Constructor.

Parameters
[in]ocThe options to use
[in]emptyDestinationsAllowedWhether trips may be given without destinations
Todo:
Recheck usage of emptyDestinationsAllowed

Definition at line 116 of file ROLoader.cpp.

ROLoader::~ROLoader ( )
virtual

Destructor.

Definition at line 123 of file ROLoader.cpp.

References destroyHandlers().

ROLoader::ROLoader ( const ROLoader src)
private

Invalidated copy constructor.

Member Function Documentation

ROTypedXMLRoutesLoader * ROLoader::buildNamedHandler ( const std::string &  optionName,
const std::string &  file,
RONet net 
)
protected
void ROLoader::destroyHandlers ( )
protected

Deletes all handlers and clears their container ("myHandler")

Definition at line 407 of file ROLoader.cpp.

References myHandler.

Referenced by openRoutes(), and ~ROLoader().

SUMOTime ROLoader::getMinTimeStep ( ) const
protected

Returns the first time step known by the built handlers.

The handlers are responsible for not adding route definitions prior to "begin"-Option's value. These priori departures must also not be reported by them whaen asking via "getLastReadTimeStep".

Returns
The first time step of loaded routes
See Also
ROAbstractRouteDefLoader::getLastReadTimeStep

Definition at line 247 of file ROLoader.cpp.

References myHandler.

Referenced by openRoutes(), and processRoutesStepWise().

bool ROLoader::loadWeights ( RONet net,
const std::string &  optionName,
const std::string &  measure,
bool  useLanes 
)
bool ROLoader::makeSingleStep ( SUMOTime  end,
RONet net,
SUMOAbstractRouter< ROEdge, ROVehicle > &  router 
)
unsigned int ROLoader::openRoutes ( RONet net)

Builds and opens all route loaders Route loaders are derived from ROTypedXMLRoutesLoader.

Definition at line 164 of file ROLoader.cpp.

References destroyHandlers(), OptionsCont::getBool(), getMinTimeStep(), OptionsCont::getString(), myHandler, myOptions, openTypedRoutes(), string2time(), time2string(), and WRITE_MESSAGE.

Referenced by computeRoutes().

bool ROLoader::openTypedRoutes ( const std::string &  optionName,
RONet net 
)
protected

Opens route handler of the given type.

Checks whether the given option name is known, returns true if not (this means that everything's ok, though the according handler is not built).

Checks then whether the given option name is set and his value is one or a set of valid (existing) files. This is done via a call to "OptionsCont::isUsableFileList" (which generates a proper error message).

If the given files are valid, the proper instance(s) is built using "buildNamedHandler" and if this could be done, it is added to the list of route handlers to use ("myHandler")

Returns whether the wished handler(s) could be built.

Parameters
[in]optionNameThe name of the option that refers to which handler and which files shall be used
[in]netThe net to assign to the built handlers
Returns
Whether the wished handler(s) could be built

Definition at line 296 of file ROLoader.cpp.

References buildNamedHandler(), OptionsCont::exists(), OptionsCont::getStringVector(), OptionsCont::isSet(), OptionsCont::isUsableFileList(), myHandler, myOptions, and WRITE_ERROR.

Referenced by openRoutes().

ROLoader& ROLoader::operator= ( const ROLoader src)
private

Invalidated assignment operator.

void ROLoader::processAllRoutes ( SUMOTime  start,
SUMOTime  end,
RONet net,
SUMOAbstractRouter< ROEdge, ROVehicle > &  router 
)

Loads all routes at once This is done for all previously build route loaders.

Definition at line 262 of file ROLoader.cpp.

References myHandler, myOptions, RONet::saveAndRemoveRoutesUntil(), SUMOTime_MAX, and writeStats().

Referenced by computeRoutes().

void ROLoader::processRoutesStepWise ( SUMOTime  start,
SUMOTime  end,
RONet net,
SUMOAbstractRouter< ROEdge, ROVehicle > &  router 
)

Loads routes stepwise This is done for all previously build route loaders.

Definition at line 196 of file ROLoader.cpp.

References DELTA_T, RONet::furtherStored(), OptionsCont::getBool(), MsgHandler::getErrorInstance(), getMinTimeStep(), makeSingleStep(), myHandler, myLogSteps, myOptions, time2string(), MsgHandler::wasInformed(), WRITE_MESSAGE, and writeStats().

Referenced by computeRoutes().

void ROLoader::writeStats ( SUMOTime  time,
SUMOTime  start,
int  absNo 
)
protected

Definition at line 398 of file ROLoader.cpp.

References myLogSteps, SUMOReal, time2string(), and toString().

Referenced by processAllRoutes(), and processRoutesStepWise().

Field Documentation

bool ROLoader::myEmptyDestinationsAllowed
protected

Information whether empty destinations are allowed.

Definition at line 232 of file ROLoader.h.

Referenced by buildNamedHandler().

RouteLoaderCont ROLoader::myHandler
protected
bool ROLoader::myLogSteps
private

Information whether the routing steps should be logged.

Definition at line 243 of file ROLoader.h.

Referenced by processRoutesStepWise(), and writeStats().

OptionsCont& ROLoader::myOptions
protected

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