include/Geant4/G4VScoreHistFiller.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 // Class G4VScoreHistFiller
0027 //
0028 // Class description:
0029 //
0030 // Abstract base class that defines functions to fill histogram and
0031 // profile plot. This class avoids the direct dependency to G4Analysis
0032 // category. Template class G4TScoreHistFiller should be used by the
0033 // user to specify the type of the file format.
0034 // This class implements the interface for filling histograms from scorer
0035 // type vith Geant4 analysis tools.
0036 //
0037 // Author: Makoto Asai, September 2020
0038 // --------------------------------------------------------------------
0039 #ifndef G4VScoreHistFiller_h
0040 #define G4VScoreHistFiller_h 1
0041
0042 #include "G4Threading.hh"
0043 #include "globals.hh"
0044
0045 class G4VScoreHistFiller
0046 {
0047  public:
0048   virtual ~G4VScoreHistFiller();
0049
0050   // static method
0051   static G4VScoreHistFiller* Instance();
0052
0053   // methods
0054   virtual void FillH1(G4int id, G4double value, G4double weight = 1.0) = 0;
0055   virtual void FillH2(G4int id, G4double xvalue, G4double yvalue, G4double weight = 1.0) = 0;
0056   virtual void FillH3(
0057     G4int id, G4double xvalue, G4double yvalue, G4double zvalue, G4double weight = 1.0) = 0;
0058   virtual void FillP1(G4int id, G4double xvalue, G4double yvalue, G4double weight = 1.0) = 0;
0059   virtual void FillP2(
0060     G4int id, G4double xvalue, G4double yvalue, G4double zvalue, G4double weight = 1.0) = 0;
0061
0062   virtual G4bool CheckH1(G4int id) = 0;
0063   virtual G4bool CheckH2(G4int id) = 0;
0064   virtual G4bool CheckH3(G4int id) = 0;
0065   virtual G4bool CheckP1(G4int id) = 0;
0066   virtual G4bool CheckP2(G4int id) = 0;
0067
0068  protected:
0069   G4VScoreHistFiller();
0070   virtual G4VScoreHistFiller* CreateInstance() const = 0;
0071
0072   // static data members
0073   static G4VScoreHistFiller* fgMasterInstance;
0074   static G4ThreadLocal G4VScoreHistFiller* fgInstance;
0075 };
0076
0077 #endif