Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Utils / TypeIdValue.hh
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief TypeIdValue public header */
25
26 #ifndef HH_SENF_Utils_TypeIdValue_
27 #define HH_SENF_Utils_TypeIdValue_ 1
28
29 // Custom includes
30 #include <typeinfo>
31 #include <string>
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/operators.hpp>
34
35 //#include "TypeIdValue.mpp"
36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
37
38 namespace senf {
39
40
41     /** \brief Wrapper to use types as key's in a map
42       */
43     class TypeIdValue : public boost::totally_ordered<TypeIdValue>
44     {
45     public:
46         //-////////////////////////////////////////////////////////////////////////
47         ///\name Structors and default members
48         //\{
49
50         // my default constructor
51         // my copy constructor
52         // my copy assignment
53         // default destructor
54         // no conversion constructors
55
56         TypeIdValue();
57         TypeIdValue(std::type_info const & v);
58
59         //\}
60         //-////////////////////////////////////////////////////////////////////////
61
62         bool operator==(TypeIdValue const & other) const;
63         bool operator<(TypeIdValue const & other) const;
64
65         std::string name() const;
66         std::string prettyName() const;
67
68         std::type_info const & id() const;
69
70     protected:
71
72     private:
73         std::type_info const * p_;
74     };
75
76     /**
77         \related TypeIdValue
78      */
79     TypeIdValue const typeIdValue();
80
81     /**
82         \related TypeIdValue
83      */
84     template <class Type>
85     TypeIdValue const typeIdValue();
86
87     /**
88         \related TypeIdValue
89      */
90     template <class Type>
91     TypeIdValue const typeIdValue(Type const & ob);
92
93     /**
94         \related TypeIdValue
95      */
96     std::ostream & operator<<(std::ostream & os, TypeIdValue const & v);
97 }
98
99 //-/////////////////////////////////////////////////////////////////////////////////////////////////
100 #include "TypeIdValue.cci"
101 //#include "TypeIdValue.ct"
102 #include "TypeIdValue.cti"
103 #endif
104
105 \f
106 // Local Variables:
107 // mode: c++
108 // fill-column: 100
109 // c-file-style: "senf"
110 // indent-tabs-mode: nil
111 // ispell-local-dictionary: "american"
112 // compile-command: "scons -u test"
113 // comment-column: 40
114 // End: