switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Utils / TypeIdValue.hh
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief TypeIdValue public header */
30
31 #ifndef HH_SENF_Utils_TypeIdValue_
32 #define HH_SENF_Utils_TypeIdValue_ 1
33
34 // Custom includes
35 #include <typeinfo>
36 #include <string>
37 #include <boost/scoped_ptr.hpp>
38 #include <boost/operators.hpp>
39
40 //#include "TypeIdValue.mpp"
41 //-/////////////////////////////////////////////////////////////////////////////////////////////////
42
43 namespace senf {
44
45
46     /** \brief Wrapper to use types as key's in a map
47       */
48     class TypeIdValue : public boost::totally_ordered<TypeIdValue>
49     {
50     public:
51         //-////////////////////////////////////////////////////////////////////////
52         ///\name Structors and default members
53         //\{
54
55         // my default constructor
56         // my copy constructor
57         // my copy assignment
58         // default destructor
59         // no conversion constructors
60
61         TypeIdValue();
62         TypeIdValue(std::type_info const & v);
63
64         //\}
65         //-////////////////////////////////////////////////////////////////////////
66
67         bool operator==(TypeIdValue const & other) const;
68         bool operator<(TypeIdValue const & other) const;
69
70         std::string name() const;
71         std::string prettyName() const;
72
73         std::type_info const & id() const;
74
75     protected:
76
77     private:
78         std::type_info const * p_;
79     };
80
81     /**
82         \related TypeIdValue
83      */
84     TypeIdValue const typeIdValue();
85
86     /**
87         \related TypeIdValue
88      */
89     template <class Type>
90     TypeIdValue const typeIdValue();
91
92     /**
93         \related TypeIdValue
94      */
95     template <class Type>
96     TypeIdValue const typeIdValue(Type const & ob);
97
98     /**
99         \related TypeIdValue
100      */
101     std::ostream & operator<<(std::ostream & os, TypeIdValue const & v);
102 }
103
104 //-/////////////////////////////////////////////////////////////////////////////////////////////////
105 #include "TypeIdValue.cci"
106 //#include "TypeIdValue.ct"
107 #include "TypeIdValue.cti"
108 #endif
109
110 \f
111 // Local Variables:
112 // mode: c++
113 // fill-column: 100
114 // c-file-style: "senf"
115 // indent-tabs-mode: nil
116 // ispell-local-dictionary: "american"
117 // compile-command: "scons -u test"
118 // comment-column: 40
119 // End: