Move include files in debian packge into 'senf' subdirectory

[senf.git] / Packets / MPEGDVBBundle / DSMCCSection.hh

diff --git a/Packets/MPEGDVBBundle/DSMCCSection.hh b/Packets/MPEGDVBBundle/DSMCCSection.hh
index ae4f787..1f47945 100644 (file)
--- a/Packets/MPEGDVBBundle/DSMCCSection.hh
+++ b/Packets/MPEGDVBBundle/DSMCCSection.hh
@@ -1,9 +1,9 @@
-// $Id$
+// $Id:DSMCCSection.hh 327 2007-07-20 10:03:44Z tho $
 //
 // Copyright (C) 2007
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+//     Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -20,27 +20,31 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief DSMCCSection public header */
+
 #ifndef HH_DSMCCSection_
 #define HH_DSMCCSection_ 1
 
 // Custom includes
 #include <algorithm>
-#include "Packets/PacketType.hh"
-#include "Packets/ParseInt.hh"
-#include "Packets/PacketRegistry.hh"
-#include "Packets/PacketParser.hh"
+#include "../../Packets/PacketType.hh"
+#include "../../Packets/ParseInt.hh"
+#include "../../Packets/PacketParser.hh"
 
 //#include "DSMCCSection.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
 
+    /** \brief Parse a DSMCC Section
+    
+        Parser implementing the header of a DSMCC Section
+        
+        \see DSMCCSectionType
+     */
     struct Parse_DSMCCSection : public PacketParserBase
     {
-        SENF_PACKET_PARSER_INIT(Parse_DSMCCSection);
-
-        ///////////////////////////////////////////////////////////////////////////
-
         typedef Parse_UInt8               Parse_table_id;
         typedef Parse_Flag      <     0 > Parse_ssi;  // section_syntax_indicator
         typedef Parse_Flag      <     1 > Parse_pi;   // private_indicator
@@ -49,11 +53,15 @@ namespace senf {
         typedef Parse_UIntField < 0,  2 > Parse_reserved_2;
         typedef Parse_UIntField < 2,  7 > Parse_version_num;
         typedef Parse_Flag      <     7 > Parse_curr_next_indicator;
-                
+
+#       ifndef DOXYGEN
+        
+        SENF_PACKET_PARSER_INIT(Parse_DSMCCSection);
+
         SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
             ((Field       ) ( table_id,            Parse_table_id            )) 
             ((OverlayField) ( ssi,                 Parse_ssi                 ))
-            ((OverlayField) ( pi,                  Parse_pi                  ))
+            ((OverlayField) ( private_indicator,   Parse_pi                  ))
             ((OverlayField) ( reserved_1,          Parse_reserved_1          ))
             ((Field       ) ( sec_length,          Parse_sec_length          ))
             ((Field       ) ( tabel_id_extension,  Parse_UInt16              ))
@@ -64,9 +72,35 @@ namespace senf {
             ((Field       ) ( last_sec_num,        Parse_UInt8               ))
         );
         
+#       else
+        
+        Parse_table_id table_id() const;
+        Parse_ssi                 ssi() const;                 
+        Parse_pi                  pi() const;
+        Parse_reserved_1          reserved_1() const;
+        Parse_sec_length          sec_length const;
+        Parse_UInt16              tabel_id_extension() const;
+        Parse_reserved_2          reserved_2() const;
+        Parse_version_num         version_num() const;
+        Parse_curr_next_indicator curr_next_indicator() const;
+        Parse_UInt8               sec_num() const;
+        Parse_UInt8               last_sec_num() const;
+        
+#       endif
+        
         Parse_UInt32 crc() const { return parse<Parse_UInt32>( data().size()-4 ); }
     };
+    
+    /** \brief DSMCC Section
+        
+        \par Packet type (typedef):
+            \ref DSMCCSection
+
+        \par Fields:
+            \ref Parse_DSMCCSection
 
+        \ingroup protocolbundle_mpegdvb
+     */
     struct DSMCCSectionType
         : public PacketTypeBase,
           public PacketTypeMixin<DSMCCSectionType>