X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketData.hh;h=96db5b14fb4fe1ef3a6e233e116cd7903c41ee5a;hb=748363b235c4651b3992cc291a95dc2e18e45724;hp=9ebe32e8999131870f648477ac06b1a47d1e1418;hpb=d084c02e4914da4fa1a4098a33d704f69e8bdedd;p=senf.git

diff --git a/Packets/PacketData.hh b/Packets/PacketData.hh
index 9ebe32e..96db5b1 100644
--- a/Packets/PacketData.hh
+++ b/Packets/PacketData.hh
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -28,7 +30,8 @@
 #include <boost/utility.hpp>
 #include <boost/type_traits.hpp>
 #include <boost/iterator/iterator_facade.hpp>
-#include "Utils/SafeBool.hh"
+#include "../Utils/safe_bool.hh"
+#include "../Utils/Exception.hh"
 #include "PacketTypes.hh"
 
 //#include "PacketData.mpp"
@@ -95,12 +98,19 @@ namespace senf {
         ///\name Sequence interface to raw data
         ///@{
 
-        iterator begin() const;
-        iterator end() const;
-        size_type size() const;
-        bool empty() const;
-        byte operator[](size_type n) const;
-        byte & operator[](size_type n);
+        iterator begin() const; ///< Return iterator to beginning
+                                /**< Returns an <em>random access iterator</em> referring to the
+                                     first byte of the packet data. */
+        iterator end() const; ///< Return iterator to end 
+                              /**< Returns an <em>random access iterator</em> referring to the 
+                                   byte past the end of the packet data. */
+        size_type size() const; ///< Returns the number of bytes in the packet data.
+        bool empty() const; ///< Test whether the packet data is empty.
+                            /**< Returns whether the packet data is empty, i.e. whether its size
+                                 is 0. This function does not modify the content of the packet 
+                                 data in any way. To clear the content use clear() */        
+        byte operator[](size_type n) const; ///< Access byte in the packet data
+        byte & operator[](size_type n); ///< Access byte in the packet data
 
         // Modifying the raw packet data
 
@@ -109,13 +119,18 @@ namespace senf {
         // only academic since what should an empty packet be good for ?
         void insert(iterator pos, byte v);
         void insert(iterator pos, size_type n, byte v);
+#       ifndef DOXYGEN
         template <class InputIterator>
         void insert(iterator pos, InputIterator f, InputIterator l,
                     typename boost::disable_if< boost::is_convertible<InputIterator,size_type> >::type * = 0);
+#       else
+        template <class InputIterator>
+        void insert(iterator pos, InputIterator f, InputIterator l);
+#       endif
 
         void erase(iterator pos);
         void erase(iterator first, iterator last);
-        void clear();
+        void clear(); ///< All bytes of the packet data dropped, leaving the container with a size of 0. */
         
         void resize(size_type n, byte v=0);
 
@@ -145,8 +160,8 @@ namespace senf {
         This exception is signaled whenever an operation tries to access an out-of-bounds data
         byte. If the packet has been implemented correctly, this signals a malformed packet.
      */
-    struct TruncatedPacketException : public std::exception
-    { virtual char const * what() const throw() { return "truncated packet"; } };
+    struct TruncatedPacketException : public senf::Exception
+    { TruncatedPacketException() : senf::Exception("truncated packet"){} };
 
     /** \brief Re-validating data iterator
 
@@ -163,7 +178,7 @@ namespace senf {
         : public boost::iterator_facade< safe_data_iterator,
                                          PacketData::value_type,
                                          boost::random_access_traversal_tag >,
-          public ComparableSafeBool<safe_data_iterator>
+          public comparable_safe_bool<safe_data_iterator>
     {
     public:
         typedef PacketData::size_type size_type;
@@ -213,7 +228,7 @@ namespace senf {
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #endif
-#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_PacketData_i_)
+#if !defined(HH_Packets__decls_) && !defined(HH_PacketData_i_)
 #define HH_PacketData_i_
 #include "PacketData.cci"
 //#include "PacketData.ct"