fwID.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2017.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWTOOLS_FWID_HPP__
#define __FWTOOLS_FWID_HPP__

#include "fwTools/config.hpp"

#include <fwCore/base.hpp>
#include <fwCore/mt/types.hpp>

#include <cstdint>
#include <string>
#include <unordered_map>

namespace fwTools
{

class Object;
class FWTOOLS_CLASS_API fwID
{
public:

    fwCoreBaseClassDefinitionsMacro( (fwID) );

    typedef std::string IDType;

    typedef enum
    {
        EMPTY = 1,    
        GENERATE,     
        MUST_EXIST    
    } Policy;

    FWTOOLS_API static bool exist( IDType _id);

    FWTOOLS_API static SPTR(::fwTools::Object ) getObject( IDType requestID );

    FWTOOLS_API virtual ~fwID();

protected:

    // API to expose in fwTools::Object
    FWTOOLS_API bool   hasID() const;

    FWTOOLS_API IDType getID( Policy policy = GENERATE ) const;

    FWTOOLS_API virtual void   setID( IDType newID ); // cannot set a empty one

    FWTOOLS_API void   resetID();

    fwID()
    {
    }          // cannot be instantiated

private:

    IDType generate() const;

    static void removeIDfromDictionary(IDType _id );

    static bool isIdFound( IDType _id);

    void addIDInDictionary( IDType newID );

    IDType m_id;

    typedef std::unordered_map< IDType, WPTR(::fwTools::Object ) > Dictionary;
    typedef std::unordered_map< std::string, std::uint32_t >  CategorizedCounter;

    static Dictionary m_dictionary;
    static CategorizedCounter m_CategorizedCounter;

    static ::fwCore::mt::ReadWriteMutex s_dictionaryMutex;

    static ::fwCore::mt::Mutex s_mutexCounter;

    mutable ::fwCore::mt::ReadWriteMutex m_idMutex;
};

}

#endif /* __FWTOOLS_FWID_HPP__ */