RODFRouteCont Class Reference

#include <RODFRouteCont.h>

---

Detailed Description

A container for DFROUTER-routes.

The route id is (re)set as soon as the route is added.

As sometimes several routes can be used between two edges and have to be identified, the number of routes connecting them is stored for each edge pair "myConnectionOccurences" and the route is named using this information,

See also:

addRouteDesc.

RODFRouteDesc

Definition at line 61 of file RODFRouteCont.h.

Public Member Functions
void	addAllEndFollower () throw ()
	All routes are replaced by their versions extended by follower edges.
void	addRouteDesc (RODFRouteDesc &desc) throw ()
	Adds a route to the container.
std::vector< RODFRouteDesc > &	get () throw ()
	Returns the container of stored routes.
void	removeIllegal (const std::vector< std::vector< ROEdge * > > &illegals) throw ()
	Removes "illegal" routes.
bool	removeRouteDesc (RODFRouteDesc &desc) throw ()
	Removes the given route description from the container.
	RODFRouteCont () throw ()
	Constructor.
bool	save (std::vector< std::string > &saved, const std::string &prependix, OutputDevice &out) throw (IOError)
	Saves routes.
void	sortByDistance () throw ()
	Sorts routes by their distance (length).
	~RODFRouteCont () throw ()
	Destructor.
Protected Member Functions
void	setID (RODFRouteDesc &desc) const throw ()
	Computes and sets the id of a route.
Protected Attributes
std::map< std::pair< ROEdge *, ROEdge * >, int >	myConnectionOccurences
	Counts how many routes connecting the key-edges were already stored.
std::vector< RODFRouteDesc >	myRoutes
	Stored route descriptions.
Data Structures
class	by_distance_sorter
	A class for sorting route descriptions by their length. More...
class	route_finder
	A class for finding a same route (one that passes the same edges). More...

---

Constructor & Destructor Documentation

RODFRouteCont::RODFRouteCont

(

)

throw ()

Constructor.

Definition at line 47 of file RODFRouteCont.cpp.

{}

RODFRouteCont::~RODFRouteCont

(

)

throw ()

Destructor.

Definition at line 50 of file RODFRouteCont.cpp.

                                      {
}

---

Member Function Documentation

void RODFRouteCont::addAllEndFollower

(

)

throw ()

All routes are replaced by their versions extended by follower edges.

Definition at line 137 of file RODFRouteCont.cpp.

References RODFRouteDesc::edges2Pass, ROEdge::getFollower(), ROEdge::getNoFollowing(), myRoutes, and setID().

Referenced by RODFNet::buildRoutes().

                                         {
    std::vector<RODFRouteDesc> newRoutes;
    for (std::vector<RODFRouteDesc>::iterator i=myRoutes.begin(); i!=myRoutes.end(); ++i) {
        RODFRouteDesc &desc = *i;
        ROEdge *last = *(desc.edges2Pass.end()-1);
        if (last->getNoFollowing()==0) {
            newRoutes.push_back(desc);
            continue;
        }
        for (unsigned int j=0; j<last->getNoFollowing(); ++j) {
            RODFRouteDesc ndesc(desc);
            ndesc.edges2Pass.push_back(last->getFollower(j));
            setID(ndesc);
            newRoutes.push_back(ndesc);
        }
    }
    myRoutes = newRoutes;
}

void RODFRouteCont::addRouteDesc

(

RODFRouteDesc &

desc

)

throw ()

Adds a route to the container.

If the same route is already known, its "overallProb" is increased by the value stored in the given route.

An id for the route is generated if it is unset, yet. The id is computed and set via "setID".

Parameters:

[in]

desc

The route description to add

See also:

setID

Definition at line 55 of file RODFRouteCont.cpp.

References myRoutes, RODFRouteDesc::overallProb, and setID().

Referenced by RODFDetector::addRoute(), and RODFNet::computeRoutesFor().

                                                       {
    // routes may be duplicate as in-between routes may have different starting points
    if (find_if(myRoutes.begin(), myRoutes.end(), route_finder(desc))==myRoutes.end()) {
        // compute route id
        ROEdge *first = *(desc.edges2Pass.begin());
        ROEdge *last = *(desc.edges2Pass.end()-1);
        setID(desc);
        myRoutes.push_back(desc);
    } else {
        RODFRouteDesc &prev = *find_if(myRoutes.begin(), myRoutes.end(), route_finder(desc));
        prev.overallProb += desc.overallProb;
    }
}

std::vector<RODFRouteDesc>& RODFRouteCont::get

(

)

throw () [inline]

Returns the container of stored routes.

Returns:

The stored routes

Definition at line 111 of file RODFRouteCont.h.

References myRoutes.

Referenced by RODFDetector::buildDestinationDistribution(), RODFNet::buildRoutes(), RODFDetector::computeSplitProbabilities(), RODFDetector::getRouteVector(), RODFDetector::hasRoutes(), and RODFDetector::writeEmitterDefinition().

                                            {
        return myRoutes;
    }

void RODFRouteCont::removeIllegal

(

const std::vector< std::vector< ROEdge * > > &

illegals

)

throw ()

Removes "illegal" routes.

"illegal" routes means edge combinations that shall not be passed.

Parameters:

[in]

illegals

List of edge combinations that shall not be passed

Todo:

Not used, yet

