Import Geant4 3.0.0 source tree

source/persistency/events/include/G4PEvent.ddl

@@ -5,14 +5,26 @@
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4PEvent.ddl,v 1.8 1999/11/28 21:54:17 morita Exp $
-// GEANT4 tag $Name: geant4-02-00 $
+// $Id: G4PEvent.ddl,v 1.10 2000/12/05 14:40:02 morita Exp $
+// GEANT4 tag $Name: geant4-03-00 $
+//
+
+// Class Description:
+//
+//      This is a class which represent a persistent event in Geant4.
+//    A persistent event object is constructed by
+//    G4PersistentEventMan::Store() or read back from a database
+//    by G4PersistentEventMan::Retrieve().
+//      G4PersistentEventMan::Store() passes a pointer of a transient
+//    G4Event object.  The G4PEvent object construct itself by copying
+//    the data member of G4Event, and by creating corresponting
+//    persistent objects of primary vertex, particles, hits and digits.
 //
 
 #ifndef G4PEvent_h
 #define G4PEvent_h 1
 
-#include "globals.hh"
+#include "G4Pglobals.hh"
 #include "G4PersistentTypes.hh"
 #include "G4PersistentSchema.hh"
 
@@ -29,16 +41,19 @@ class G4PEvent
   : public HepPersObj
 
 {
-  public:
+  public: // with description
       G4PEvent();
       G4PEvent(const G4Event *evt);
       G4PEvent(const G4Event *evt,
                HepRef(G4PHCofThisEvent) pHC,
                HepRef(G4PDCofThisEvent) pDC);
+      // Constructors.
       void InitPEvent(const G4Event *evt,
                       HepRef(G4PHCofThisEvent) pHC,
                       HepRef(G4PDCofThisEvent) pDC);
+      // Actual constructor to be called by the above.
       ~G4PEvent();
+      // Destructor.
 
   private:
       // event ID
@@ -57,10 +72,11 @@ class G4PEvent
       // TrajectoryContainer (not supported yet)
 //      d_Ref<G4PTrajectoryContainer> trajectoryContainer;
 
-  public:
+  public: // with description
       void SetEventID(const G4Event *evt);
       inline G4int GetEventID() const
       { return eventID; }
+      // Set and get event ID.
 
       inline void AddPrimaryVertex( HepRef(G4PPrimaryVertex) aPrimaryVertex)
       {
@@ -70,9 +86,11 @@ class G4PEvent
         { thePrimaryVertex->SetNext( aPrimaryVertex ); }
         numberOfPrimaryVertex++;
       }
+      // Adds another primary vertex to the vertex chain.
 
       inline G4int GetNumberOfPrimaryVertex() const
       { return numberOfPrimaryVertex; }
+      // Get the number of primary vertecies in the chain.
 
       inline HepRef(G4PPrimaryVertex) GetPrimaryVertex(G4int i=0)  const
       {
@@ -91,16 +109,19 @@ class G4PEvent
         else
         { return NULL; }
       }
+      // returns a smart pointer of the i-th primary vertex.
 
       inline void SetHCofThisEvent( HepRef(G4PHCofThisEvent) value)
       { HC = value; }
       inline HepRef(G4PHCofThisEvent) GetHCofThisEvent()  const
       { return HC; }
+      // Sets and gets a smart pointer of the hits collections of this event.
 
       inline void SetDCofThisEvent( HepRef(G4PDCofThisEvent) value)
       { DC = value; }
       inline HepRef(G4PDCofThisEvent) GetDCofThisEvent()  const
       { return DC; }
+      // Sets and gets a smart pointer of the digits collections of this event.
 
       // inline void SetTrajectoryContainer(G4TrajectoryContainer*value)
       // { trajectoryContainer = value; }
@@ -108,6 +129,8 @@ class G4PEvent
       // { return trajectoryContainer; }
 
       G4Event* MakeTransientObject();
+      // Construct a transient G4Event object from the data members of
+      // G4PEvent.
 
 };