include/Geant4/G4VNtupleManager.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 pure abstract base class for Ntuple manager.
0028 // It defines functions independent from the output type.
0029 //
0030 // Author: Ivana Hrivnacova, 18/06/2013  (ivana@ipno.in2p3.fr)
0031
0032 #ifndef G4VNtupleManager_h
0033 #define G4VNtupleManager_h 1
0034
0035 #include "G4BaseAnalysisManager.hh"
0036 #include "globals.hh"
0037
0038 #include <vector>
0039
0040 struct G4NtupleBooking;
0041
0042 class G4VNtupleManager : public G4BaseAnalysisManager
0043 {
0044   // Disable using the object managers outside G4VAnalysisManager and
0045   // its messenger
0046   friend class G4VAnalysisManager;
0047
0048   public:
0049     explicit G4VNtupleManager(const G4AnalysisManagerState& state)
0050       : G4BaseAnalysisManager(state) {}
0051     G4VNtupleManager() = delete;
0052     ~G4VNtupleManager() override = default;
0053
0054     // deleted copy constructor & assignment operator
0055     G4VNtupleManager(const G4VNtupleManager& rhs) = delete;
0056     G4VNtupleManager& operator=(const G4VNtupleManager& rhs) = delete;
0057
0058   protected:
0059     // Methods for handling ntuples
0060     virtual G4int CreateNtuple(G4NtupleBooking* booking) = 0;
0061
0062     // Methods to fill ntuples
0063     // Methods for ntuple with id = FirstNtupleId
0064     virtual G4bool FillNtupleIColumn(G4int id, G4int value) = 0;
0065     virtual G4bool FillNtupleFColumn(G4int id, G4float value) = 0;
0066     virtual G4bool FillNtupleDColumn(G4int id, G4double value) = 0;
0067     virtual G4bool FillNtupleSColumn(G4int id, const G4String& value) = 0;
0068     virtual G4bool AddNtupleRow() = 0;
0069
0070     // Methods for ntuple with id > FirstNtupleId (when more ntuples exist)
0071     virtual G4bool FillNtupleIColumn(G4int ntupleId, G4int columnId, G4int value) = 0;
0072     virtual G4bool FillNtupleFColumn(G4int ntupleId, G4int columnId, G4float value) = 0;
0073     virtual G4bool FillNtupleDColumn(G4int ntupleId, G4int columnId, G4double value) = 0;
0074     virtual G4bool FillNtupleSColumn(G4int ntupleId, G4int columnId,
0075                                      const G4String& value) = 0;
0076     virtual G4bool AddNtupleRow(G4int ntupleId) = 0;
0077
0078     // Activation option
0079     virtual void  SetActivation(G4bool activation) = 0;
0080     virtual void  SetActivation(G4int id, G4bool activation) = 0;
0081     virtual G4bool  GetActivation(G4int id) const = 0;
0082
0083     // New cycle option
0084     virtual void SetNewCycle(G4bool value) = 0;
0085     virtual G4bool GetNewCycle() const = 0;
0086
0087     // Set first column Id
0088     virtual G4bool SetFirstNtupleColumnId(G4int firstId) = 0;
0089
0090     // Clear all date
0091     virtual void Clear() = 0;
0092
0093     // Methods to delete selected ntuples
0094     virtual G4bool Delete(G4int id) = 0;
0095 };
0096
0097 #endif