Geant4  10.02.p01
G4AnalysisUtilities.hh
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 // $Id: G4Fcn.hh 72292 2013-07-15 12:01:43Z ihrivnac $
27 
28 // Author: Ivana Hrivnacova, 04/07/2012 (ivana@ipno.in2p3.fr)
29 
30 #ifndef G4AnalysisUtilities_h
31 #define G4AnalysisUtilities_h 1
32 
33 #include "globals.hh"
34 
35 #include <vector>
36 #include <memory>
37 
38 // Enumeration for definition of available output types
39 
40 enum class G4AnalysisOutput {
41  kCsv,
42  kRoot,
43  kXml,
44  kNone
45 };
46 
47 namespace G4Analysis
48 {
49 
50 // Constant expressions
51 //
52 // constexpr G4int kX = 0; // not yet supported on vc12
53 // constexpr G4int kY = 1; // not yet supported on vc12
54 // constexpr G4int kZ = 2; // not yet supported on vc12
55 const G4int kX = 0; // not yet supported on vc12
56 const G4int kY = 1; // not yet supported on vc12
57 const G4int kZ = 2; // not yet supported on vc12
58 
59 // Invalid object Id
60 //
61 // constexpr G4int kInvalidId = -1; // not yet supported on vc12
62 const G4int kInvalidId = -1; // not yet supported on vc12
63 
64 // Utility functions for checking input parameters
65 G4bool CheckNbins(G4int nbins);
67  const G4String& fcnName = "none",
68  const G4String& binSchemeName = "linear");
69 G4bool CheckEdges(const std::vector<G4double>& edges);
70 G4bool CheckName(const G4String& name, const G4String& objectType);
71 
72 // Get unit value with added handling of "none"
73 G4double GetUnitValue(const G4String& unit);
74 
75 // Add unit & fcn to the title
76 void UpdateTitle(G4String& title,
77  const G4String& unitName, const G4String& fcnName);
78 
79 // Tokenizer with taking into account composed strings within ""
80 void Tokenize(const G4String& line, std::vector<G4String>& tokens);
81 
82 // make-unique utility, not yet availabla in C++11
83 template<typename T, typename... Args>
84 std::unique_ptr<T> make_unique(Args&&... args)
85 {
86  return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
87 }
88 
89 // get output type from name
90 G4AnalysisOutput GetOutput(const G4String& outputName);
92 
93 /*
94 // make possible to print enumerators in class enum as integer
95 template <typename Enumeration>
96 auto as_integer(Enumeration const value)
97  -> typename std::underlying_type<Enumeration>::type
98 {
99  return static_cast<typename std::underlying_type<Enumeration>::type>(value);
100 }
101 */
102 
103 }
104 
105 #endif
106 
107 
108 
109 
const G4int kZ
std::unique_ptr< T > make_unique(Args &&...args)
G4String name
Definition: TRTMaterials.hh:40
G4AnalysisOutput GetOutput(const G4String &outputName)
G4String GetOutputName(G4AnalysisOutput outputType)
int G4int
Definition: G4Types.hh:78
void UpdateTitle(G4String &title, const G4String &unitName, const G4String &fcnName)
G4bool CheckName(const G4String &name, const G4String &objectType)
bool G4bool
Definition: G4Types.hh:79
const G4int kX
G4double GetUnitValue(const G4String &unit)
void Tokenize(const G4String &line, std::vector< G4String > &tokens)
G4bool CheckNbins(G4int nbins)
double G4double
Definition: G4Types.hh:76
G4AnalysisOutput
const G4int kY
const G4int kInvalidId
G4bool CheckMinMax(G4double xmin, G4double xmax, const G4String &fcnName="none", const G4String &binSchemeName="linear")
G4bool CheckEdges(const std::vector< G4double > &edges)