Named.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Base class for objects which have an id.
/****************************************************************************/
#ifndef Named_h
#define Named_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <iostream>
#include <string>
#include <set>


// @note Numbers of different lenghts will not be ordered by alphanumerical sorting
struct ComparatorIdLess {
    template<class T>
    bool operator()(const T* const a, const T* const b) const {
        return a->getID() < b->getID();
    }
};


// ===========================================================================
// class definitions
// ===========================================================================
class Named {
public:
    Named(const std::string& id) : myID(id) { }


    virtual ~Named() { }

    template<class T>
    static std::string getIDSecure(const T* obj, const std::string& fallBack = "NULL") {
        return obj == 0 ? fallBack : obj->getID();
    }

    const std::string& getID() const {
        return myID;
    }


    void setID(const std::string& newID) {
        myID = newID;
    }


    class StoringVisitor {
    public:
        StoringVisitor(std::set<std::string>& ids) : myIDs(ids) {}

        ~StoringVisitor() {}

        void add(const Named* const o) const {
            myIDs.insert(o->getID());
        }

        std::set<std::string>& myIDs;

    private:
        StoringVisitor(const StoringVisitor& src);

        StoringVisitor& operator=(const StoringVisitor& src);
    };



    void addTo(const StoringVisitor& cont) const {
        cont.add(this);
    }


protected:
    std::string myID;

};


#endif

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