include/Geant4/G4UserRunAction.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UserRunAction
0027 //
0028 // Class description:
0029 //
0030 // This is the base class of a user's action class defining the user's
0031 // action at the begining and the end of each run. The user can override
0032 // the following two methods but should not change any of the contents of
0033 // a G4Run object:
0034 //    virtual void BeginOfRunAction(const G4Run* aRun);
0035 //    virtual void EndOfRunAction(const G4Run* aRun);
0036 // The user can override the following method to instanciate his/her own
0037 // concrete Run class. G4Run has a virtual method RecordEvent(), so that
0038 // one can store any information useful for event statistics:
0039 //    virtual G4Run* GenerateRun();
0040 // The user's concrete class derived from this class must be set to
0041 // G4RunManager via the G4RunManager::SetUserAction() method.
0042
0043 // Original author: M.Asai, 1998
0044 // --------------------------------------------------------------------
0045 #ifndef G4UserRunAction_hh
0046 #define G4UserRunAction_hh 1
0047
0048 #include "G4Types.hh"
0049
0050 class G4Run;
0051
0052 class G4UserRunAction
0053 {
0054   public:
0055     G4UserRunAction();
0056     virtual ~G4UserRunAction() = default;
0057
0058     virtual G4Run* GenerateRun() { return nullptr; }
0059     virtual void BeginOfRunAction(const G4Run* /*aRun*/) {}
0060     virtual void EndOfRunAction(const G4Run* /*aRun*/) {}
0061
0062     inline virtual void SetMaster(G4bool val = true) { isMaster = val; }
0063     inline G4bool IsMaster() const { return isMaster; }
0064
0065   protected:
0066     G4bool isMaster = true;
0067 };
0068
0069 #endif