added some documentation for PacketData
[senf.git] / Packets / MPEGDVBBundle / SNDUPacket.hh
1 // $Id:DSMCCSection.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 /** \file
24     \brief SNDUPacket public header */
25
26 #ifndef HH_SNDUPacket_
27 #define HH_SNDUPacket_ 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/DefaultBundle/EthernetPacket.hh"
36
37 //#include "SNDUPacket.mpp"
38 ///////////////////////////////hh.p////////////////////////////////////////
39
40 namespace senf {
41
42     /** \brief parse ULE SNDU Packet
43     
44         Parser implementing the header and trailer of a ULE SNDU Packet
45         
46         \see SNDUPacketType
47      */
48     struct Parse_SNDUPacket : public PacketParserBase
49     {
50 #       ifndef DOXYGEN
51         
52         SENF_PACKET_PARSER_INIT(Parse_SNDUPacket);
53
54 #       endif
55         
56         typedef Parse_Flag      <     0 > Parse_daaf;  // Destination Address Absent Field
57         typedef Parse_UIntField < 1, 16 > Parse_length;
58                 
59         Parse_daaf d_bit() const {
60             return parse<Parse_daaf>( 0 );
61         }
62         Parse_length length() const {
63             return parse<Parse_length>( 0 );
64         }
65         Parse_UInt16 type() const {
66             return parse<Parse_UInt16>( 2 );
67         }
68         Parse_MAC destination() const {
69             BOOST_ASSERT( ! d_bit() );
70             return parse<Parse_MAC>( 4 );
71         }
72         Parse_UInt32 crc() const { 
73             return parse<Parse_UInt32>( data().size()-4 ); 
74         }
75         
76         PacketParserBase::size_type bytes() const;
77         
78         static const size_type init_bytes = 2+2+4; // D-Bit + 15 bits length + 16 bits type field + 32 bits crc
79     };
80
81     /** \brief ULE SNDU Packet
82         
83         \par Packet type (typedef):
84             \ref SNDUPacket
85
86         \par Fields:
87             \ref Parse_SNDUPacket
88
89         \ingroup protocolbundle_mpegdvb
90      */
91     struct SNDUPacketType
92         : public PacketTypeBase,
93           public PacketTypeMixin<SNDUPacketType>
94     {
95         typedef PacketTypeMixin<SNDUPacketType> mixin;
96         typedef ConcretePacket<SNDUPacketType> packet;
97         typedef Parse_SNDUPacket parser;
98
99         using mixin::nextPacketRange;
100 //          using mixin::nextPacketType;
101         using mixin::init;
102         
103         static void dump(packet p, std::ostream & os);
104         
105         static PacketParserBase::size_type initSize();
106         static PacketParserBase::size_type initHeadSize();
107     };
108         
109     typedef SNDUPacketType::packet SNDUPacket;
110
111     /*!
112      \def ULE_END_INDICATOR 
113          ULE End Indicator; indicates to the Receiver that there are no 
114          further SNDUs present within the current TS Packet.
115     */
116 #   define ULE_END_INDICATOR 0xffff
117 }
118
119
120 ///////////////////////////////hh.e////////////////////////////////////////
121 //#include "SNDUPacket.cci"
122 //#include "SNDUPacket.ct"
123 //#include "SNDUPacket.cti"
124 #endif
125
126 \f
127 // Local Variables:
128 // mode: c++
129 // fill-column: 100
130 // c-file-style: "senf"
131 // indent-tabs-mode: nil
132 // ispell-local-dictionary: "american"
133 // compile-command: "scons -u test"
134 // comment-column: 40
135 // End: