The router's network representation. More...

#include <RONet.h>

Inheritance diagram for RONet:

Public Member Functions
void	closeOutput ()
	closes the file output for computed routes
const std::map< std::string, ROEdge * > &	getEdgeMap () const
unsigned int	getEdgeNo () const
	Returns the number of edges thenetwork contains.
const ROEdge *	getRandomDestination () const
	Returns a random edge which may be used as an ending point.
ROEdge *	getRandomDestination ()
	Returns a random edge which may be used as an ending point.
ROEdge *	getRandomSource ()
	Returns a random edge which may be used as a starting point.
const ROEdge *	getRandomSource () const
	Returns a random edge which may be used as a starting point.
bool	hasRestrictions () const
void	openOutput (const std::string &filename, bool useAlternatives)
	Opens the output for computed routes.
	RONet ()
	Constructor.
void	setRestrictionFound ()
virtual	~RONet ()
	Destructor.
Insertion and retrieval of graph parts
virtual bool	addEdge (ROEdge *edge)
ROEdge *	getEdge (const std::string &name) const
	Retrieves an edge from the network.
void	addNode (RONode *node)
RONode *	getNode (const std::string &id) const
	Retrieves an node from the network.
Insertion and retrieval of vehicle types, vehicles, routes, and route definitions
virtual bool	addVehicleType (SUMOVTypeParameter *type)
SUMOVTypeParameter *	getVehicleTypeSecure (const std::string &id)
	Retrieves the named vehicle type.
bool	addRouteDef (RORouteDef *def)
RORouteDef *	getRouteDef (const std::string &name) const
	Returns the named route definition.
virtual bool	addVehicle (const std::string &id, ROVehicle *veh)
Processing stored vehicle definitions
SUMOTime	saveAndRemoveRoutesUntil (OptionsCont &options, SUMOAbstractRouter< ROEdge, ROVehicle > &router, SUMOTime time)
	Computes routes described by their definitions and saves them.
virtual bool	furtherStored ()
	Returns the information whether further vehicles are stored.
Protected Member Functions
void	checkSourceAndDestinations () const
	Initialises the lists of source and destination edges.
bool	computeRoute (OptionsCont &options, SUMOAbstractRouter< ROEdge, ROVehicle > &router, const ROVehicle *const veh)
Protected Attributes
std::vector< ROEdge * >	myDestinationEdges
	List of destination edges.
unsigned int	myDiscardedRouteNo
	The number of discarded routes.
NamedObjectCont< ROEdge * >	myEdges
	Known edges.
bool	myHaveRestrictions
	Whether the network contains edges which not all vehicles may pass.
NamedObjectCont< RONode * >	myNodes
	Known nodes.
unsigned int	myReadRouteNo
	The number of read routes.
OutputDevice *	myRouteAlternativesOutput
	The file to write the computed route alternatives into.
NamedObjectCont< RORouteDef * >	myRoutes
	Known routes.
OutputDevice *	myRoutesOutput
	The file to write the computed routes into.
std::vector< ROEdge * >	mySourceEdges
	List of source edges.
ROVehicleCont	myVehicles
	Known vehicles.
NamedObjectCont < SUMOVTypeParameter * >	myVehicleTypes
	Known vehicle types.
std::set< std::string >	myVehIDs
	Known vehicle ids.
unsigned int	myWrittenRouteNo
	The number of written routes.
Private Member Functions
RONet &	operator= (const RONet &src)
	Invalidated assignment operator.
	RONet (const RONet &src)
	Invalidated copy constructor.

Detailed Description

The router's network representation.

A router network is responsible for watching loaded edges, nodes,!!!

Todo:: Vehicle ids are not tracked; it may happen that the same id is added twice...

Definition at line 68 of file RONet.h.

Constructor & Destructor Documentation

RONet::RONet ( )

Constructor.

Definition at line 62 of file RONet.cpp.

RONet::~RONet ( ) [virtual]

Destructor.

Definition at line 69 of file RONet.cpp.

References ROVehicleCont::clear(), NamedObjectCont< T >::clear(), myEdges, myNodes, myRoutes, myVehicles, and myVehicleTypes.

RONet::RONet ( const RONet & src ) [private]

Invalidated copy constructor.

Member Function Documentation

bool RONet::addEdge ( ROEdge * edge ) [virtual]

Definition at line 79 of file RONet.cpp.

References NamedObjectCont< T >::add(), ROEdge::getID(), myEdges, and WRITE_ERROR.

Referenced by RONetHandler::parseDistrict(), and RONetHandler::parseEdge().

void RONet::addNode ( RONode * node )

Definition at line 90 of file RONet.cpp.

References NamedObjectCont< T >::add(), Named::getID(), myNodes, and WRITE_ERROR.

Referenced by RONetHandler::parseEdge(), and RONetHandler::parseJunction().

bool RONet::addRouteDef ( RORouteDef * def )

Definition at line 99 of file RONet.cpp.

References NamedObjectCont< T >::add(), Named::getID(), and myRoutes.

Referenced by RORDGenerator_ODAmounts::FlowDef::addSingleRoute(), RORDLoader_TripDefs::myEndElement(), RORDLoader_SUMOBase::myEndElement(), and RORDGenerator_ODAmounts::myEndFlowAmountDef().

bool RONet::addVehicle	(	const std::string &	id,
		ROVehicle *	veh
	)		`[virtual]`

Definition at line 168 of file RONet.cpp.

References ROVehicleCont::add(), myReadRouteNo, myVehicles, myVehIDs, and WRITE_ERROR.

Referenced by RORDGenerator_ODAmounts::FlowDef::addSingleRoute(), RORDLoader_SUMOBase::closeVehicle(), and RORDLoader_TripDefs::myEndElement().

bool RONet::addVehicleType ( SUMOVTypeParameter * type ) [virtual]

Definition at line 157 of file RONet.cpp.

References NamedObjectCont< T >::add(), SUMOVTypeParameter::id, myVehicleTypes, and WRITE_ERROR.

Referenced by getVehicleTypeSecure(), RORDLoader_TripDefs::myEndElement(), and RORDLoader_SUMOBase::myEndElement().

void RONet::checkSourceAndDestinations ( ) const [protected]

Initialises the lists of source and destination edges.

Definition at line 320 of file RONet.cpp.

References ROEdge::ET_SINK, ROEdge::ET_SOURCE, NamedObjectCont< T >::getMyMap(), ROEdge::getType(), myDestinationEdges, myEdges, and mySourceEdges.

Referenced by getRandomDestination(), and getRandomSource().

void RONet::closeOutput ( )

closes the file output for computed routes

Definition at line 121 of file RONet.cpp.

References OutputDevice::close(), myRouteAlternativesOutput, and myRoutesOutput.

Referenced by computeRoutes().

bool RONet::computeRoute	(	OptionsCont &	options,
		SUMOAbstractRouter< ROEdge, ROVehicle > &	router,
		const ROVehicle *const	veh
	)		`[protected]`

Definition at line 180 of file RONet.cpp.

References RORouteDef::addAlternative(), RORouteDef::buildCurrentRoute(), OptionsCont::getBool(), ROVehicle::getDepartureTime(), MsgHandler::getErrorInstance(), ROVehicle::getID(), ROVehicle::getRouteDefinition(), MsgHandler::getWarningInstance(), MsgHandler::inform(), ReferencedItem::isSaved(), RORoute::recheckForLoops(), and RORoute::size().

Referenced by saveAndRemoveRoutesUntil().

bool RONet::furtherStored ( ) [virtual]

Returns the information whether further vehicles are stored.

Definition at line 265 of file RONet.cpp.

References myVehicles, and NamedObjectCont< T >::size().

Referenced by ROLoader::processRoutesStepWise().

ROEdge* RONet::getEdge ( const std::string & name ) const [inline]

Retrieves an edge from the network.

This is not very pretty, but necessary, though, as routes run over instances, not over ids.

Parameters:

[in] name The name of the edge to retrieve

Returns:: The named edge if known, otherwise 0

Todo:: Check whether a const pointer may be returned

Definition at line 102 of file RONet.h.

References NamedObjectCont< T >::get(), and myEdges.

Referenced by ROLoader::EdgeFloatTimeLineRetriever_EdgeTravelTime::addEdgeWeight(), ROJTRTurnDefLoader::addToEdge(), ROJTRTurnDefLoader::beginFromEdge(), RODFNet::getDetectorEdge(), RORDLoader_TripDefs::getEdge(), loadJTRDefinitions(), RORDLoader_SUMOBase::myCharacters(), ROJTRTurnDefLoader::myCharacters(), ROJTRTurnDefLoader::myStartElement(), RODFDetectorHandler::myStartElement(), RONetHandler::parseConnectedEdge(), RONetHandler::parseConnectingEdge(), RONetHandler::parseConnection(), RONetHandler::parseDistrict(), RONetHandler::parseDistrictEdge(), AGActivityGenHandler::parseStreets(), RODFDetectorCon::writeEmitters(), and RODFDetectorCon::writeSpeedTrigger().

const std::map< std::string, ROEdge * > & RONet::getEdgeMap ( ) const

Definition at line 346 of file RONet.cpp.

References NamedObjectCont< T >::getMyMap(), and myEdges.

Referenced by RODFNet::buildApproachList(), AGCity::completeStreets(), initNet(), and ROLoader::loadWeights().

