LookupKey.hpp

Go to the documentation of this file.

/* 
 * LookupKey.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * 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 2 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; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_BASE_VALUEKEY_HPP
#define CDPL_BASE_VALUEKEY_HPP
 
#include <cstddef>
#include <string>
 
#include "CDPL/Base/APIPrefix.hpp"
 
 
namespace CDPL
{
 
    namespace Base
    {
 
        class CDPL_BASE_API LookupKey
        {
 
          public:
            struct HashFunc
            {
 
                std::size_t operator()(const LookupKey& key) const;
            };
 
            static const LookupKey NONE;
 
            static LookupKey create(const std::string& name);
 
            void setName(const std::string& name) const;
 
            const std::string& getName() const;
 
            std::size_t getID() const;
 
            bool operator<(const LookupKey& key) const;
 
            bool operator==(const LookupKey& key) const;
 
            bool operator!=(const LookupKey& key) const;
 
          private:
            LookupKey(std::size_t id):
                numericID(id) {}
 
            std::size_t numericID;
        };
    } // namespace Base
} // namespace CDPL
 
 
// Implementation
 
inline std::size_t CDPL::Base::LookupKey::getID() const
{
    return numericID;
}
 
inline bool CDPL::Base::LookupKey::operator<(const LookupKey& key) const
{
    return (numericID < key.numericID);
}
 
inline bool CDPL::Base::LookupKey::operator==(const LookupKey& key) const
{
    return (numericID == key.numericID);
}
 
inline bool CDPL::Base::LookupKey::operator!=(const LookupKey& key) const
{
    return (numericID != key.numericID);
}
 
 
inline std::size_t CDPL::Base::LookupKey::HashFunc::operator()(const LookupKey& key) const
{
    return key.numericID;
}
 
#endif // CDPL_BASE_VALUEKEY_HPP