ChannelId.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2008-2013 (http://safirsdkcore.com)
* 
* Created by: Lars Hagström / stlrha
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
 
#ifndef __DOTS_CHANNEL_ID_H__
#define __DOTS_CHANNEL_ID_H__
 
#include <functional>
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/Utilities.h>
#include <Safir/Dob/Typesystem/Exceptions.h>
#include <Safir/Dob/Typesystem/Internal/InternalOperations.h>
#include <string>
#include <sstream>
 
namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    class ChannelId
    {
    public:
        static DOTS_CPP_API const ChannelId ALL_CHANNELS;
 
        ChannelId():
            m_channelId(Internal::DEFAULT_CHANNEL_ID),
            m_channelIdStr(L"DEFAULT_CHANNEL")
        {}
 
        ChannelId(const std::wstring& id):
            m_channelId(Internal::Generate64BitHash(id)),
            m_channelIdStr(id)
        {}
 
 
        explicit ChannelId(const Int64 id):
            m_channelId(id)
        {}
 
 
        ChannelId(const Int64 id, const std::wstring & idStr):
            m_channelId(id),
            m_channelIdStr(idStr)
        {
#ifndef NDEBUG
            if (!m_channelIdStr.empty() && m_channelId != Internal::Generate64BitHash(idStr))
            {
                std::wostringstream ostr;
                ostr << "ChannelId two-argument constructor got an inconsistent id. Got ("
                    << id << ", '" << idStr << "'), but the string evaluates to " << Internal::Generate64BitHash(idStr) << ".";
                throw SoftwareViolationException(ostr.str(),__WFILE__,__LINE__);
            }
#endif
        }
 
 
        void RemoveString() {m_channelIdStr.clear(); m_CachedUtf8String.clear();}
 
        bool operator ==(const ChannelId & other) const
        {
            return m_channelId == other.m_channelId;
        }
 
        bool operator !=(const ChannelId & other) const
        {
            return !(*this==other);
        }
 
        bool operator < (const ChannelId & other) const
        {
            return m_channelId < other.m_channelId;
        }
 
        DOTS_CPP_API const std::wstring ToString() const;
 
 
        typedef Int64 UnderlyingType;
 
        UnderlyingType GetRawValue() const {return m_channelId;}
 
        const std::wstring & GetRawString() const {return m_channelIdStr;}
 
        Int32 Utf8StringLength() const
        {
            if (m_channelIdStr.empty())
            {
                return 0;
            }
 
            if (m_CachedUtf8String.empty())
            {
                m_CachedUtf8String = Utilities::ToUtf8(m_channelIdStr);
            }
 
            return static_cast<Int32>(m_CachedUtf8String.length() + 1);
        }
 
        const std::string & Utf8String() const
        {
            if (!m_channelIdStr.empty() && m_CachedUtf8String.empty())
            {
                m_CachedUtf8String = Utilities::ToUtf8(m_channelIdStr);
            }
            return m_CachedUtf8String;
        }
 
    private:
        UnderlyingType m_channelId;
        std::wstring   m_channelIdStr;
 
        mutable std::string m_CachedUtf8String;
    };
 
    static inline std::wostream & operator << (std::wostream& out, const ChannelId& channelId)
    {return out << channelId.ToString();}
 
    //Make it possible to use ChannelId as key in a dictionaries.
    inline std::size_t hash_value(const Safir::Dob::Typesystem::ChannelId& val)
    {return std::hash<ChannelId::UnderlyingType>()(val.GetRawValue());}
}
}
}
#endif