Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/analysis/xml/include/G4XmlFileManager.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 
 27 // The manager for Xml file output operations.
 28 
 29 // Author: Ivana Hrivnacova, 18/06/2013  (ivana@ipno.in2p3.fr)
 30 
 31 #ifndef G4XmlFileManager_h
 32 #define G4XmlFileManager_h 1
 33 
 34 #include "G4VTFileManager.hh"
 35 #include "G4TNtupleDescription.hh"
 36 #include "G4TFileManager.hh"
 37 #include "globals.hh"
 38 
 39 #include "tools/waxml/ntuple"
 40 
 41 #include <fstream>
 42 #include <memory>
 43 #include <string_view>
 44 
 45 // Type aliases
 46 using XmlNtupleDescription = G4TNtupleDescription<tools::waxml::ntuple, std::ofstream>;
 47 
 48 class G4AnalysisManagerState;
 49 
 50 class G4XmlFileManager : public G4VTFileManager<std::ofstream>
 51 {
 52   public:
 53     explicit G4XmlFileManager(const G4AnalysisManagerState& state);
 54     G4XmlFileManager() = delete;
 55     ~G4XmlFileManager() override = default;
 56 
 57     using G4BaseFileManager::GetNtupleFileName;
 58     using G4VTFileManager<std::ofstream>::WriteFile;
 59     using G4VTFileManager<std::ofstream>::CloseFile;
 60 
 61     // Methods to manipulate output files
 62     G4bool OpenFile(const G4String& fileName) final;
 63 
 64     G4String GetFileType() const final { return "xml"; }
 65 
 66     // Specific methods for files per objects
 67     G4bool CreateNtupleFile(XmlNtupleDescription* ntupleDescription);
 68     G4bool CloseNtupleFile(XmlNtupleDescription* ntupleDescription);
 69 
 70   protected:
 71     // Methods derived from templated base class
 72     std::shared_ptr<std::ofstream> CreateFileImpl(const G4String& fileName) final;
 73     G4bool WriteFileImpl(std::shared_ptr<std::ofstream> file) final;
 74     G4bool CloseFileImpl(std::shared_ptr<std::ofstream> file) final;
 75 
 76   private:
 77     // Utility method
 78     G4String GetNtupleFileName(XmlNtupleDescription* ntupleDescription);
 79 
 80     // Static data members
 81     static constexpr std::string_view fkClass { "G4XmlFileManager" };
 82 };
 83 
 84 #endif
 85