BDSBunchFileBased.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 BDSBUNCHFILEBASED_H
#define BDSBUNCHFILEBASED_H 
 
#include "BDSBunch.hh"
 
#include "G4String.hh"
 
class BDSBunchFileBased: public BDSBunch
{
public: 
  explicit BDSBunchFileBased(const G4String& distributionName);
  virtual ~BDSBunchFileBased(); 
  BDSBunchFileBased& operator=(const BDSBunchFileBased&) = delete;
  BDSBunchFileBased(BDSBunchFileBased&) = delete;
 
  virtual void BeginOfRunAction(G4int numberOfEvents,
                                G4bool batchMode);
 
  unsigned long long int NOriginalEvents() const {return nOriginalEvents;}
  unsigned long long int NEventsInFile() const {return nEventsInFile;}
  unsigned long long int NEventsInFileSkipped() const {return nEventsInFileSkipped;}
  G4int DistrFileLoopNTimes() const {return distrFileLoopNTimes;}
 
  void SetNEventsInFile(unsigned long long int nEventsInFileIn) {nEventsInFile = nEventsInFileIn;}
  void SetNOriginalEvents(unsigned long long int nOriginalEventsIn) {nOriginalEvents = nOriginalEventsIn;}
 
  void IncrementNEventsInFileSkipped() {nEventsInFileSkipped += 1;}
  void IncrementNEventsInFileSkipped(unsigned long long int plus) {nEventsInFileSkipped += plus;}
 
  virtual void SetOptions(const BDSParticleDefinition* beamParticle,
                          const GMAD::Beam& beam,
                          const BDSBunchType& distrType,
                          G4Transform3D beamlineTransformIn = G4Transform3D::Identity,
                          const G4double beamlineS = 0);
  
protected:
  unsigned long long int nOriginalEvents; 
  unsigned long long int nEventsInFile;   
  unsigned long long int nEventsInFileSkipped; 
  G4bool distrFileLoop;
  G4int distrFileLoopNTimes;
};
 
#endif