Definition at line 112 of file RODFRouteCont.cpp.

References RODFRouteDesc::edges2Pass, and myRoutes.

                                                                                   {
    for (std::vector<RODFRouteDesc>::iterator i=myRoutes.begin(); i!=myRoutes.end();) {
        RODFRouteDesc &desc = *i;
        bool remove = false;
        for (std::vector<std::vector<ROEdge*> >::const_iterator j=illegals.begin(); !remove&&j!=illegals.end(); ++j) {
            int noFound = 0;
            for (std::vector<ROEdge*>::const_iterator k=(*j).begin(); !remove&&k!=(*j).end(); ++k) {
                if (find(desc.edges2Pass.begin(), desc.edges2Pass.end(), *k)!=desc.edges2Pass.end()) {
                    noFound++;
                    if (noFound>1) {
                        remove = true;
                    }
                }
            }
        }
        if (remove) {
            i = myRoutes.erase(i);
        } else {
            ++i;
        }
    }
}

bool RODFRouteCont::removeRouteDesc

(

RODFRouteDesc &

desc

)

throw ()

Removes the given route description from the container.

All routes are regarded as being same if they pass the same edges. This is done via the "route_finder".

Parameters:

[in]

desc

The route description to remove

Returns:

Whether the route was removed (a similar was found)

See also:

RODFRouteCont::route_finder

Definition at line 71 of file RODFRouteCont.cpp.

References myRoutes.

Referenced by RODFNet::computeRoutesFor().

                                                          {
    std::vector<RODFRouteDesc>::const_iterator j = find_if(myRoutes.begin(), myRoutes.end(), route_finder(desc));
    if (j==myRoutes.end()) {
        return false;
    }
    return true;
}

bool RODFRouteCont::save	(	std::vector< std::string > &	saved,
		const std::string &	prependix,
		OutputDevice &	out
	)			throw (IOError)

Saves routes.

Parameters:

[in,out]	saved	The list of ids of routes that shall not be saved (were saved before)
[in]	prependix	The prependix for route names
[out]	out	The device the routes shall written to

Returns:

Whether at least one route was saved

Exceptions:

IOError

not yet implemented

Definition at line 81 of file RODFRouteCont.cpp.

References RODFRouteDesc::edges2Pass, myRoutes, and RODFRouteDesc::routename.

Referenced by RODFDetector::writeRoutes().

                                                                                  {
    bool haveSavedOneAtLeast = false;
    for (std::vector<RODFRouteDesc>::const_iterator j=myRoutes.begin(); j!=myRoutes.end(); ++j) {
        const RODFRouteDesc &desc = (*j);
        if (find(saved.begin(), saved.end(), desc.routename)!=saved.end()) {
            continue;
        }
        saved.push_back((*j).routename);
        assert(desc.edges2Pass.size()>=1);
        out << "   <route id=\"" << prependix << desc.routename << "\" edges=\"";
        for (std::vector<ROEdge*>::const_iterator k=desc.edges2Pass.begin(); k!=desc.edges2Pass.end(); k++) {
            if (k!=desc.edges2Pass.begin()) {
                out << ' ';
            }
            out << (*k)->getID();
        }
        out << "\"/>\n";
        haveSavedOneAtLeast = true;
    }
    return haveSavedOneAtLeast;
}

void RODFRouteCont::setID

(

RODFRouteDesc &

desc

)

const throw () [protected]

Computes and sets the id of a route.

The id is <FIRST_EDGE>_to_<LAST_EDGE>_<RUNNING> where <RUNNING> is the number of routes which connect <FIRST_EDGE> and <LAST_EDGE>.

Parameters:

[in]

desc

The route description to add

Definition at line 158 of file RODFRouteCont.cpp.

References myConnectionOccurences, and toString().

Referenced by addAllEndFollower(), and addRouteDesc().

                                                      {
    std::pair<ROEdge*, ROEdge*> c(desc.edges2Pass[0], desc.edges2Pass.back());
    desc.routename = c.first->getID() + "_to_" + c.second->getID();
    if (myConnectionOccurences.find(c)==myConnectionOccurences.end()) {
        myConnectionOccurences[c] = 0;
    } else {
        myConnectionOccurences[c] = myConnectionOccurences[c] + 1;
        desc.routename = desc.routename + "_" + toString(myConnectionOccurences[c]);
    }
}

void RODFRouteCont::sortByDistance

(

)

throw ()

Sorts routes by their distance (length).

Done using by_distance_sorter.

See also:

RODFRouteCont::by_distance_sorter

Definition at line 106 of file RODFRouteCont.cpp.

References myRoutes.

                                      {
    sort(myRoutes.begin(), myRoutes.end(), by_distance_sorter());
}

---

Field Documentation

std::map<std::pair<ROEdge*, ROEdge*>, int> RODFRouteCont::myConnectionOccurences [mutable, protected]

Counts how many routes connecting the key-edges were already stored.

Definition at line 187 of file RODFRouteCont.h.

Referenced by setID().

std::vector<RODFRouteDesc> RODFRouteCont::myRoutes [protected]

Stored route descriptions.

Definition at line 184 of file RODFRouteCont.h.

Referenced by addAllEndFollower(), addRouteDesc(), get(), removeIllegal(), removeRouteDesc(), save(), and sortByDistance().

---

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

• RODFRouteCont.h
• RODFRouteCont.cpp