Geant4  10.01.p02
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 
37 namespace G4Analysis {
38 
39 // Invalid object Id
40 //
41 const G4int kInvalidId = -1;
42 
43 // Utility functions for checking input parameters
44 G4bool CheckNbins(G4int nbins);
46  const G4String& fcnName = "none",
47  const G4String& binSchemeName = "linear");
48 G4bool CheckEdges(const std::vector<G4double>& edges);
49 G4bool CheckName(const G4String& name, const G4String& objectType);
50 
51 // Get unit value with added handling of "none"
52 G4double GetUnitValue(const G4String& unit);
53 
54 // Add unit & fcn to the title
55 void UpdateTitle(G4String& title,
56  const G4String& unitName, const G4String& fcnName);
57 
58 // Tokenizer with taking into account composed strings within ""
59 void Tokenize(const G4String& line, std::vector<G4String>& tokens);
60 
61 }
62 
63 #endif
64 
65 
66 
67 
G4String name
Definition: TRTMaterials.hh:40
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
G4double GetUnitValue(const G4String &unit)
void Tokenize(const G4String &line, std::vector< G4String > &tokens)
G4bool CheckNbins(G4int nbins)
double G4double
Definition: G4Types.hh:76
const G4int kInvalidId
G4bool CheckMinMax(G4double xmin, G4double xmax, const G4String &fcnName="none", const G4String &binSchemeName="linear")
G4bool CheckEdges(const std::vector< G4double > &edges)