Named.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Base class for objects which have an id.
/****************************************************************************/
#pragma once
#include <config.h>
#include <iostream>
#include <string>
#include <set>
 
 
// @note Numbers of different lengths 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();
    }
};
 
 
struct ComparatorNumericalIdLess {
    template<class T>
    bool operator()(const T* const a, const T* const b) const {
        return a->getNumericalID() < b->getNumericalID();
    }
};
 
 
// ===========================================================================
// 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;
    }
 
 
    virtual void setID(const std::string& newID) {
        myID = newID;
    }
 
 
    class StoringVisitor {
    public:
        StoringVisitor(std::set<const Named*>& objects) : myObjects(objects) {}
 
        ~StoringVisitor() {}
 
        void add(const Named* const o) const {
            myObjects.insert(o);
        }
 
        std::set<const Named*>& myObjects;
 
    private:
        StoringVisitor(const StoringVisitor& src);
 
        StoringVisitor& operator=(const StoringVisitor& src);
    };
 
 
    void addTo(const StoringVisitor& cont) const {
        cont.add(this);
    }
 
 
protected:
    std::string myID;
 
};