UniqueId.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include "Export.h"

#include <trBase/SmrtClass.h>
#include <trUtil/RefStr.h>
#include <trUtil/Hash.h>

#include <string>
#include <sstream>
#include <iosfwd>

namespace trBase
{
    // Forward declarations of the pimpl class
    class implId;

    class TR_BASE_EXPORT UniqueId : public trBase::SmrtClass
    {

    public:

        using BaseClass = trBase::SmrtClass;            

        const static trUtil::RefStr CLASS_TYPE;         

        explicit UniqueId(bool createNewId = true);

        UniqueId(const UniqueId& toCopy);

        explicit UniqueId(const std::string& toCopy);

        virtual ~UniqueId();

        virtual const std::string& GetType() const override;

        const std::string ToString() const;

        void FromString(const std::string& idString);

        bool IsNull() const;

        UniqueId& operator=(const UniqueId& id);

        UniqueId& operator=(const UniqueId* id);

        UniqueId& operator=(const std::string& id);

        bool operator==(const UniqueId& id) const;

        bool operator!=(const UniqueId& id) const;

        bool operator< (const UniqueId& id) const;

        bool operator> (const UniqueId& id) const;

    protected:
        implId* mGUIDPtr = nullptr;
    };

    TR_BASE_EXPORT std::ostream& operator << (std::ostream& o, const UniqueId& id);

    TR_BASE_EXPORT std::istream& operator >> (std::istream& i, UniqueId& id);
}

namespace trUtil
{
    template<> struct hash<trBase::UniqueId>
    {
        size_t operator()(const trBase::UniqueId& id) const
        {
            return __hash_string(id.ToString().c_str());
        }
    };

    template<> struct hash<const trBase::UniqueId>
    {
        size_t operator()(const trBase::UniqueId& id) const
        {
            return __hash_string(id.ToString().c_str());
        }
    };
}