unsigned int RONet::getEdgeNo ( ) const

Returns the number of edges thenetwork contains.

Definition at line 340 of file RONet.cpp.

References myEdges, and NamedObjectCont< T >::size().

Referenced by computeRoutes(), and main().

RONode* RONet::getNode ( const std::string & id ) const [inline]

Retrieves an node from the network.

Parameters:

[in] name The name of the node to retrieve

Returns:: The named node if known, otherwise 0

Todo:: Check whether a const pointer may be returned

Definition at line 124 of file RONet.h.

References NamedObjectCont< T >::get(), and myNodes.

Referenced by RONetHandler::parseEdge(), and RONetHandler::parseJunction().

ROEdge * RONet::getRandomDestination ( )

Returns a random edge which may be used as an ending point.

If the list of possible destinations (roads with no successor, "myDestinationEdges") is empty, it is tried to be built, first.

Returns:: A random edge from the list of edges with no successor

Definition at line 296 of file RONet.cpp.

References checkSourceAndDestinations(), RandHelper::getRandomFrom(), and myDestinationEdges.

const ROEdge * RONet::getRandomDestination ( ) const

Returns a random edge which may be used as an ending point.

If the list of possible destinations (roads with no successor, "myDestinationEdges") is empty, it is tried to be built, first.

Returns:: A random edge from the list of edges with no successor

Definition at line 308 of file RONet.cpp.

References checkSourceAndDestinations(), RandHelper::getRandomFrom(), and myDestinationEdges.

const ROEdge * RONet::getRandomSource ( ) const

Returns a random edge which may be used as a starting point.

If the list of possible sources (roads with no predecessor, "mySourceEdges") is empty, it is tried to be built, first.

Returns:: A random edge from the list of edges with no predecessor

Definition at line 283 of file RONet.cpp.

References checkSourceAndDestinations(), RandHelper::getRandomFrom(), and mySourceEdges.

ROEdge * RONet::getRandomSource ( )

Returns a random edge which may be used as a starting point.

If the list of possible source (roads with no predecessor, "mySourceEdges") is empty, it is tried to be built, first.

Returns:: A random edge from the list of edges with no predecessor

Definition at line 271 of file RONet.cpp.

References checkSourceAndDestinations(), RandHelper::getRandomFrom(), and mySourceEdges.

RORouteDef* RONet::getRouteDef ( const std::string & name ) const [inline]

Returns the named route definition.

Parameters:

[in] name The name of the route definition to retrieve

Returns:: The named route definition if known, otherwise 0

Todo:

Check whether a const pointer may be returned

Rename myRoutes to myRouteDefinitions

Definition at line 181 of file RONet.h.

References NamedObjectCont< T >::get(), and myRoutes.

Referenced by RORDLoader_SUMOBase::closeVehicle().

SUMOVTypeParameter * RONet::getVehicleTypeSecure ( const std::string & id )

Retrieves the named vehicle type.

If the named vehicle type was not added to the net before, a default vehicle type which consists of the id only is generated, added to the net and returned.

Only if the name is "", 0 is returned.

Parameters:

[in] id The id of the vehicle type to return

Returns:: The named vehicle type

Todo:: Check whether a const pointer may be returned

Definition at line 135 of file RONet.cpp.

References addVehicleType(), NamedObjectCont< T >::get(), SUMOVTypeParameter::id, myVehicleTypes, and SUMOVTypeParameter::onlyReferenced.

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

bool RONet::hasRestrictions ( ) const

Definition at line 352 of file RONet.cpp.

References myHaveRestrictions.

Referenced by computeRoutes().

void RONet::openOutput	(	const std::string &	filename,
		bool	useAlternatives
	)

Opens the output for computed routes.

If the second parameter is true, a second file for route alternatives will be opened. The route alternatives files is simply the given name with ".alt" appended (before the ".xml"-suffix). If one of the file outputs can not be build, an IOError is thrown

Parameters:

[in]	filename	The (base) name of the file(s) to create
[in]	useAlternatives	Whether a file for writing alternatives shall be created

Definition at line 105 of file RONet.cpp.

References OutputDevice::getDevice(), myRouteAlternativesOutput, myRoutesOutput, and OutputDevice::writeXMLHeader().

Referenced by computeRoutes().

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

Invalidated assignment operator.

SUMOTime RONet::saveAndRemoveRoutesUntil	(	OptionsCont &	options,
		SUMOAbstractRouter< ROEdge, ROVehicle > &	router,
		SUMOTime	time
	)

Computes routes described by their definitions and saves them.

As long a vehicle with a departure time not larger than the given exists, its route is computed and it is written and removed from the internal container.

Parameters:

[in]	options	The options used during this process
[in]	router	The router to use for routes computation
[in]	options	The time until which route definitions shall be processed