| Geant4 Cross Reference |
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: Mathieu Karamitros
28
29 // The code is developed in the framework of the ESA AO7146
30 //
31 // We would be very happy hearing from you, send us your feedback! :)
32 //
33 // In order for Geant4-DNA to be maintained and still open-source,
34 // article citations are crucial.
35 // If you use Geant4-DNA chemistry and you publish papers about your software,
36 // in addition to the general paper on Geant4-DNA:
37 //
38 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
39 //
40 // we would be very happy if you could please also cite the following
41 // reference papers on chemistry:
42 //
43 // J. Comput. Phys. 274 (2014) 841-882
44 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
45
46 #ifndef G4ITBox_h
47 #define G4ITBox_h
48
49 #include "G4IT.hh"
50
51 /**
52 * G4ITBox behaves just like a stack for G4IT.
53 * You can search for specific tracks.
54 * Each G4IT knows to which G4ITBox it belongs and its corresponding node.
55 * This makes the deletion of an element very fast.
56 * The drawback is that a G4IT can only belong to one G4ITBox.
57 * If you are not looking for this feature, please use std::list.
58 */
59
60 class G4ITBox
61 {
62
63 public:
64 G4ITBox();
65 ~G4ITBox();
66
67 void ResetStack();
68 void Push(G4IT*);
69 void Extract(G4IT*);
70
71 /** The FindIT methods are used for check only.
72 * Those methods are not effective due to the
73 * linear search. It is better to use GetIT(track)
74 * in order to retrieve the IT and GetIT(track)->GetBox()
75 * in order to check which is the box pointer.
76 */
77 G4IT* FindIT(const G4Track&);
78 const G4IT* FindIT(const G4Track&) const;
79 void TransferTo(G4ITBox*);
80
81 inline G4bool Empty() const;
82 inline G4int GetNTrack() const;
83
84 inline G4IT* GetFirstIT();
85 inline G4IT* GetLastIT();
86 inline const G4IT* GetFirstIT() const;
87 inline const G4IT* GetLastIT() const;
88
89 inline void SetNextBox(G4ITBox* box);
90 inline G4ITBox* GetNextBox();
91 inline const G4ITBox* GetNextBox() const;
92 inline void SetPreviousBox(G4ITBox* box);
93 inline G4ITBox* GetPreviousBox();
94 inline const G4ITBox* GetPreviousBox() const;
95
96 private:
97 const G4ITBox & operator=(const G4ITBox &right);
98 G4int fNbIT{0};
99 G4IT * fpFirstIT{nullptr};
100 G4IT * fpLastIT{nullptr};
101
102 G4ITBox* fpPreviousBox{nullptr};
103 G4ITBox* fpNextBox{nullptr};
104 };
105
106 inline G4bool G4ITBox::Empty() const
107 {
108 return (fNbIT <= 0);
109 }
110
111 inline G4int G4ITBox::GetNTrack() const
112 {
113 return fNbIT;
114 }
115 inline G4IT* G4ITBox::GetFirstIT()
116 {
117 return fpFirstIT;
118 }
119 inline G4IT* G4ITBox::GetLastIT()
120 {
121 return fpLastIT;
122 }
123
124 inline const G4IT* G4ITBox::GetFirstIT() const
125 {
126 return fpFirstIT;
127 }
128 inline const G4IT* G4ITBox::GetLastIT() const
129 {
130 return fpLastIT;
131 }
132
133 inline void G4ITBox::SetNextBox(G4ITBox* box)
134 {
135 fpNextBox = box;
136 }
137
138 inline G4ITBox* G4ITBox::GetNextBox()
139 {
140 return fpNextBox;
141 }
142
143 inline void G4ITBox::SetPreviousBox(G4ITBox* box)
144 {
145 fpPreviousBox = box;
146 }
147
148 inline G4ITBox* G4ITBox::GetPreviousBox()
149 {
150 return fpPreviousBox;
151 }
152
153 #endif
154