Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/swppfdtable.cc

Timestamp:

Jun 14, 2005, 1:25:05 PM (20 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/HiStats/swppfdtable.cc (modified) (5 diffs)

trunk/SophyaLib/HiStats/swppfdtable.cc

@@ -9 +9 @@
    This class can be used to organize data in table (row-column) form.
    Each column holds homogeneous data (same data type), while different
-   columns can be used for different data types (integer, float, string ...)
+   columns can be used for different data types 
+   (integer, float, string ...).
+   A PPF stream is used as swap space. Due to limitations in the current
+   implementation of PPF streams, read operations (acces to table data) cannot
+   be performed when a table is being filled. 
+
+   \warning 
+   - When creating a table, the output PPF stream (POutPersist) must not be closed
+   (destroyed) before the call to the SwPPFDataTable object.
+   - It is not possible to make a complete (deep) copy of a table SwPPFDataTable
+   Copy constructor and equal operator shares the data.
+   - Although the destructor  DOES NOT save the 
+   table object itself to the memory. You have to use the << operator on the 
+   output PPF stream being used as swap
+
    \sa SOPHYA::MuTyV
-   \sa SOPHYA::BaseDataTable
-   \sa SOPHYA::ObjFileIO<DataTable>
+   \sa SOPHYA::DataTable
+   \sa SOPHYA::SwSegDataBlock  SOPHYA::PPFDataSwapper
 
    \code
    #include "swppfdtable.h"
    // ...
-   DataTable dt(64);
+   {
+   // ---- Creation of the table
+   // Create the swap stream 
+   POutPersist so("myswtable.ppf");
+   SwPPFDataTable dt(so, 64);
+   // define table columns
    dt.AddFloatColumn("X0_f");
    dt.AddFloatColumn("X1_f");
    dt.AddDoubleColumn("X0X0pX1X1_d");
-   double x[5];
+   // Fill the table
+   MuTyV x[5];
    for(int i=0; i<63; i++) {
      x[0] = (i%9)-4.;  x[1] = (i/9)-3.;  x[2] = x[0]*x[0]+x[1]*x[1];
@@ -28 +48 @@
    // Printing table info
    cout << dt ;
-   // Saving object into a PPF file
-   POutPersist po("dtable.ppf");
-   po << dt ;
+   // Swap out all data and write the table structure to the PPF stream 
+   so << dt ;
+   // ....
+   }
+   {
+   // ---- Accessing information from a previously created table
+   SwPPFDataTable dt;
+   PInPersist si("myswtable.ppf");
+   si >> dt;
+   // Printing table info
+   cout << dt ;   
+   }
    \endcode
 */
-/*! Default constructor with optional specification of block (or segment) size - 
-    NOT intented for general use 
-*/
+//! Default constructor with optional specification of block (or segment) size 
 SwPPFDataTable::SwPPFDataTable(sa_size_t segsz)
   : BaseDataTable(segsz),
@@ -205 +232 @@
 
 
+/*! 
+  Implements the action defined in the BaseDataTable interface.
+  In the current implementation, throws an exception (ParmError) 
+  if the table contains some data already.
+*/
 sa_size_t SwPPFDataTable::AddColumn(FieldType ft, string const & cnom)
 {
@@ -271 +303 @@
 }
 
+//! Adds a line (or row to the table) with r_8* input data.
+/*! 
+  The min/max values for each column is updated, in addition 
+  to the actions performed by the base class AddLine()
+*/
 sa_size_t SwPPFDataTable::AddLine(const r_8* data)
 {
@@ -284 +321 @@
 }
 
+//! Adds a line (or row to the table) with input data as an array of MuTyV
+/*! 
+  The min/max values for each column is updated, in addition 
+  to the actions performed by the base class AddLine()
+*/
 sa_size_t SwPPFDataTable::AddLine(const MuTyV * data)
 {