Packets/GenericTLV: started with documentation how to use GenericTLVBase
[senf.git] / senf / Packets / GenericTLV.cti
1 // $Id$
2 //
3 // Copyright (C) 2009
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Thorsten Horstmann <tho@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 GenericTLV inline template implementation */
25
26 //#include "GenericTLV.ih"
27
28 // Custom includes
29
30 #define prefix_ inline
31 ///////////////////////////////cti.p///////////////////////////////////////
32
33 template <class Base>
34 prefix_ senf::PacketParserBase::size_type senf::GenericTLVParserBase<Base>::bytes()
35 {
36     return senf::init_bytes<Base>::value + this->length();
37 }
38
39 template <class Base>
40 prefix_ void senf::GenericTLVParserBase<Base>::init()
41     const
42 {
43     this->defaultInit();
44 }
45
46 template <class Base>
47 template <class Parser>
48 prefix_ Parser senf::GenericTLVParserBase<Base>::as()
49 {
50     return Parser(this->i(), this->state() );
51 }
52
53 template <class Base>
54 template <class Parser>
55 prefix_ bool senf::GenericTLVParserBase<Base>::is()
56 {
57     return this->type().value() == Parser::TYPEID;
58 }
59
60 #ifndef DOXYGEN
61
62 template <class Base>
63 template <class ForwardReadableRange>
64 prefix_ void senf::GenericTLVParserBase<Base>::value(
65         ForwardReadableRange const & val,
66         typename boost::disable_if<senf::is_pair<ForwardReadableRange> >::type *)
67
68     value_( val); 
69 }
70
71 template <class Base>
72 template <class First, class Second>
73 prefix_ void senf::GenericTLVParserBase<Base>::value(
74         std::pair<First, Second> const & val,
75         typename boost::disable_if<boost::is_convertible<First, typename Base::type_t::value_type> >::type *)
76
77     value_( val); 
78 }
79
80 template <class Base>
81 template <class Type, class ForwardReadableRange>
82 prefix_ void senf::GenericTLVParserBase<Base>::value(
83         std::pair<Type, ForwardReadableRange> const & val,
84         typename boost::enable_if<boost::is_convertible<Type, typename Base::type_t::value_type> >::type *)
85
86     this->type() = val.first;
87     value_( val.second); 
88 }
89
90 #endif
91
92 ///////////////////////////////cti.e///////////////////////////////////////
93 #undef prefix_
94
95 \f
96 // Local Variables:
97 // mode: c++
98 // fill-column: 100
99 // comment-column: 40
100 // c-file-style: "senf"
101 // indent-tabs-mode: nil
102 // ispell-local-dictionary: "american"
103 // compile-command: "scons -u test"
104 // End: