| Geant4 Cross Reference |
1 1
2 ========================================= 2 =========================================================
3 Geant4 - an Object-Oriented Toolkit for S 3 Geant4 - an Object-Oriented Toolkit for Simulation in HEP
4 ========================================= 4 =========================================================
5 5
6 ExampleP02 6 ExampleP02
7 ---------- 7 ----------
8 8
9 General description 9 General description
10 ------------------- 10 -------------------
11 11
12 This example shows how to store in a binary fi 12 This example shows how to store in a binary file and how to
13 read back the geometry tree using the 'reflect 13 read back the geometry tree using the 'reflection' technique for
14 persistency provided by the Reflex tool also i 14 persistency provided by the Reflex tool also included in ROOT. The
15 Reflex tool allows to create a dictionary for 15 Reflex tool allows to create a dictionary for the geometry classes,
16 making then possible to save the entire tree i 16 making then possible to save the entire tree in a .root file.
17 17
18 The provided makefile produces the executable: 18 The provided makefile produces the executable: 'exampleP02'. In order
19 to run it one has to specify the argument, eit 19 to run it one has to specify the argument, either 'write' or
20 'read'. In the first case the geometry is inst 20 'read'. In the first case the geometry is instaciated in the standard
21 way and then saved into the root file (geo.roo 21 way and then saved into the root file (geo.root). In the second case,
22 the geometry is read from geo.root file. 22 the geometry is read from geo.root file.
23 23
24 24
25 Building and running the example 25 Building and running the example
26 -------------------------------- 26 --------------------------------
27 27
28 This examples requires the ROOT toolkit of ver 28 This examples requires the ROOT toolkit of version 6 to be installed. The
29 provided CMake file checks for the existence o 29 provided CMake file checks for the existence of the package and its version.
30 Once the CMake configuration has been succesfu 30 Once the CMake configuration has been succesfully done, the executable
31 for this example should be built using make 31 for this example should be built using make
32 (in your CMake build directory): 32 (in your CMake build directory):
33 33
34 make 34 make
35 35
36 Remark on dictionary generation 36 Remark on dictionary generation
37 ------------------------------- 37 -------------------------------
38 38
39 The dictionary is generated by ${ROOTSYS}/bin/ 39 The dictionary is generated by ${ROOTSYS}/bin/genreflex
40 tool. The arguments that will be used by this << 40 tool. The header file including headers for all the classes we want to
41 in CMakeLists.txt using the CMake function REF << 41 generate the dictionary for should be given as argument. Additionally,
42 provided by ROOT. They include the header file << 42 a so called selection file (xml) should be provided (with -s flag) to
43 all the classes we want to generate the dictio << 43 the genreflex tool (see the GNUmakefile). The role of this file is to
44 a so called selection file (xml). The role of <<
45 specify which classes we want to generate the 44 specify which classes we want to generate the dictionary for. The
46 selection file for our dictionary is in xml/ d 45 selection file for our dictionary is in xml/ directory. Please refer
47 to genreflex manual for more details concernin 46 to genreflex manual for more details concerning the usage of that
48 tool. 47 tool.
49 48
50 Concerning generating dictionary for the Geant 49 Concerning generating dictionary for the Geant4 objects, there are
51 also two technical remarks that need to be mad 50 also two technical remarks that need to be made here.
52 The Reflex tool requires all the templated cla 51 The Reflex tool requires all the templated classes to be
53 explicitely used somewhere in the included hea 52 explicitely used somewhere in the included header files in order for
54 the generation of the dictionary to be possibl 53 the generation of the dictionary to be possible. For those templated
55 classes for which it is not the case, the prob 54 classes for which it is not the case, the problem can be very easily
56 solved by instaciating them in the headerfile 55 solved by instaciating them in the headerfile which is given to
57 genreflex (see includes/ExP02Classes.hh) as ar 56 genreflex (see includes/ExP02Classes.hh) as argument.
58 The second remark is that there is an unfortun 57 The second remark is that there is an unfortunate clash of names as
59 far as G4String class is concerned. The header 58 far as G4String class is concerned. The header of G4String class
60 defines __G4String which happens to be the nam 59 defines __G4String which happens to be the name of a variable used
61 within the generated dictionary code. The solu 60 within the generated dictionary code. The solution for that is to do
62 #undef __G4String in include/ExP02Classes.hh f 61 #undef __G4String in include/ExP02Classes.hh file.