Geant4  10.00.p02
G4Run.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4Run.hh 68798 2013-04-05 13:28:19Z gcosmo $
28 //
29 
30 #ifndef G4Run_h
31 #define G4Run_h 1
32 
33 #include "globals.hh"
34 #include <vector>
35 class G4Event;
36 class G4HCtable;
37 class G4DCtable;
38 
39 // class description:
40 //
41 // This class represents a run. An object of this class is constructed
42 // and deleted by G4RunManager. Basically the user should use only the
43 // get methods. All properties are set by G4RunManager.
44 //
45 
46 class G4Run
47 {
48  public:
49  G4Run();
50  virtual ~G4Run();
51 
52  private:
53  // These copy constructor and = operator must not be used.
54  G4Run(const G4Run &) {;}
55  G4Run& operator=(const G4Run &) { return *this; }
56 
57  protected:
64  std::vector<const G4Event*>* eventVector;
65 
66  public: // with description
67  virtual void RecordEvent(const G4Event*);
68  // Method to be overwritten by the user for recording events in this run.
69  // In such a case, it is the user's responsibility to increment numberOfEvent.
70  // Also, user's run class object must be instantiated in user's runAction.
71  virtual void Merge(const G4Run*);
72  // Method to be overwritten by the user for merging local G4Run object to
73  // the global G4Run object.
74 
75  public: // with description
76  inline G4int GetRunID() const
77  { return runID; }
78  // Returns the run ID. Run ID is set by G4RunManager.
79  inline G4int GetNumberOfEvent() const
80  { return numberOfEvent; }
81  // Returns number of events processed in this run. The number is
82  // incremented at the end of each event processing.
84  { return numberOfEventToBeProcessed; }
85  inline const G4HCtable* GetHCtable() const
86  { return HCtable; }
87  // List of names of hits collection
88  inline const G4DCtable* GetDCtable() const
89  { return DCtable; }
90  // List of names of digi collection
91  inline const G4String& GetRandomNumberStatus() const
92  { return randomNumberStatus; }
93  // Return random number status at the beginning of this run
94  public:
95  inline void SetRunID(G4int id)
96  { runID = id; }
98  { numberOfEventToBeProcessed = n_ev; }
99  inline void SetHCtable(G4HCtable* HCtbl)
100  { HCtable = HCtbl; }
101  inline void SetDCtable(G4DCtable* DCtbl)
102  { DCtable = DCtbl; }
104  { randomNumberStatus = st; }
105 
106  public: // with description
107  void StoreEvent(G4Event* evt);
108  // Store a G4Event object until this run object is deleted.
109  // Given the potential large memory size of G4Event and its datamember
110  // objects stored in G4Event, the user must be careful and responsible for
111  // not to store too many G4Event objects. This method is invoked by G4RunManager
112  // if the user invokes G4EventManager::KeepTheCurrentEvent() or
113  // /event/keepCurrentEvent UI command while the particular event is in process
114  // (typically in EndOfEventAction).
115  inline const std::vector<const G4Event*>* GetEventVector() const
116  { return eventVector; }
117  // Return the event vector
118 };
119 
120 
121 #endif
122 
std::vector< const G4Event * > * eventVector
Definition: G4Run.hh:64
void SetNumberOfEventToBeProcessed(G4int n_ev)
Definition: G4Run.hh:97
G4DCtable * DCtable
Definition: G4Run.hh:62
void SetDCtable(G4DCtable *DCtbl)
Definition: G4Run.hh:101
virtual void Merge(const G4Run *)
Definition: G4Run.cc:54
G4int numberOfEvent
Definition: G4Run.hh:59
G4Run(const G4Run &)
Definition: G4Run.hh:54
G4HCtable * HCtable
Definition: G4Run.hh:61
const std::vector< const G4Event * > * GetEventVector() const
Definition: G4Run.hh:115
virtual ~G4Run()
Definition: G4Run.cc:38
const G4DCtable * GetDCtable() const
Definition: G4Run.hh:88
int G4int
Definition: G4Types.hh:78
G4int runID
Definition: G4Run.hh:58
G4Run()
Definition: G4Run.cc:34
G4int GetNumberOfEvent() const
Definition: G4Run.hh:79
G4int GetRunID() const
Definition: G4Run.hh:76
Definition: G4Run.hh:46
G4Run & operator=(const G4Run &)
Definition: G4Run.hh:55
void SetHCtable(G4HCtable *HCtbl)
Definition: G4Run.hh:99
const G4HCtable * GetHCtable() const
Definition: G4Run.hh:85
G4String randomNumberStatus
Definition: G4Run.hh:63
void StoreEvent(G4Event *evt)
Definition: G4Run.cc:62
virtual void RecordEvent(const G4Event *)
Definition: G4Run.cc:51
G4int GetNumberOfEventToBeProcessed() const
Definition: G4Run.hh:83
const G4String & GetRandomNumberStatus() const
Definition: G4Run.hh:91
void SetRunID(G4int id)
Definition: G4Run.hh:95
void SetRandomNumberStatus(G4String &st)
Definition: G4Run.hh:103
G4int numberOfEventToBeProcessed
Definition: G4Run.hh:60