source: trunk/yat/utility/TypeInfo.h @ 1887

#ifndef _theplu_yat_utility_type_info_
#define _theplu_yat_utility_type_info_

// $Id: TypeInfo.h 1887 2009-03-31 17:38:16Z peter $

/*
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include <string>
#include <typeinfo>

namespace theplu {
namespace yat {
namespace utility {

  /**
     @brief Wrapper class for storing std::type_info
  */
  class TypeInfo
  {
  public:
    /**
       @brief Constructor 
    */
    // For STL container usage
    TypeInfo(void);

    /**
       @brief Constructor 
    */
    // For convenience we allow implicit conversion from type_info to
    // TypeInfo.
    TypeInfo(const std::type_info&);

    /**
       \return stored type_info
     */
    const std::type_info& get(void) const;

    /**
       \return name of type
     */
    std::string name(void) const;

    /**
       @brief assignment operator
    */
    TypeInfo& operator=(const TypeInfo&);

  private:
    // Using compiler generated copy constructor
    // TypeInfo(const TypeInfo&);
    // Using compiler generated assignment operator
    // TypeInfo(const TypeInfo&);

    const std::type_info* info_;
  };

  /**
     \brief Equality comparison
     \return true iff underlying std::type_info are equal

     \relates TypeInfo
   */  
  bool operator==(const TypeInfo&, const TypeInfo&);

  /**
     \brief Based on operator==

     \relates TypeInfo
   */  
  bool operator!=(const TypeInfo&, const TypeInfo&);

  /**
     \brief Ordering relation
     \return true iff underlying lhs.get()<rhs.get()

     \relates TypeInfo
   */  
  bool operator<(const TypeInfo& lhs, const TypeInfo& rhs);

  /**
     \brief Based on operators == and <

     \relates TypeInfo
   */  
  bool operator<=(const TypeInfo&, const TypeInfo&);

  /**
     \brief Based on operator <

     \relates TypeInfo
   */  
  bool operator>(const TypeInfo&, const TypeInfo&);

  /**
     \brief Based on operator <=

     \relates TypeInfo
   */  
  bool operator>=(const TypeInfo&, const TypeInfo&);

}}} // of namespace utility, yat, and theplu

#endif