Add missing doxygen \file comments
[senf.git] / Packets / MPEGDVBBundle / DatagramSection.hh
1 // $Id:DatagramSection.hh 327 2007-07-20 10:03:44Z tho $
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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 /** \brief
24     \file DatagramSection public header */
25
26 #ifndef HH_DatagramSection_
27 #define HH_DatagramSection_ 1
28
29 // Custom includes
30 #include <algorithm>
31 #include "Packets/PacketType.hh"
32 #include "Packets/ParseInt.hh"
33 #include "Packets/PacketRegistry.hh"
34 #include "Packets/PacketParser.hh"
35 #include "Packets/MPEGDVBBundle/DSMCCSection.hh"
36
37
38 //#include "DatagramSection.mpp"
39 ///////////////////////////////hh.p////////////////////////////////////////
40
41 namespace senf {
42
43     ///\addtogroup protocolbundle_mpegdvb
44     ///@{
45
46     struct Parse_DatagramSection : public Parse_DSMCCSection
47     {
48         //SENF_PACKET_PARSER_NO_INIT(Parse_DatagramSection);
49         Parse_DatagramSection(data_iterator i, state_type s) : senf::Parse_DSMCCSection(i,s) {}
50
51         ///////////////////////////////////////////////////////////////////////////
52
53         typedef Parse_UIntField < 2,  4 > Parse_payload_scrmbl_ctrl;
54         typedef Parse_UIntField < 4,  6 > Parse_addr_scrmbl_ctrl;
55         typedef Parse_Flag      <     6 > Parse_llc_snap_flag;
56                 
57         SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS_OFFSET(Parse_DSMCCSection::fixed_bytes,
58             ((Field       ) ( mac_addr_4, Parse_UInt8 ))
59             ((Field       ) ( mac_addr_3, Parse_UInt8 ))
60             ((Field       ) ( mac_addr_2, Parse_UInt8 ))
61             ((Field       ) ( mac_addr_1, Parse_UInt8 ))
62         );
63         
64         Parse_UInt8 mac_addr_6() const { return parse<Parse_UInt8>( 3 ); }
65         Parse_UInt8 mac_addr_5() const { return parse<Parse_UInt8>( 4 ); }
66         Parse_payload_scrmbl_ctrl payload_scrmbl_ctrl() const {
67             return parse<Parse_payload_scrmbl_ctrl>( 5 );
68         }
69         Parse_addr_scrmbl_ctrl addr_scrmbl_ctrl() const {
70             return parse<Parse_addr_scrmbl_ctrl>( 5 );
71         }
72         Parse_llc_snap_flag llc_snap_flag() const {
73             return parse<Parse_llc_snap_flag>( 5 );
74         }
75         
76         void init() 
77         {
78             Parse_DSMCCSection::init();
79             defaultInit();
80         }  
81     };
82
83     struct DatagramSectionType
84         : public DSMCCSectionType,
85           public PacketTypeMixin<DatagramSectionType>
86     {
87         typedef PacketTypeMixin<DatagramSectionType> mixin;
88         typedef ConcretePacket<DatagramSectionType> packet;
89         typedef Parse_DatagramSection parser;
90
91         using mixin::nextPacketRange;
92 //          using mixin::nextPacketType;
93         //using mixin::initSize;
94         using mixin::init;
95         
96         static void dump(packet p, std::ostream & os);
97         
98         static PacketParserBase::size_type initSize();
99         static PacketParserBase::size_type initHeadSize();
100     };
101         
102     typedef DatagramSectionType::packet DatagramSection;
103     
104     ///@}
105 }
106
107
108 ///////////////////////////////hh.e////////////////////////////////////////
109 //#include "DatagramSection.cci"
110 //#include "DatagramSection.ct"
111 //#include "DatagramSection.cti"
112 #endif
113
114 \f
115 // Local Variables:
116 // mode: c++
117 // fill-column: 100
118 // c-file-style: "senf"
119 // indent-tabs-mode: nil
120 // ispell-local-dictionary: "american"
121 // compile-command: "scons -u test"
122 // comment-column: 40
123 // End: