include/Geant4/G4ITTrackingInteractivity.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 //
0027 // Author: Mathieu Karamitros
0028
0029 // The code is developed in the framework of the ESA AO7146
0030 //
0031 // We would be very happy hearing from you, send us your feedback! :)
0032 //
0033 // In order for Geant4-DNA to be maintained and still open-source,
0034 // article citations are crucial.
0035 // If you use Geant4-DNA chemistry and you publish papers about your software,
0036 // in addition to the general paper on Geant4-DNA:
0037 //
0038 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0039 //
0040 // we would be very happy if you could please also cite the following
0041 // reference papers on chemistry:
0042 //
0043 // J. Comput. Phys. 274 (2014) 841-882
0044 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0045
0046 #ifndef G4ITTRACKINGINTERACTIVITY_HH
0047 #define G4ITTRACKINGINTERACTIVITY_HH
0048
0049 #include "G4String.hh"
0050
0051 class G4Track;
0052 class G4Step;
0053 class G4UserTrackingAction;
0054 class G4UserSteppingAction;
0055 class G4VITSteppingVerbose;
0056
0057 class G4ITTrackingInteractivity
0058 {
0059 protected:
0060   int fVerboseLevel;
0061
0062 public:
0063   G4ITTrackingInteractivity(G4VITSteppingVerbose* verbose = nullptr);
0064
0065   virtual ~G4ITTrackingInteractivity()
0066   {
0067     ;
0068   }
0069
0070   virtual void Initialize()
0071   {
0072     ;
0073   }
0074
0075   virtual void StartTracking(G4Track* /*track*/)
0076   {
0077
0078   }
0079
0080   virtual void AppendStep(G4Track* /*track*/,
0081                           G4Step* /*step*/)
0082   {
0083     ;
0084   }
0085
0086   virtual void EndTracking(G4Track* /*track*/)
0087   {
0088
0089   }
0090
0091   virtual void Finalize()
0092   {
0093     ;
0094   }
0095
0096   virtual void TrackBanner(G4Track* /*track*/,
0097                            const G4String& message = "");
0098
0099   inline void SetVerbose(int flag)
0100   {
0101     fVerboseLevel = flag;
0102   }
0103
0104   inline G4int GetVerboseLevel() const
0105   {
0106     return fVerboseLevel;
0107   }
0108
0109   void SetSteppingVerboseLevel(G4int level);
0110   G4int GetSteppingVerboseLevel() const;
0111
0112   inline G4VITSteppingVerbose* GetSteppingVerbose()
0113   {
0114     return fpVerbose;
0115   }
0116
0117   inline void SetSteppingVerbose(G4VITSteppingVerbose* verbose)
0118   {
0119     fpVerbose = verbose;
0120   }
0121
0122 private:
0123   G4VITSteppingVerbose* fpVerbose;
0124 };
0125
0126 #endif // G4ITTRACKINGINTERACTIVITY_HH