include/Geant4/G4VGlobalFastSimulationManager.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 // G4VGlobalFastSimulationManager
0027 //
0028 // Class description:
0029 //
0030 // Abstract interface for Global Fast Simulation Manager
0031 // G4GlobalFastSimulationManager is a "Singleton".
0032 // This class is an abstract interface for G4GlobalFastSimulationManager.
0033 // It has the public access function GetConcreteInstance(), which is used
0034 // to obtain a pointer to the concrete G4GlobalFastSimulationManager, should
0035 // it exist. Then:
0036 //
0037 // G4VGlobalFastSimulationManager* pVFSMan =
0038 //     G4VGlobalFastSimulationManager::GetConcreteInstance ();
0039 //
0040 // 'pVFSMan' points to the real (concrete) G4GlobalFastSimulationManager if
0041 // at least a parameterisation envelope exists, otherwise is null.
0042 //
0043 // Thus all code must be protected, for example by:
0044 //  if (pVFSMan)
0045 //    G4FlavoredParallelWorld* = pVFSMan -> GetFlavoredWorldForThis(p);
0046
0047 // Authors: P. Mora de Freitas & M. Verderi, 14 April 1999
0048 // --------------------------------------------------------------------
0049 #ifndef G4VGLOBALFASTSIMULATIONMANAGER_HH
0050 #define G4VGLOBALFASTSIMULATIONMANAGER_HH 1
0051
0052 #include "G4Types.hh"
0053
0054 #include "icomsdefs.hh"
0055
0056 class G4VFlavoredParallelWorld;
0057 class G4ParticleDefinition;
0058
0059 class G4VGlobalFastSimulationManager
0060 {
0061   public:
0062     // Returns pointer to the actual Global Fast Simulation manager if
0063     // at least a parameterisation envelope exists
0064     static G4VGlobalFastSimulationManager* GetConcreteInstance();
0065
0066     virtual ~G4VGlobalFastSimulationManager() = default;
0067
0068     // VGlobalFastSimulationManager interface for visualisation
0069     virtual G4VFlavoredParallelWorld* GetFlavoredWorldForThis(G4ParticleDefinition*) = 0;
0070
0071   protected:
0072     // Sets the pointer to the actual Global Fast Simulation manager
0073     static void SetConcreteInstance(G4VGlobalFastSimulationManager*);
0074
0075     // Pointer to real G4GlobalFastSimulationManager
0076     G4ICOMS_DLL
0077     static G4ThreadLocal G4VGlobalFastSimulationManager* fpConcreteInstance;
0078 };
0079
0080 #endif