include/Geant4/G4VPrimaryGenerator.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 // G4VPrimaryGenerator
0027 //
0028 // Class description:
0029 //
0030 // This is an abstract base class of all of primary generators.
0031 // This class has only one pure virtual method GeneratePrimaryVertex()
0032 // which takes a G4Event object and generates a primay vertex and
0033 // primary particles associate to the vertex
0034
0035 // Author: Makoto Asai (SLAC)
0036 // --------------------------------------------------------------------
0037 #ifndef G4VPrimaryGenerator_hh
0038 #define G4VPrimaryGenerator_hh 1
0039
0040 #include "G4ThreeVector.hh"
0041
0042 class G4Event;
0043
0044 class G4VPrimaryGenerator
0045 {
0046   public:
0047
0048     G4VPrimaryGenerator() = default;
0049     virtual ~G4VPrimaryGenerator() = default;
0050       // Constructor and destructor
0051
0052     static G4bool CheckVertexInsideWorld(const G4ThreeVector& pos);
0053       // Static service method for checking a point is included
0054       // in the (current) world
0055
0056     virtual void GeneratePrimaryVertex(G4Event* evt) = 0;
0057       // Pure virtual method which a concrete class derived from this
0058       // base class must implement
0059
0060     inline G4ThreeVector GetParticlePosition() { return particle_position; }
0061     inline G4double GetParticleTime() { return particle_time; }
0062
0063     inline void SetParticlePosition(G4ThreeVector aPosition)
0064       { particle_position = aPosition; }
0065     inline void SetParticleTime(G4double aTime)
0066       { particle_time = aTime; }
0067
0068   protected:
0069
0070     G4ThreeVector particle_position;
0071     G4double particle_time = 0.0;
0072 };
0073
0074 #endif