Changeset 895 in Sophya for trunk/SophyaLib/BaseTools/dvlist.h

Timestamp:

Apr 12, 2000, 7:49:54 PM (25 years ago)

Author:

ansari

Message:

Documentation de fichiers - Reza 12/4/2000

File:

• trunk/SophyaLib/BaseTools/dvlist.h (modified) (4 diffs)

trunk/SophyaLib/BaseTools/dvlist.h

@@ -70 +70 @@
 //  Classe liste de variables  Dynamic Variable List  
 
+//! Dynamic Variable List class. 
 class DVList : public AnyDataObj {
 public:
@@ -97 +98 @@
 
   MuTyV&            Get(string const& key);
+/*! Returns the value associated with the name \b key */
   inline MuTyV&     operator()  (string const& key)  { return Get(key); }
+/*! Returns the value associated with the name \b key */
   inline MuTyV&     operator[]  (string const& key)  { return Get(key); }
+/*! Returns the global comment string associated with the object */
   inline string&    Comment() { return(comment); }
 
-  inline void       Print() const  { Print(cout); }  
+/*! Prints a brief description of object on \b cout */
+  inline  void      Show() const { Show(cout); }
+  virtual void      Show(ostream& os)  const;
+/*! Prints the list of variables on \b cout */
+  inline  void      Print() const  { Print(cout); }  
   virtual void      Print(ostream& os)  const;
 
@@ -111 +119 @@
   struct dvlElement {MuTyV elval; string elcomm; } ;
   typedef map<string, dvlElement, less<string> >  ValList; 
+/*! Returns an iterator pointing on the first variable in the list */
   inline ValList::const_iterator Begin() { return(mvlist.begin()); } 
+/*! Returns the iterator end value */
   inline ValList::const_iterator End() { return(mvlist.end()); } 
   
@@ -121 +131 @@
 };
 
+/*! operator << overloading - Prints the list on the stream \b s */
 inline ostream& operator << (ostream& s, DVList const & dvl)
   {  dvl.Print(s);  return(s);  }
 
+/*! Writes the object in the POutPersist stream \b os */
 inline POutPersist& operator << (POutPersist& os, DVList & obj)
 { ObjFileIO<DVList> fio(&obj);  fio.Write(os);  return(os); }
+/*! Reads the object from the PInPersist stream \b is */
 inline PInPersist& operator >> (PInPersist& is, DVList & obj)
 { ObjFileIO<DVList> fio(&obj);  fio.Read(is);  return(is); }