Geant4-11
G4CsvNtupleManager.cc
Go to the documentation of this file.
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// Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
28
29#include "G4CsvNtupleManager.hh"
30#include "G4CsvFileManager.hh"
33
34using namespace G4Analysis;
35
36//
37// utility methods
38//
39
40//_____________________________________________________________________________
42 : G4TNtupleManager<tools::wcsv::ntuple, std::ofstream>(state)
43{}
44
45//
46// private methods
47//
48
49//_____________________________________________________________________________
51 CsvNtupleDescription* ntupleDescription)
52{
53 // create a file for this ntuple
54 if ( ! fFileManager->CreateNtupleFile(ntupleDescription) ) return;
55
56 // create ntuple
57 ntupleDescription->fNtuple
58 = new tools::wcsv::ntuple(
59 *(ntupleDescription->fFile), G4cerr, ntupleDescription->fNtupleBooking);
60 fNtupleVector.push_back(ntupleDescription->fNtuple);
61 }
62
63//_____________________________________________________________________________
65 CsvNtupleDescription* ntupleDescription,
66 G4bool /*fromBooking*/)
67{
68
69 // Do nothing if the base file name was not yet defined
70 if ( ! fFileManager->GetFileName().size() ) return;
71
72 // Create ntuple from booking
73 if ( ! ntupleDescription->fNtuple ) {
74 CreateTNtupleFromBooking(ntupleDescription);
75 }
76
77 // Return if creating ntuple failed
78 if ( ! ntupleDescription->fNtuple ) {
79 Warn("Creating ntuple has failed.", fkClass, "FinishTNtuple");
80 return;
81 }
82
83
84 // Write header if ntuple already exists
85 if ( ! WriteHeader(ntupleDescription->fNtuple) ) {
86 Warn("Writing ntuple header has failed.", fkClass, "FinishTNtuple");
87 }
88}
89
90//_____________________________________________________________________________
91G4bool G4CsvNtupleManager::WriteHeader(tools::wcsv::ntuple* ntuple) const
92{
93// Write header if ntuple already exists and if this option is activated.
94// When both Hippo and Commented headers are selected, only Commented
95// header, which reading is supported.
96// Return false only if an error occurred.
97
98 if ( fIsCommentedHeader ) {
99 return ntuple->write_commented_header(G4cout);
100 }
101
102 // write hippo header (if activated and if not commented header)
103 if ( fIsHippoHeader ) {
104 ntuple->write_hippo_header();
105 return true;
106 }
107
108 return true;
109}
bool G4bool
Definition: G4Types.hh:86
G4GLOB_DLL std::ostream G4cerr
G4GLOB_DLL std::ostream G4cout
virtual void FinishTNtuple(CsvNtupleDescription *ntupleDescription, G4bool fromBooking) final
G4CsvNtupleManager()=delete
G4bool WriteHeader(tools::wcsv::ntuple *ntuple) const
std::shared_ptr< G4CsvFileManager > fFileManager
virtual void CreateTNtupleFromBooking(CsvNtupleDescription *ntupleDescription) final
static constexpr std::string_view fkClass
std::vector< tools::wcsv::ntuple * > fNtupleVector
void Warn(const G4String &message, const std::string_view inClass, const std::string_view inFunction)
tools::ntuple_booking fNtupleBooking
std::shared_ptr< FT > fFile