CVS update of carob/src (ParameterStatement.cpp)

    Date: Wednesday, February 1, 2006 @ 16:49:32
  Author: marc
    Path: /cvsroot/carob/carob/src

Modified: ParameterStatement.cpp (1.19 -> 1.20)

Added better explanation of streamSettings<T>() and oneShotFilter<T>(). 
CAROB-55.


------------------------+
 ParameterStatement.cpp |   11 +++++++++++
 1 files changed, 11 insertions(+)


Index: carob/src/ParameterStatement.cpp
diff -u carob/src/ParameterStatement.cpp:1.19 
carob/src/ParameterStatement.cpp:1.20
--- carob/src/ParameterStatement.cpp:1.19       Wed Feb  1 12:20:19 2006
+++ carob/src/ParameterStatement.cpp    Wed Feb  1 16:49:32 2006
@@ -342,6 +342,17 @@
   // - carefully checking that streamSettings<T1>() does not step on 
streamSettings<T2>() toes
   std::wostringstream buffer;
 
+  // streamSettings<T>() is a function object that will:
+
+  // 1. Modify the default stream settings of 'buffer'
+  // For instance it will set the minimum precision() to avoid
+  // rounding when T is a floating-point type.
+
+  // 2. Return a oneShotFilter<T>() that may transform the value
+  // printed. For instance END_PARAM_TAG will be escaped in value when
+  // T is std::wstring.
+
+  // streamSettings<defaultT>() and oneShotFilter<defaultT>() do nothing.
   buffer << START_PARAM_TAG << typeTag << streamSettings<T>() << value << 
END_PARAM_TAG;
 
   inStrings[paramIndex-1] = buffer.str();