Import Geant4 3.0.0 source tree

source/persistency/digits+hits/digits/include/G4PersistentDigitMan.hh

@@ -5,10 +5,11 @@
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4PersistentDigitMan.hh,v 1.6 1999/11/29 20:11:16 morita Exp $
-// GEANT4 tag $Name: geant4-02-00 $
+// $Id: G4PersistentDigitMan.hh,v 1.7 2000/12/15 08:04:13 morita Exp $
+// GEANT4 tag $Name: geant4-03-00 $
 //
-// class G4PersistentDigitMan 
+
+// Class Description:
 //
 // A Class responsible for registring DigitsCollection
 // during event tracking.
@@ -18,6 +19,7 @@
 //
 // This class itself is not persistent-capable. 
 //
+
 // Member functions:
 // =================
 //  static G4PersistentDigitMan* GetPersistentDigitMan();
@@ -48,10 +50,13 @@
 class G4PersistentDigitMan 
  : public G4VPersistentSubMan, public G4VPersistentSubDbMan
 {
-  public:
+  public: // with description
       static G4PersistentDigitMan* GetPersistentDigitMan();
+      // returns a pointer to singleton instance of this class.
       static G4PersistentDigitMan* get_PersistentDigitManIfExist();
+      // returns a pointer to singleton instance of this class.
 
+  public:
       G4PersistentDigitMan();
       ~G4PersistentDigitMan();
 
@@ -59,11 +64,16 @@ class G4PersistentDigitMan
       static G4PersistentDigitMan * f_PersistentDigitMan;
       HepRef(G4PDCofThisEvent) f_CurrentPDCofThisEvent;
 
-  public:
+  public: // with description
       inline void SetCurrentPDCofThisEvent( HepRef(G4PDCofThisEvent) aPDC)
       { f_CurrentPDCofThisEvent = aPDC; };
+      // sets a smart pointer of the collection of digits collections
+      // of this event.  This method should be invoked by user
+      // sensitive detector only once per event.
       inline HepRef(G4PDCofThisEvent) GetCurrentPDCofThisEvent()
       { return f_CurrentPDCofThisEvent; };
+      // returns a smart pointer of the collection of digits collections
+      // of this event.
 
 };