Changeset 2805 in Sophya for trunk/SophyaLib/BaseTools/swsegdb.h

Timestamp:

Jun 9, 2005, 6:20:00 PM (20 years ago)

Author:

ansari

Message:

MAJ commentaires pour documentation doxygen - Reza 9 Juin 2005

File:

• trunk/SophyaLib/BaseTools/swsegdb.h (modified) (5 diffs)

trunk/SophyaLib/BaseTools/swsegdb.h

@@ -12 +12 @@
 #include <typeinfo>
 
-namespace SOPHYA {
-
-////////////////////////////////////////////////////////////////
-//// ------------- Class DataSwapperInterface --------------- //
-//// ---------------- Class SwSegDataBlock ------------------ //
-////////////////////////////////////////////////////////////////
-
 /*!
   \class SOPHYA::DataSwapperInterface
@@ -25 +18 @@
   with SOPHYA::SwSegDataBlock classes.
 */
-template <class T> 
-class DataSwapperInterface {
-public:
-  virtual ~DataSwapperInterface() { }
-  //! Swap out the data array pointed by \b d with size \b sz
-  virtual int_8 WriteToSwap(const T * d, size_t sz, int_8 idx, int_8 oswp=0, bool osw=false) = 0;
-  //! Swap in the data array pointed by \b d with size \b sz
-  virtual void  ReadFromSwap(int_8 idx, int_8 swp, T* d, size_t sz) = 0;
-};
-
-//! Segmented data structure with swap management
 /*!
   \class SOPHYA::SwSegDataBlock
@@ -41 +23 @@
   Segmented data structure with swap space management.
 */
+
+namespace SOPHYA {
+
+////////////////////////////////////////////////////////////////
+//// ------------- Class DataSwapperInterface --------------- //
+//// ---------------- Class SwSegDataBlock ------------------ //
+////////////////////////////////////////////////////////////////
+
+template <class T> 
+class DataSwapperInterface {
+public:
+  virtual ~DataSwapperInterface() { }
+  /*! Swap out the data array pointed by \b d with size \b sz
+    Return the swap position which might be used later to retrieve the data from swap
+    \param d : Pointer to the memory segment
+    \param sz : Number of elements (type T) 
+    \param idx : An integer which might be used to identify the data (optional)
+    \param oswp : Old swap position, if the data has already been swapped
+    \param osw : true -> data has already been swapped
+  */
+  virtual int_8 WriteToSwap(const T * d, size_t sz, int_8 idx, int_8 oswp=0, bool osw=false) = 0;
+  /*! Swap in the data array pointed by \b d with size \b sz
+    Retrieves the data from swap space and copies it to \b d
+    \param idx : optional data identifier
+    \param swp : swap position (obtained from a previous call to WriteToSwap()
+    \param d : pointer to T , where the data will be copied from swap space
+    \param sz : Number of data elements (type T) 
+   */
+  virtual void  ReadFromSwap(int_8 idx, int_8 swp, T* d, size_t sz) = 0;
+};
+
 template <class T>
 class SwSegDataBlock : public SegDBInterface<T> {
@@ -172 +185 @@
   }
 
+  //! \cond
   typedef struct {
     size_t nref;      // Number of references to the data structure  
@@ -183 +197 @@
     DataSwapperInterface<T> * swapper;   // Data swapper
   } SWSDREF;
-
+  //! \endcond
   SWSDREF *  mSRef;    // SWSDREF structure for reference sharing
 };