Changeset 961 for trunk/MagicSoft/Mars/mbase/MClone.cc

Timestamp:

10/05/01 14:39:20 (23 years ago)

Author:

tbretz

Message:

*** empty log message ***

File:

• trunk/MagicSoft/Mars/mbase/MClone.cc (modified) (6 diffs)

trunk/MagicSoft/Mars/mbase/MClone.cc

@@ -25 +25 @@
 //////////////////////////////////////////////////////////////////////////////
 //                                                                          //
+//  MClone                                                                  //
+//                                                                          //
+//  This task clones a given paramter container. You can either specify     //
+//  the name of the container which should be cloned or a pointer to the    //
+//  container. If you specify a name the preprocessing tries to find the    //
+//  corresponding container in the parameter list.                          //
+//  Cloning in this context means duplicating the object in memory. This    //
+//  may be used if you change an object in the eventloop (eg. the image     //
+//  cleaning is changing the image) and you want to compare both 'version'  //
+//  of this object afterwards.                                              //
+//  The cloned object can be accessed by using MClone::GetClone.            //
+//  To clone the container more than once use several instances of MClone.  //
+//  The object does only exist until a new object is cloned. It is deleted  //
+//  in the destructor.                                                      //
+//                                                                          //
+//  Input Containers:                                                       //
+//   MParContainer                                                          //
+//                                                                          //
+//  Output Containers:                                                      //
+//   -/-                                                                    //
 //                                                                          //
 //////////////////////////////////////////////////////////////////////////////
@@ -52 +72 @@
 // --------------------------------------------------------------------------
 //
-// Constructor.
+//  Constructor. Remembers the name to search for in the parameter list.
 //
 MClone::MClone(const char *par, const char *name, const char *title)
@@ -63 +83 @@
 // --------------------------------------------------------------------------
 //
-// Constructor.
+//  Constructor. Remember the pointer of the object which has to be cloned.
 //
 MClone::MClone(const MParContainer *par, const char *name, const char *title)
@@ -74 +94 @@
 // --------------------------------------------------------------------------
 //
-// Destructor.
+//  Destructor. Deletes the cloned object.
 //
 MClone::~MClone()
@@ -83 +103 @@
 // --------------------------------------------------------------------------
 //
-// Checks the parameter list for the existance of the parameter container. If
-// the name of it was given in the constructor. It checks also for the
-// existance of the histogram container in the parameter list if a name was
-// given. If it is not available it tried to create a histogram container
-// with the same type as the given object name.
+//  Checks the parameter list for the existance of the parameter container. If
+//  the name of it was given in the constructor.
 //
 Bool_t MClone::PreProcess(MParList *pList)
 {
-    if (!fParContainer)
-    {
-        fParContainer = (MParContainer*)pList->FindObject(fParContainerName);
-        if (!fParContainer)
-        {
-            *fLog << dbginf << fParContainerName << " not found... aborting." << endl;
-            return kFALSE;
-        }
-    }
-    return kTRUE;
+    //
+    // The pointer is already given by the user.
+    //
+    if (fParContainer)
+        return kTRUE;
+
+    //
+    // Try to find the parameter container with the given name in the list
+    //
+    fParContainer = (MParContainer*)pList->FindObject(fParContainerName);
+    if (fParContainer)
+        return kTRUE;
+
+    //
+    // If it couldn't get found stop Eventloop
+    //
+    *fLog << dbginf << fParContainerName << " not found... aborting." << endl;
+    return kFALSE;
 }
 
+// --------------------------------------------------------------------------
+//
+//  Delete the cloned object if one is existing
+//
 void MClone::Clear(Option_t *)
 {
+    //
+    // Check if an object has been initialized
+    //
     if (!fClone)
         return;
 
+    //
+    // Delete it and set the pointer to NULL for the sanity check (above)
+    //
     delete fClone;
     fClone = NULL;
@@ -114 +149 @@
 // --------------------------------------------------------------------------
 //
-// Fills the data from the parameter conatiner into the histogram container
+//  Deletes an existing clone and clones the object (parameter container)
+//  again.
 //
 Bool_t MClone::Process()
 {
+    //
+    // Delete an existing clone
+    //
     Clear();
 
+    //
+    // Clone the given parameter container
+    //
     fClone = fParContainer->Clone();