Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/datatable.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/datatable.cc (modified) (6 diffs)

trunk/SophyaLib/HiStats/datatable.cc

@@ -11 +11 @@
    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 ...).
+   The whole data set is kept in memory.
    \sa SOPHYA::MuTyV
    \sa SOPHYA::BaseDataTable
-   \sa SOPHYA::ObjFileIO<DataTable>
+   \sa SOPHYA::SegDataBlock
 
    \code
@@ -43 +45 @@
 }
 
-//! copy constructor - shares the data
+//! copy constructor 
+/*!
+  The copy constructur shares the data if \b share=true. 
+  Otherwise, the Clone() method is called to make a complete copy.
+*/
 DataTable::DataTable(DataTable const & a, bool share)
   : BaseDataTable(a.SegmentSize())
@@ -53 +59 @@
   if (a.mInfo)  mInfo = new DVList(*(a.mInfo));
 }
-
+//! Copy the table structure from \b a and shares the data (columns content)
 void DataTable::Share(DataTable const & a)
 {
@@ -85 +91 @@
 }
 
+//! Copy the table structure from \b a and duplicate (copy) the data (columns content)
 void DataTable::Clone(DataTable const & a)
 {
@@ -115 +122 @@
   }  
 }
-
+//! Reset (/clear) the table content and structure
 void DataTable::Clear()
 {
@@ -151 +158 @@
 
 
+/*! 
+  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 DataTable::AddColumn(FieldType ft, string const & cnom)
 {