Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/basedtable.h

Timestamp:

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

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/HiStats/basedtable.h (modified) (7 diffs)

trunk/SophyaLib/HiStats/basedtable.h

@@ -18 +18 @@
 
 namespace SOPHYA {
+//! Interface definition for classes handling data in a table.
 class BaseDataTable : public AnyDataObj , public NTupleInterface {
 public:
@@ -33 +34 @@
   virtual           ~BaseDataTable();
   
+  //! Adds a column holding integer, named \b cnom
   inline sa_size_t  AddIntegerColumn(const char * cnom) 
   { return AddColumn(IntegerField, cnom); }
+  //! Adds a column holding integer, named \b cnom
   inline sa_size_t  AddIntegerColumn(string const & cnom) 
   { return AddColumn(IntegerField, cnom); }
+  //! Adds a column holding long integer, named \b cnom
   inline sa_size_t  AddLongColumn(const char * cnom) 
   { return AddColumn(LongField, cnom); }
+  //! Adds a column holding long integer, named \b cnom
   inline sa_size_t  AddLongColumn(string const & cnom) 
   { return AddColumn(LongField, cnom); }
+  //! Adds a column holding floating values (r_4), named \b cnom
   inline sa_size_t  AddFloatColumn(const char * cnom) 
   { return AddColumn(FloatField, cnom); }
+  //! Adds a column holding floating values (r_4), named \b cnom
   inline sa_size_t  AddFloatColumn(string const & cnom) 
   { return AddColumn(FloatField, cnom); }
+  //! Adds a column holding double values (r_8), named \b cnom
   inline sa_size_t  AddDoubleColumn(const char * cnom) 
   { return AddColumn(DoubleField, cnom); }
+  //! Adds a column holding double values (r_8), named \b cnom
   inline sa_size_t  AddDoubleColumn(string const & cnom) 
   { return AddColumn(DoubleField, cnom); }
+  //! Adds a column holding character strings, named \b cnom
   inline sa_size_t  AddStringColumn(const char * cnom) 
   { return AddColumn(StringField, cnom); }
+  //! Adds a column holding character strings, named \b cnom
   inline sa_size_t  AddStringColumn(string const & cnom) 
   { return AddColumn(StringField, cnom); }
@@ -69 +80 @@
 
   // Acces to various counts and parameters
+  //! Return the number of lines (rows) in the table)
   inline sa_size_t  NEntry() const { return mNEnt ; }
+  //! Return the number of columns in the tables (number of cells in a row)  
   inline sa_size_t  NVar() const   { return mNames.size() ; } 
+  //! Return the number of columns in the tables (number of cells in a row)  
   inline sa_size_t  NVars() const   { return mNames.size() ; } 
+  //! Return the segment size (SegDBInterface objects corresponding to columns)  
   inline sa_size_t  SegmentSize() const   { return mSegSz ; } 
+  //! Return the number of segments (SegDBInterface objects corresponding to columns)  
   inline sa_size_t  NbSegments() const   { return mNSeg ; } 
 
@@ -78 +94 @@
   virtual sa_size_t AddLine(const r_8* data);
   virtual sa_size_t AddLine(const MuTyV * data);
-  
+
+  //! Alias for AddLine()
   inline sa_size_t  Fill(const r_8* data)
   { return AddLine(data); }
+  //! Alias for AddLine()
   inline sa_size_t  Fill(const MuTyV * data);
      
   virtual sa_size_t Extend();
 
-  // Getting a given line (record) information 
+  //! Return the information stored in line \b n of the table 
   virtual MuTyV *   GetLine(sa_size_t n) const ;
-  
+
+  //! Return the index for column name \b nom  
   sa_size_t         IndexNom(char const* nom) const ; 
+  //! Return the index for column name \b nom  
   inline sa_size_t  IndexNom(string const & nom) const 
   { return IndexNom(nom.c_str()); }
+  //! Return the column name for column index \b k
   string            NomIndex(sa_size_t k) const ; 
 
@@ -107 +128 @@
   virtual void Clear() = 0;
 
-  // ---- ASCII I/O
+  //! Prints the table content - NOT YET IMPLEMENTED !
   void              Print(int num, int nmax=1) const ;
   
+//! Prints table definition and number of entries 
   void              Show(ostream& os) const ; 
+  //! Prints table definition and number of entries on the standard output stream \b cout
   inline void       Show() const { Show(cout) ; } 
   
@@ -144 +167 @@
   mutable r_8 *  mVarD;    // Pour retourner une ligne de la table
   mutable MuTyV *  mVarMTV;    // Pour retourner une ligne de la table en MuTyV
-  
+
+  //! \cond   Pour pas inclure ds la documentation doxygen
   typedef struct { 
     string nom; 
@@ -150 +174 @@
     sa_size_t ser;
   } colst;
+  //! \endcond  
   std::vector<colst> mNames;