include/Geant4/G4BaseNtupleManager.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 // The base class for Ntuple managers.
0028 // It implements common functions independent from the output type.
0029 //
0030 // Author: Ivana Hrivnacova, 20/07/2017 (ivana@ipno.in2p3.fr)
0031
0032 #ifndef G4BaseNtupleManager_h
0033 #define G4BaseNtupleManager_h 1
0034
0035 #include "G4VNtupleManager.hh"
0036 #include "globals.hh"
0037
0038 class G4BaseNtupleManager : public G4VNtupleManager
0039 {
0040   public:
0041     explicit G4BaseNtupleManager(const G4AnalysisManagerState& state);
0042     G4BaseNtupleManager() = delete;
0043     ~G4BaseNtupleManager() override = default;
0044
0045     // deleted copy constructor & assignment operator
0046     G4BaseNtupleManager(const G4BaseNtupleManager& rhs) = delete;
0047     G4BaseNtupleManager& operator=(const G4BaseNtupleManager& rhs) =delete;
0048
0049   protected:
0050     // Methods for handling ntuples
0051     G4int CreateNtuple(G4NtupleBooking* booking) override = 0;
0052
0053     // Methods to fill ntuples
0054     // Methods for ntuple with id = FirstNtupleId
0055     G4bool FillNtupleIColumn(G4int id, G4int value) final;
0056     G4bool FillNtupleFColumn(G4int id, G4float value) final;
0057     G4bool FillNtupleDColumn(G4int id, G4double value) final;
0058     G4bool FillNtupleSColumn(G4int id, const G4String& value) final;
0059     G4bool AddNtupleRow() final;
0060
0061     // Methods for ntuple with id > FirstNtupleId (when more ntuples exist)
0062     G4bool FillNtupleIColumn(G4int ntupleId, G4int columnId, G4int value) override = 0;
0063     G4bool FillNtupleFColumn(G4int ntupleId, G4int columnId, G4float value) override = 0;
0064     G4bool FillNtupleDColumn(G4int ntupleId, G4int columnId, G4double value) override = 0;
0065     G4bool FillNtupleSColumn(G4int ntupleId, G4int columnId, const G4String& value) override = 0;
0066     G4bool AddNtupleRow(G4int ntupleId) override = 0;
0067
0068     // Fisrt column id
0069     G4bool SetFirstNtupleColumnId(G4int firstId) final;
0070
0071   protected:
0072     G4int   fFirstNtupleColumnId { 0 };
0073 };
0074
0075 #endif
0076