NamedObjectCont.h

Go to the documentation of this file.

/****************************************************************************/
// A map of named object pointers
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2002-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef NamedObjectCont_h
#define NamedObjectCont_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <map>
#include <string>
#include <vector>
#include <algorithm>


// ===========================================================================
// class definitions
// ===========================================================================
template<class T>
class NamedObjectCont {
public:
    typedef std::map< std::string, T > IDMap;

    NamedObjectCont() : myHaveChanged(false) { }

    virtual ~NamedObjectCont() {
        // iterate over all elements to delete it
        for (typename IDMap::iterator i = myMap.begin(); i != myMap.end(); i++) {
            delete(*i).second;
        }
    }

    virtual bool add(const std::string& id, T item) {
        if (myMap.find(id) != myMap.end()) {
            return false;
        }
        myMap.insert(std::make_pair(id, item));
        myHaveChanged = true;
        return true;
    }

    virtual bool remove(const std::string& id) {
        typename std::map<std::string, T>::iterator it = myMap.find(id);
        if (it == myMap.end()) {
            return false;
        } else {
            delete it->second;
            myMap.erase(it);
            myHaveChanged = true;
            return true;
        }
    }

    T get(const std::string& id) const {
        typename std::map<std::string, T>::const_iterator it = myMap.find(id);
        if (it == myMap.end()) {
            return 0;
        } else {
            return it->second;
        }
    }

    void clear() {
        for (typename IDMap::iterator i = myMap.begin(); i != myMap.end(); i++) {
            delete(*i).second;
        }
        myMap.clear();
        myVector.clear();
        myHaveChanged = true;
    }

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

    bool erase(const std::string& id) {
        typename IDMap::iterator i = myMap.find(id);
        if (i == myMap.end()) {
            return false;
        } else {
            T o = (*i).second;
            myMap.erase(i);
            // and from the vector
            typename ObjectVector::iterator i2 =
                find(myVector.begin(), myVector.end(), o);
            myHaveChanged = true;
            if (i2 != myVector.end()) {
                myVector.erase(i2);
            }
            delete o;
            return true;
        }
    }

    /* @brief Fills the given vector with the stored objects' ids
     * @param[in] into The container to fill
     */
    void insertIDs(std::vector<std::string>& into) const {
        typename IDMap::const_iterator i;
        for (i = myMap.begin(); i != myMap.end(); ++i) {
            into.push_back((*i).first);
        }
    }

    bool changeID(const std::string& oldId, const std::string& newId) {
        typename IDMap::iterator i = myMap.find(oldId);
        if (i == myMap.end()) {
            return false;
        } else {
            // save Item, remove it from Map, and insert it again with the new ID
            T item = (*i).second;
            myMap.erase(i);
            myMap.insert(std::make_pair(newId, item));
            return true;
        }
    }

    const IDMap& getMyMap() const {
        return myMap;
    }


private:
    typedef typename IDMap::iterator myContIt;

    IDMap myMap;

    typedef std::vector<T> ObjectVector;

    mutable ObjectVector myVector;

    mutable bool myHaveChanged;
};


#endif

/****************************************************************************/