ROVehicleCont Class Reference

#include <ROVehicleCont.h>

Inheritance diagram for ROVehicleCont:

---

Detailed Description

A container for vehicles sorted by their departure time.

A map of vehicle-ids to the vehicles themselves. Besides the functionality implemented in NamedObjectCont, this class stores vehicles sorted by their departure time.

Definition at line 52 of file ROVehicleCont.h.

Public Member Functions
virtual bool	add (const std::string &id, ROVehicle *item) throw ()
	Adds a vehicle to the container.
const std::vector< ROVehicle * > &	buildAndGetStaticVector () const throw ()
void	clear () throw ()
	Deletes all vehicles stored; clears the lists.
bool	erase (const std::string &id) throw ()
	Tries to remove (and delete) the named vehicle.
ROVehicle *	get (const std::string &id) const throw ()
	Retrieves an item.
const std::map< std::string, ROVehicle * > &	getMyMap () const throw ()
std::vector< ROVehicle * >	getTempVector () const throw ()
const ROVehicle *const	getTopVehicle () const throw ()
	Returns the vehicle that departs most early.
void	insertIDs (std::vector< std::string > &into) const throw ()
virtual bool	remove (const std::string &id) throw ()
	Removes an item.
	ROVehicleCont () throw ()
	Constructor.
unsigned int	size () const throw ()
	Returns the number of items within the container.
	~ROVehicleCont () throw ()
	Destructor.
Private Member Functions
ROVehicleCont &	operator= (const ROVehicleCont &src)
	Invalidated assignment operator.
void	rebuildSorted () throw ()
	Rebuild the internal, sorted list.
	ROVehicleCont (const ROVehicleCont &src)
	Invalidated copy constructor.
Private Attributes
std::priority_queue< ROVehicle *, std::vector< ROVehicle * > , ROVehicleByDepartureComperator >	mySorted
	The sorted vehicle list.

---

Constructor & Destructor Documentation

ROVehicleCont::ROVehicleCont

(

)

throw ()

Constructor.

Definition at line 45 of file ROVehicleCont.cpp.

{}

ROVehicleCont::~ROVehicleCont

(

)

throw ()

Destructor.

Definition at line 48 of file ROVehicleCont.cpp.

{}

ROVehicleCont::ROVehicleCont

(

const ROVehicleCont &

src

)

[private]

Invalidated copy constructor.

---

Member Function Documentation

bool ROVehicleCont::add	(	const std::string &	id,
		ROVehicle *	item
	)			throw () [virtual]

Adds a vehicle to the container.

Tries to add the vehicle to the container using NamedObjectCont::add. If this succeeds, the vehicle is also added to the internal sorted list of vehicles.

Returns the value from NamedObjectCont::add.

Parameters:

[in]	id	The id of the vehicle to add
[in]	item	The vehicle to add

Returns:

Whether the vehicle could be added

See also:

NamedObjectCont::add

Reimplemented from NamedObjectCont< ROVehicle * >.

Definition at line 61 of file ROVehicleCont.cpp.

References mySorted.

Referenced by RONet::addVehicle().

                                                               {
    if (NamedObjectCont<ROVehicle*>::add(id, item)) {
        mySorted.push(item);
        return true;
    }
    return false;
}

const std::vector<ROVehicle * >& NamedObjectCont< ROVehicle * >::buildAndGetStaticVector

(

)

const throw () [inline, inherited]

Definition at line 173 of file NamedObjectCont.h.

                                                                {
        if (myHaveChanged) {
            myVector.clear();
            typename IDMap::const_iterator i;
            for (i=myMap.begin(); i!=myMap.end(); ++i) {
                myVector.push_back((*i).second);
            }
            myHaveChanged = false;
        }
        return myVector;
    }

void ROVehicleCont::clear

(

)

throw ()

Deletes all vehicles stored; clears the lists.

Calls NamedObjectCont::clear and replaces the internal, sorted list by an empty one.

See also:

NamedObjectCont::clear

Reimplemented from NamedObjectCont< ROVehicle * >.

Definition at line 71 of file ROVehicleCont.cpp.

References NamedObjectCont< T >::clear(), and mySorted.

Referenced by RONet::~RONet().

                             {
    mySorted = std::priority_queue<ROVehicle*, std::vector<ROVehicle*>, ROVehicleByDepartureComperator>();
    NamedObjectCont<ROVehicle*>::clear();
}

bool ROVehicleCont::erase

(

const std::string &

id

)

throw ()

Tries to remove (and delete) the named vehicle.

Calls NamedObjectCont::erase. If this succeeds, the vehicle is removed from the internal sorted list. This method takes care whether the vehicle to remove is the top-most one (the one with the earliest depart time). If not, the internal list is rebuild.

Parameters:

[in]

id

The id of the vehicle to remove

Returns:

Whether the vehicle could be removed

See also:

NamedObjectCont::erase

Reimplemented from NamedObjectCont< ROVehicle * >.

Definition at line 78 of file ROVehicleCont.cpp.

