Changeset 10657 for trunk/FACT++/src/DimErrorRedirecter.cc

Timestamp:

05/11/11 10:27:33 (14 years ago)

Author:

tbretz

Message:

Added or improved documentation.

File:

• trunk/FACT++/src/DimErrorRedirecter.cc (modified) (3 diffs)

trunk/FACT++/src/DimErrorRedirecter.cc

@@ -1 +1 @@
 // **************************************************************************
 /** @class DimErrorRedirecter
+
+@brief A base class taking care of padding, exit handler and error handlers
+
+This class first switches off padding for the DimServer and the DimClient
+(dis and dic). Furthermore, it redirects both error handlers to the
+DimErrorRedirecter. Redirect the exit handler.
+
+Only one instance of this class is allowed, since all Dim handlers are
+global.
+
+In the destructor of the class the handlers are correctly restored.
+The padding setup is kept.
+
+For FACT++ all Dim data is transmitted without padding!
+
+To catch the error messages overwrite the errorHandler. The errorHandler
+of the DimErrorRedirecter redirects the error messages to the logging
+stream given in the constructor.
+
+To catch the exit requests overwrite the exitHandler.
 
 */
@@ -15 +35 @@
 int DimErrorRedirecter::cnt = 0;
 
+// --------------------------------------------------------------------------
+//
+//! - disable padding for dim server and dim client
+//! - redirect DimClient error handler
+//! - redirect DimServer error handler
+//! - set exit handler of DimServer
+//
 DimErrorRedirecter::DimErrorRedirecter(MessageImp &imp) : fMsg(imp)
 {
@@ -31 +58 @@
 }
 
+// --------------------------------------------------------------------------
+//
+//! - reset DimClient error handler
+//! - reset DimServer error handler
+//! - reset exit handler of DimServer
+//
 DimErrorRedirecter::~DimErrorRedirecter()
 {