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