References ROVehicle::getID(), getTopVehicle(), mySorted, and rebuildSorted().

Referenced by RONet::saveAndRemoveRoutesUntil().

                                                {
    const ROVehicle * const topVeh = getTopVehicle();
    bool wasTop = topVeh!=0&&topVeh->getID()==id;
    if (!NamedObjectCont<ROVehicle*>::erase(id)) {
        return false;
    }
    if (wasTop) {
        mySorted.pop();
    } else {
        rebuildSorted();
    }
    return true;
}

ROVehicle * NamedObjectCont< ROVehicle * >::get

(

const std::string &

id

)

const throw () [inline, inherited]

Retrieves an item.

Returns 0 when no item with the given id is stored within the container

Parameters:

[in]

id

The id of the item to retrieve

Returns:

The item stored under the given id, or 0 if no such item exists

Definition at line 107 of file NamedObjectCont.h.

                                             {
        typename std::map<std::string, T>::const_iterator i = myMap.find(id);
        if (i==myMap.end()) {
            return 0;
        }
        return (*i).second;
    }

const std::map<std::string, ROVehicle * >& NamedObjectCont< ROVehicle * >::getMyMap

(

)

const throw () [inline, inherited]

Definition at line 218 of file NamedObjectCont.h.

Referenced by rebuildSorted().

                                                         {
        return myMap;
    }

std::vector<ROVehicle * > NamedObjectCont< ROVehicle * >::getTempVector

(

)

const throw () [inline, inherited]

Definition at line 193 of file NamedObjectCont.h.

                                               {
        std::vector<T> ret;
        typename IDMap::const_iterator i;
        for (i=myMap.begin(); i!=myMap.end(); ++i) {
            ret.push_back((*i).second);
        }
        return ret;
    }

const ROVehicle *const ROVehicleCont::getTopVehicle

(

)

const throw ()

Returns the vehicle that departs most early.

Returns the first vehicle from the internal list of sorted vehicles or 0 if this list is empty.

Returns:

The vehicle that departs most early

Definition at line 52 of file ROVehicleCont.cpp.

References mySorted, and NamedObjectCont< ROVehicle * >::size().

Referenced by erase(), and RONet::saveAndRemoveRoutesUntil().

                                           {
    if (size()==0) {
        return 0;
    }
    return mySorted.top();
}

void NamedObjectCont< ROVehicle * >::insertIDs

(

std::vector< std::string > &

into

)

const throw () [inline, inherited]

Definition at line 206 of file NamedObjectCont.h.

                                                             {
        typename IDMap::const_iterator i;
        for (i=myMap.begin(); i!=myMap.end(); ++i) {
            into.push_back((*i).first);
        }
    }

ROVehicleCont& ROVehicleCont::operator=

(

const ROVehicleCont &

src

)

[private]

Invalidated assignment operator.

void ROVehicleCont::rebuildSorted

(

)

throw () [private]

Rebuild the internal, sorted list.

Rebuilds the internal, sorted list by clearing it, first, and then adding all vehicles stored.

See also:

NamedObjectCont::clear

Definition at line 94 of file ROVehicleCont.cpp.

References NamedObjectCont< ROVehicle * >::getMyMap(), and mySorted.

Referenced by erase().

                                     {
    mySorted = std::priority_queue<ROVehicle*, std::vector<ROVehicle*>, ROVehicleByDepartureComperator>();
    std::map<std::string, ROVehicle*>::const_iterator i;
    const std::map<std::string, ROVehicle*> &mmap = getMyMap();
    for (i=mmap.begin(); i!=mmap.end(); ++i) {
        mySorted.push((*i).second);
    }
}

virtual bool NamedObjectCont< ROVehicle * >::remove

(

const std::string &

id

)

throw () [inline, virtual, inherited]

Removes an item.

Parameters:

[in]

id

The id of the item to remove

Returns:

If the item could been removed (an item with the id was within the container before)

Definition at line 88 of file NamedObjectCont.h.

                                                     {
        if (myMap.find(id)==myMap.end()) {
            return false;
        }
        typename std::map<std::string, T>::iterator i = myMap.find(id);
        delete i->second;
        myMap.erase(i);
        myHaveChanged = true;
        return true;
    }

unsigned int NamedObjectCont< ROVehicle * >::size

(

)

const throw () [inline, inherited]

Returns the number of items within the container.

Returns:

The number of stored items

Definition at line 131 of file NamedObjectCont.h.

Referenced by getTopVehicle().

                                      {
        return (unsigned int) myMap.size();
    }

---

Field Documentation

std::priority_queue<ROVehicle*, std::vector<ROVehicle*>, ROVehicleByDepartureComperator> ROVehicleCont::mySorted [mutable, private]

The sorted vehicle list.

Definition at line 125 of file ROVehicleCont.h.

Referenced by add(), clear(), erase(), getTopVehicle(), and rebuildSorted().

---

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

• ROVehicleCont.h
• ROVehicleCont.cpp