Import Geant4 1.0.0 source tree

source/event/include/G4UserEventAction.hh

@@ -1,12 +1,12 @@
 // This code implementation is the intellectual property of
-// the RD44 GEANT4 collaboration.
+// the GEANT4 collaboration.
 //
 // By copying, distributing or modifying the Program (or any work
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4UserEventAction.hh,v 1.2 1999/04/09 03:04:00 asaim Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4UserEventAction.hh,v 1.3.4.1 1999/12/07 20:47:52 gunter Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 //
 //
@@ -17,6 +17,19 @@
 class G4EventManager;
 class G4Event;
 
+// class description:
+//
+//  This is the base class of one of the user's optional action classes.
+// The two methods BeginOfEventAction() and EndOfEventAction() are invoked
+// at the beginning and the end of one event processing. These methods are
+// invoked by G4EventManager.
+//  Be aware that BeginOfEventAction() is invoked when a G4Event object is
+// sent to G4EventManager. Thus the primary vertexes/particles have already
+// been made by the primary generator. In case the user wants to do something
+// before generating primaries (i.e., store random number status), do it in
+// the G4VUserPrimaryGeneratorAction concrete class.
+//
+
 class G4UserEventAction 
 {
   public:
@@ -24,8 +37,10 @@ class G4UserEventAction
       virtual ~G4UserEventAction() {;}
       inline void SetEventManager(G4EventManager* value)
       { fpEventManager = value; }
+  public: // with description
       virtual void BeginOfEventAction(const G4Event* anEvent);
       virtual void EndOfEventAction(const G4Event* anEvent);
+      // Two virtual method the user can override.
   protected:
       G4EventManager* fpEventManager;
 };