Changeset 2805 in Sophya for trunk/SophyaLib/BaseTools/ppfnametag.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/ppfnametag.h (modified) (1 diff)

trunk/SophyaLib/BaseTools/ppfnametag.h

@@ -7 +7 @@
 
 #include "ppersist.h"
-
+/*!
+   \class SOPHYA::PPFNameTag
+   \ingroup BaseTools
+   A simple class which can be used in conjuction with << and >> operators
+   to write nametags in POutPersist streams or position an input PInPersist
+   stream at a given nametag. 
+   Nametags are strings which can be used to identify objects for further 
+   retrieval in PPF streams.
+   Pushing a PPFNameTag(tname) to an output stream \b os corresponds to 
+   so.WriteNameTag(tname). Extracting a PPFNameTag(tname) from an input stream
+   \b is corresponds to is.GotoNameTag(tname).
+   
+   \code
+   {
+   // Writing a name tag and an object to a stream
+   NDataBlock<int_4> idb(16);
+   idb = 16;
+   POutPersist so("myfile.ppf");
+   so << PPFNameTag("MyIDB") << idb ;
+   }
+   //...
+   {
+   // Positioning and Reading from a PPF stream
+   PInPersist si("myfile.ppf");
+   NDataBlock<int_4> idb;
+   si >>  PPFNameTag("MyIDB") >> idb;
+   }
+   \endcode
+*/
 //----------------------------------------------------------------------
 namespace SOPHYA {