| 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 // G4DecayTable
27 //
28 // Class description:
29 //
30 // G4DecayTable is the table of pointers to G4VDecayChannel.
31 // Decay channels inside are sorted by using decay branching ratio
32
33 // Author: H.Kurashige, 7 July 1996
34 // --------------------------------------------------------------------
35 #ifndef G4DecayTable_hh
36 #define G4DecayTable_hh 1
37
38 #include "G4ParticleDefinition.hh"
39 #include "G4VDecayChannel.hh"
40 #include "G4ios.hh"
41 #include "globals.hh"
42
43 #include <vector>
44
45 class G4DecayTable
46 {
47 public:
48 using G4VDecayChannelVector = std::vector<G4VDecayChannel*>;
49
50 G4DecayTable();
51 ~G4DecayTable();
52
53 G4DecayTable(const G4DecayTable&) = delete;
54 G4DecayTable& operator=(const G4DecayTable&) = delete;
55
56 // Equality operators
57 inline G4bool operator==(const G4DecayTable& right) const;
58 inline G4bool operator!=(const G4DecayTable& right) const;
59
60 // Insert a decay channel at proper position
61 // (i.e. sorted by using branching ratio )
62 void Insert(G4VDecayChannel* aChannel);
63
64 // Returns number of decay channels inside
65 inline G4int entries() const;
66
67 // A decay channel is selected at random according to the branching ratio
68 G4VDecayChannel* SelectADecayChannel(G4double parentMass = -1.);
69
70 // Get index-th decay channel
71 inline G4VDecayChannel* GetDecayChannel(G4int index) const;
72 inline G4VDecayChannel* operator[](G4int index);
73
74 void DumpInfo() const;
75
76 private:
77 G4ParticleDefinition* parent = nullptr;
78 G4VDecayChannelVector* channels = nullptr;
79 };
80
81 // ------------------------
82 // Inline methods
83 // ------------------------
84
85 inline G4bool G4DecayTable::operator==(const G4DecayTable& right) const
86 {
87 return (this == &right);
88 }
89
90 inline G4bool G4DecayTable::operator!=(const G4DecayTable& right) const
91 {
92 return (this != &right);
93 }
94
95 inline G4int G4DecayTable::entries() const
96 {
97 return G4int(channels->size());
98 }
99
100 inline G4VDecayChannel* G4DecayTable::operator[](G4int index)
101 {
102 return (*channels)[index];
103 }
104
105 inline G4VDecayChannel* G4DecayTable::GetDecayChannel(G4int index) const
106 {
107 G4VDecayChannel* selectedChannel = nullptr;
108 if ((index >= 0) && (index < G4int(channels->size()))) {
109 selectedChannel = (*channels)[index];
110 }
111 return selectedChannel;
112 }
113
114 #endif
115