include/Geant4/G4VSamplerConfigurator.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 // Class G4VSamplerConfigurator
0030 //
0031 // Class description:
0032 //
0033 // This is an interface for configurators setting up processes
0034 // needed for importance sampling and scoring.
0035 // The Configurator may be given a pointer to another Configurator.
0036 // If a configurator will be given a pointer to another configurator
0037 // it may obtain a G4VTrackTerminator from the given Configurator.
0038 // This way it is possible to delegate the killing of a track.
0039
0040 // Author: Michael Dressel (Michael.Dressel@cern.ch)
0041 // ----------------------------------------------------------------------
0042 #ifndef G4VSamplerConfigurator_hh
0043 #define G4VSamplerConfigurator_hh G4VSamplerConfigurator_hh
0044
0045 #include "G4Types.hh"
0046 #include <vector>
0047
0048 class G4VTrackTerminator;
0049
0050 class G4VSamplerConfigurator
0051 {
0052
0053 public:  // with description
0054
0055   G4VSamplerConfigurator();
0056   virtual ~G4VSamplerConfigurator();
0057
0058   virtual void Configure(G4VSamplerConfigurator *preConf) = 0;
0059     // Do the configuration, if preConf is given a
0060     // G4VTrackTerminator may be obtained from it.
0061
0062   virtual const G4VTrackTerminator *GetTrackTerminator() const = 0;
0063     // Return a G4VTrackTerminator or 0.
0064 };
0065
0066 typedef std::vector<G4VSamplerConfigurator *> G4Configurators;
0067
0068 #endif