include/Geant4/G4BOptrForceCollisionTrackData.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 //
0028 // --------------------------------------------------------------------
0029 // GEANT 4 class header file
0030 //
0031 // Class Description:
0032 //    Extends G4Track properties with information needed for the
0033 //    force collision biasing operator.
0034 //    The G4BOptrForceCollision class is made friend of this one in
0035 //    order to keep unexposed to public most of the data members, as
0036 //    they are used to control the logic.
0037 //
0038 // ------------------ G4BOptrForceCollisionTrackData ------------------
0039 //
0040 // Author: M.Verderi (LLR), October 2015
0041 //
0042 // --------------------------------------------------------------------
0043
0044 #ifndef G4BOptrForceCollisionTrackData_hh
0045 #define G4BOptrForceCollisionTrackData_hh
0046
0047 class G4BOptrForceCollision;
0048 #include "G4VAuxiliaryTrackInformation.hh"
0049
0050 enum class ForceCollisionState { free, toBeCloned, toBeForced, toBeFreeFlight };
0051
0052 class G4BOptrForceCollisionTrackData : public G4VAuxiliaryTrackInformation {
0053
0054 friend class G4BOptrForceCollision;
0055
0056 public:
0057   G4BOptrForceCollisionTrackData( const G4BOptrForceCollision* );
0058   ~G4BOptrForceCollisionTrackData();
0059
0060   // -- from base class:
0061   void Print() const;
0062
0063   // -- Get methods:
0064   G4bool                             IsFreeFromBiasing() const
0065   { return ( fForceCollisionState == ForceCollisionState::free);}
0066   // -- no set methods are provided : sets are made under exclusive control of G4BOptrForceCollision objects through friendness.
0067
0068 private:
0069   const G4BOptrForceCollision* fForceCollisionOperator;
0070   ForceCollisionState             fForceCollisionState;
0071
0072   void Reset()
0073   {
0074     fForceCollisionOperator = nullptr;
0075     fForceCollisionState    = ForceCollisionState::free;
0076   }
0077
0078 };
0079
0080 #endif