BDSLinkBunch.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
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 BDSLINKBUNCH_H
#define BDSLINKBUNCH_H
 
#include "BDSBunch.hh"
#include "BDSParticleExternal.hh"
 
#include <vector>
 
class BDSParticleCoordsFull;
class BDSParticleDefinition;
 
class BDSLinkBunch: public BDSBunch
{
public: 
  BDSLinkBunch();
  virtual ~BDSLinkBunch();
 
  virtual BDSParticleCoordsFull GetNextParticleLocal();
 
  void AddParticle(BDSParticleDefinition* particleDefinitionIn,
                   const BDSParticleCoordsFull& coordsIn,
                   int   externalParticleID,
                   int   externalParentID);
 
  void ClearParticles();
 
  inline size_t Size() const {return particles.size();}
  inline int    CurrentExternalParticleID() const {return currentExternalParticleID;}
  inline int    CurrentExternalParentID()   const {return currentExternalParentID;}
 
  inline const BDSParticleCoordsFull ParticleLocal()  {return particles[currentIndex]->coords;}
  inline virtual const BDSParticleDefinition* ParticleDefinition() const {return currentParticleDefinition;}
  void SetCurrentIndex(size_t iIndex)
    {// size_t is unsigned so any negative number will always be cast to positive
      if (iIndex < particles.size())
        {currentIndex = iIndex;}
    }
  void Reset() {currentIndex = 0;}
 
  void UpdateGeant4ParticleDefinition(G4int pdgID);
 
  virtual void UpdateIonDefinition();
  
private:
  G4int currentIndex;
  G4int currentExternalParticleID;
  G4int currentExternalParentID;
  BDSParticleDefinition* currentParticleDefinition;
 
  G4int size;         
  std::vector<BDSParticleExternal*> particles;
};
#endif