include/Geant4/G4XmlNtupleFileManager.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 // Manager class for ntuple Xml file output.
0028 //
0029 // Author: Ivana Hrivnacova, 15/09/2020 (ivana@ipno.in2p3.fr)
0030
0031 #ifndef G4XmlNtupleFileManager_h
0032 #define G4XmlNtupleFileManager_h 1
0033
0034 #include "G4VNtupleFileManager.hh"
0035 #include "globals.hh"
0036
0037 #include "tools/waxml/ntuple"
0038
0039 #include <memory>
0040 #include <utility>
0041
0042 class G4XmlFileManager;
0043 class G4XmlNtupleManager;
0044
0045 class G4XmlNtupleFileManager : public G4VNtupleFileManager
0046 {
0047   public:
0048     explicit G4XmlNtupleFileManager(const G4AnalysisManagerState& state);
0049     G4XmlNtupleFileManager() = delete;
0050     ~G4XmlNtupleFileManager() override = default;
0051
0052     std::shared_ptr<G4VNtupleManager> CreateNtupleManager() override;
0053
0054     // Methods to be performed at file management
0055     G4bool ActionAtOpenFile(const G4String& fileName) override;
0056     G4bool ActionAtWrite() override;
0057     G4bool ActionAtCloseFile() override;
0058     G4bool Reset() override;
0059
0060     void SetFileManager(std::shared_ptr<G4XmlFileManager> fileManager);
0061
0062     std::shared_ptr<G4XmlNtupleManager> GetNtupleManager() const;
0063
0064   private:
0065     // Static data members
0066     static constexpr std::string_view fkClass { "G4XmlNtupleFileManager" };
0067
0068     // Data members
0069     std::shared_ptr<G4XmlFileManager>  fFileManager { nullptr };
0070     std::shared_ptr<G4XmlNtupleManager>  fNtupleManager { nullptr };
0071 };
0072
0073 // inline functions
0074
0075 inline void G4XmlNtupleFileManager::SetFileManager(
0076   std::shared_ptr<G4XmlFileManager> fileManager)
0077 {
0078   fFileManager = std::move(fileManager);
0079 }
0080
0081 inline std::shared_ptr<G4XmlNtupleManager> G4XmlNtupleFileManager::GetNtupleManager() const
0082 { return fNtupleManager; }
0083
0084 #endif
0085