BDSPrimaryGeneratorFile.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSPRIMARYGENERATORFILE_H
#define BDSPRIMARYGENERATORFILE_H
 
#include "G4ThreeVector.hh"
#include "G4Types.hh"
#include "G4VPrimaryGenerator.hh"
 
class BDSBunch;
class BDSBunchEventGenerator;
class G4Event;
class G4VSolid;
 
namespace GMAD
{
  class Beam;
}
 
class BDSPrimaryGeneratorFile: public G4VPrimaryGenerator
{
public:
  BDSPrimaryGeneratorFile() = delete;
  BDSPrimaryGeneratorFile(G4bool loopFileIn,
                          BDSBunchEventGenerator* bunchIn);
  virtual ~BDSPrimaryGeneratorFile();
  
  static BDSPrimaryGeneratorFile* ConstructGenerator(const GMAD::Beam& beam,
                                                     BDSBunch* bunchIn,
                                                     G4bool recreate,
                                                     G4int eventOffset,
                                                     G4bool batchMode);
 
  G4bool GeneratePrimaryVertexSafe(G4Event* event);
 
  virtual void RecreateAdvanceToEvent(G4int eventOffset) = 0;
  
  G4long NEventsInFile() const {return nEventsInFile;}
  
  G4long NEventsLeftInFile() const;
 
  G4bool OKToLoopFile() const;
  
  G4long NEventsReadThatPassedFilters() const {return nEventsReadThatPassedFilters;}
 
  G4long NEventsSkipped() const {return nEventsSkipped;}
  
  G4bool DistributionIsFinished() const {return endOfFileReached;}
  
  void ThrowExceptionIfRecreateOffsetTooHigh(G4long eventOffset) const;
 
protected:
  G4bool VertexInsideWorld(const G4ThreeVector& pos) const;
 
  G4bool loopFile;
  BDSBunchEventGenerator* bunch;
  G4bool endOfFileReached;
  G4bool vertexGeneratedSuccessfully;
  G4long currentFileEventIndex;
  G4long nEventsInFile;
  G4long nEventsReadThatPassedFilters;
  G4long nEventsSkipped;
  mutable G4VSolid* worldSolid;
};
 
#endif