Changeset 2805 in Sophya for trunk/SophyaLib/BaseTools/ppfbinstream.cc

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/ppfbinstream.cc (modified) (10 diffs)

trunk/SophyaLib/BaseTools/ppfbinstream.cc

@@ -52 +52 @@
 //-------------------------------------------------------------------------
 
+/*!
+   \class SOPHYA::PPFBinaryIOStream
+   \ingroup BaseTools
+   Base class for SOPHYA PPF input / output stream
+*/
+
 
 PPFBinaryIOStream::PPFBinaryIOStream()
@@ -68 +74 @@
 }
 
+//! Return the creation date/time of the associated stream as a string 
 string 
 PPFBinaryIOStream::CreationDateStr()
@@ -76 +83 @@
 }
 
+//! Return a string with information about the stream (creation-date, version ...)
 string 
 PPFBinaryIOStream::InfoString()
@@ -95 +103 @@
 
 
+//! Return the name tag number \b itag
 string
 PPFBinaryIOStream::GetTagName(int itag)
@@ -105 +114 @@
 
 
+//! Return a reference to a vector<string> containing all name-tags associated with the stream
 static vector<string> * ret_tag_names = NULL;
 vector<string> const &
@@ -120 +130 @@
 //-------------------------------------------------------------------------
 
+/*!
+   \class SOPHYA::PPFBinaryInputStream
+   \ingroup BaseTools
+   PPF Input stream implementing read operations
+*/
+
+/*! Constructor from a RawInOutStream pointer
+  \param is : pointer to RawInOutStream
+  \param ad : if true, the RawInOutStream \b is is deleted by the destructor 
+  \param scan : if true, try to read the name-tags table from the end of the input stream
+*/ 
 PPFBinaryInputStream::PPFBinaryInputStream(RawInOutStream * is, bool ad, bool scan)
 {
@@ -127 +148 @@
 }
 
-//++
+/*! Constructor 
+  \param  flnm : input file name
+  \param scan : if true, try to read the name-tags table from the end of the input stream
+*/  
 PPFBinaryInputStream::PPFBinaryInputStream(string const& flnm, bool scan)
 //
@@ -995 +1019 @@
 }
 
-
+/*! Scans the streams and prints in text format to standard output (cout) the PPF 
+   stream content. 
+   \param lev : print level (level of details) = 0,1,2,3
+*/
 void
 PPFBinaryInputStream::AnalyseTags(int lev)
@@ -1225 +1252 @@
 //--
 
+/*!
+   \class SOPHYA::PPFBinaryInputStream
+   \ingroup BaseTools
+   PPF output stream implementing write operations. The byte-ordering (endianess) 
+   of the output stream can be selected at creation. By default, the native endianness 
+   of the machine is used.  
+*/
+
+/*! Constructor from a RawInOutStream pointer
+  \param os : pointer to RawInOutStream
+  \param ad : if true, the RawInOutStream \b os is deleted by the destructor 
+  \param endianness : Endianness selector  PPS_NATIVE PPS_LITTLE_ENDIAN PPS_BIG_ENDIAN 
+*/ 
 PPFBinaryOutputStream::PPFBinaryOutputStream(RawInOutStream* os, bool ad, int endianness)
 {
@@ -1232 +1272 @@
 }
 
+/*! Constructor 
+  \param flnm : output file name 
+  \param endianness : Endianness selector  PPS_NATIVE PPS_LITTLE_ENDIAN PPS_BIG_ENDIAN 
+*/ 
 PPFBinaryOutputStream::PPFBinaryOutputStream(string const& flnm, int endianness)
 {