include/Geant4/G4INCLIAvatar.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 // INCL++ intra-nuclear cascade model
0027 // Alain Boudard, CEA-Saclay, France
0028 // Joseph Cugnon, University of Liege, Belgium
0029 // Jean-Christophe David, CEA-Saclay, France
0030 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
0031 // Sylvie Leray, CEA-Saclay, France
0032 // Davide Mancusi, CEA-Saclay, France
0033 //
0034 #define INCLXX_IN_GEANT4_MODE 1
0035
0036 #include "globals.hh"
0037
0038 /*
0039  * IAvatar.hh
0040  *
0041  *  \date 4 June 2009
0042  * \author Pekka Kaitaniemi
0043  */
0044
0045 #ifndef IAVATAR_HH_
0046 #define IAVATAR_HH_
0047
0048 #include "G4INCLIChannel.hh"
0049 #include "G4INCLParticle.hh"
0050 #include "G4INCLFinalState.hh"
0051 #include "G4INCLUnorderedVector.hh"
0052 #include "G4INCLAllocationPool.hh"
0053 #include <string>
0054
0055 #if !defined(NDEBUG) && !defined(INCLXX_IN_GEANT4_MODE)
0056 // Force instantiation of all the std::vector<IAvatar*> methods for debugging
0057 // purposes
0058 namespace G4INCL {
0059   class IAvatar;
0060 }
0061 template class std::vector<G4INCL::IAvatar*>;
0062 #endif
0063
0064 namespace G4INCL {
0065
0066   enum AvatarType {SurfaceAvatarType,
0067            CollisionAvatarType,
0068            DecayAvatarType,
0069            ParticleEntryAvatarType,
0070                    UnknownAvatarType};
0071
0072   class IAvatar {
0073   public:
0074     IAvatar();
0075     IAvatar(G4double time);
0076     virtual ~IAvatar();
0077
0078     virtual G4INCL::IChannel* getChannel() = 0;
0079     FinalState *getFinalState();
0080     void fillFinalState(FinalState *fs);
0081     virtual void preInteraction() = 0;
0082     virtual void postInteraction(FinalState *) = 0;
0083
0084     G4double getTime() const { return theTime; };
0085
0086     virtual ParticleList getParticles() const = 0;
0087
0088     virtual std::string dump() const = 0;
0089
0090     AvatarType getType() const { return type; };
0091     G4bool isACollision() const { return (type==CollisionAvatarType); };
0092     G4bool isADecay() const { return (type==DecayAvatarType); };
0093     void setType(AvatarType t) { type = t; };
0094     long getID() const { return ID; };
0095
0096     std::string toString();
0097   private:
0098     long ID;
0099     AvatarType type;
0100     static G4ThreadLocal long nextID;
0101   protected:
0102     G4double theTime;
0103
0104     INCL_DECLARE_ALLOCATION_POOL(IAvatar)
0105   };
0106
0107   typedef UnorderedVector<IAvatar*> IAvatarList;
0108   typedef UnorderedVector<IAvatar*>::const_iterator IAvatarIter;
0109   typedef UnorderedVector<IAvatar*>::iterator IAvatarMutableIter;
0110
0111 }
0112
0113 #endif /* IAVATAR_HH_ */