Geant4  10.03
G4ITBox.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: G4ITBox.hh 100802 2016-11-02 14:55:27Z gcosmo $
27 //
28 // Author: Mathieu Karamitros
29 
30 // The code is developed in the framework of the ESA AO7146
31 //
32 // We would be very happy hearing from you, send us your feedback! :)
33 //
34 // In order for Geant4-DNA to be maintained and still open-source,
35 // article citations are crucial.
36 // If you use Geant4-DNA chemistry and you publish papers about your software,
37 // in addition to the general paper on Geant4-DNA:
38 //
39 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
40 //
41 // we would be very happy if you could please also cite the following
42 // reference papers on chemistry:
43 //
44 // J. Comput. Phys. 274 (2014) 841-882
45 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
46 
47 #ifndef G4ITBox_h
48 #define G4ITBox_h
49 
50 #include "G4IT.hh"
51 
61 class G4ITBox
62 {
63 
64 public:
65  G4ITBox();
66  ~G4ITBox();
67 
68  void ResetStack();
69  void Push(G4IT*);
70  void Extract(G4IT*);
71 
78  G4IT* FindIT(const G4Track&);
79  const G4IT* FindIT(const G4Track&) const;
80  void TransferTo(G4ITBox*);
81 
82  inline G4bool Empty() const;
83  inline G4int GetNTrack() const;
84 
85  inline G4IT* GetFirstIT();
86  inline G4IT* GetLastIT();
87  inline const G4IT* GetFirstIT() const;
88  inline const G4IT* GetLastIT() const;
89 
90  inline void SetNextBox(G4ITBox* box);
91  inline G4ITBox* GetNextBox();
92  inline const G4ITBox* GetNextBox() const;
93  inline void SetPreviousBox(G4ITBox* box);
94  inline G4ITBox* GetPreviousBox();
95  inline const G4ITBox* GetPreviousBox() const;
96 
97 private:
98  const G4ITBox & operator=(const G4ITBox &right);
102 
105 };
106 
107 inline G4bool G4ITBox::Empty() const
108 {
109  return (fNbIT <= 0);
110 }
111 
112 inline G4int G4ITBox::GetNTrack() const
113 {
114  return fNbIT;
115 }
117 {
118  return fpFirstIT;
119 }
121 {
122  return fpLastIT;
123 }
124 
125 inline const G4IT* G4ITBox::GetFirstIT() const
126 {
127  return fpFirstIT;
128 }
129 inline const G4IT* G4ITBox::GetLastIT() const
130 {
131  return fpLastIT;
132 }
133 
134 inline void G4ITBox::SetNextBox(G4ITBox* box)
135 {
136  fpNextBox = box;
137 }
138 
140 {
141  return fpNextBox;
142 }
143 
145 {
146  fpPreviousBox = box;
147 }
148 
150 {
151  return fpPreviousBox;
152 }
153 
154 #endif
G4int GetNTrack() const
Definition: G4ITBox.hh:112
const G4ITBox & operator=(const G4ITBox &right)
Definition: G4ITBox.cc:60
G4ITBox * fpPreviousBox
Definition: G4ITBox.hh:103
G4ITBox * fpNextBox
Definition: G4ITBox.hh:104
void Push(G4IT *)
Definition: G4ITBox.cc:70
G4ITBox()
Definition: G4ITBox.cc:38
G4bool Empty() const
Definition: G4ITBox.hh:107
G4ITBox * GetNextBox()
Definition: G4ITBox.hh:139
int G4int
Definition: G4Types.hh:78
G4ITBox * GetPreviousBox()
Definition: G4ITBox.hh:149
void SetPreviousBox(G4ITBox *box)
Definition: G4ITBox.hh:144
G4IT * GetFirstIT()
Definition: G4ITBox.hh:116
bool G4bool
Definition: G4Types.hh:79
G4IT * fpFirstIT
Definition: G4ITBox.hh:100
void ResetStack()
void SetNextBox(G4ITBox *box)
Definition: G4ITBox.hh:134
G4ITBox behaves just like a stack for G4IT.
Definition: G4ITBox.hh:61
G4IT * FindIT(const G4Track &)
The FindIT methods are used for check only.
Definition: G4ITBox.cc:110
~G4ITBox()
Definition: G4ITBox.cc:41
G4IT * fpLastIT
Definition: G4ITBox.hh:101
G4IT * GetLastIT()
Definition: G4ITBox.hh:120
void TransferTo(G4ITBox *)
Definition: G4ITBox.cc:150
{ Class description:
void Extract(G4IT *)
Definition: G4ITBox.cc:87
G4int fNbIT
Definition: G4ITBox.hh:99