include/Geant4/G4VUserPrimaryGeneratorAction.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 // G4VUserPrimaryGeneratorAction
0027 //
0028 // Class description:
0029 //
0030 // Abstract base class for user's mandatory action class for primary
0031 // vertex/particle generation. This class has only one pure virtual
0032 // method GeneratePrimaries() which is invoked from G4RunManager
0033 // during the event loop.
0034 // This class is NOT intended for generating primary vertex/particle
0035 // by itself. This class should:
0036 // - have one or more G4VPrimaryGenerator concrete classes such as G4ParticleGun
0037 // - set/change properties of generator(s)
0038 // - pass G4Event object so that the generator(s) can generate primaries.
0039
0040 // Original author: M.Asai, 1999
0041 // --------------------------------------------------------------------
0042 #ifndef G4VUserPrimaryGeneratorAction_hh
0043 #define G4VUserPrimaryGeneratorAction_hh 1
0044
0045 class G4Event;
0046
0047 class G4VUserPrimaryGeneratorAction
0048 {
0049   public:
0050     G4VUserPrimaryGeneratorAction();
0051     virtual ~G4VUserPrimaryGeneratorAction() = default;
0052
0053     virtual void GeneratePrimaries(G4Event* anEvent) = 0;
0054 };
0055
0056 #endif