BDSModulator.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 BDSMODULATOR_H
#define BDSMODULATOR_H
 
#include "G4ThreeVector.hh"
#include "G4Types.hh"
 
class BDSModulator
{
public:
  BDSModulator() = default;
  virtual ~BDSModulator() = default;
 
  virtual G4double Factor(const G4ThreeVector& xyz,
                          G4double T) const = 0;
 
  static void SetEventIndex(G4int eventIndexIn);
  
  virtual G4bool VariesWithTime() const = 0;
  
  virtual G4double RecommendedMaxStepLength() const = 0;
  
protected:
  static G4int eventIndex;
};
 
#endif