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 | // $Id: G4PhysicsTable.hh,v 1.18 2007/11/13 17:35:06 gcosmo Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-04-beta-01 $ |
---|
29 | // |
---|
30 | // |
---|
31 | // ------------------------------------------------------------ |
---|
32 | // GEANT 4 class header file |
---|
33 | // |
---|
34 | // Class description: |
---|
35 | // |
---|
36 | // G4PhysicsTable is an utility class for storage of pointers |
---|
37 | // to G4PhysicsVector containers. It derives all functionalities |
---|
38 | // of STL vector containers with the addition of few methods for |
---|
39 | // compatibility with previous implementation based on Rogue-Wave |
---|
40 | // pointer collections. |
---|
41 | // The constructor given the 'capacity' of the table, pre-allocates |
---|
42 | // memory for the specified value by invoking the STL's reserve() |
---|
43 | // function, in order to avoid reallocation during insertions. |
---|
44 | // G4PhysicsTable has a vector of boolean which are used |
---|
45 | // as 'recalc-needed' flags when processes calculate physics tables. |
---|
46 | // ------------------------------------------------------------ |
---|
47 | // |
---|
48 | // History: |
---|
49 | // ------- |
---|
50 | // - First implementation, based on object model of |
---|
51 | // 2nd December 1995. G.Cosmo |
---|
52 | // - 1st March 1996, modified. K.Amako |
---|
53 | // - 24th February 2001, migration to STL vectors. H.Kurashige |
---|
54 | // - 9th March 2001, added Store/RetrievePhysicsTable. H.Kurashige |
---|
55 | // - 20th August 2004, added FlagArray and related methods H.Kurashige |
---|
56 | //------------------------------------- |
---|
57 | |
---|
58 | #ifndef G4PhysicsTable_h |
---|
59 | #define G4PhysicsTable_h 1 |
---|
60 | |
---|
61 | #include <vector> |
---|
62 | #include "globals.hh" |
---|
63 | #include "G4ios.hh" |
---|
64 | |
---|
65 | class G4PhysicsVector; |
---|
66 | |
---|
67 | class G4PhysicsTable : public std::vector<G4PhysicsVector*> |
---|
68 | { |
---|
69 | |
---|
70 | typedef std::vector<G4PhysicsVector*> G4PhysCollection; |
---|
71 | typedef std::vector<G4bool> G4FlagCollection; |
---|
72 | |
---|
73 | public: // with description |
---|
74 | |
---|
75 | G4PhysicsTable(); |
---|
76 | // Default constructor. |
---|
77 | |
---|
78 | explicit G4PhysicsTable(size_t cap); |
---|
79 | // Constructor with capacity. Reserves memory for the |
---|
80 | // specified capacity. |
---|
81 | |
---|
82 | virtual ~G4PhysicsTable(); |
---|
83 | // Destructor. |
---|
84 | // Does not invoke deletion of contained pointed collections. |
---|
85 | |
---|
86 | G4PhysicsVector*& operator()(size_t); |
---|
87 | G4PhysicsVector* const& operator()(size_t) const; |
---|
88 | // Access operators. |
---|
89 | |
---|
90 | void clearAndDestroy(); |
---|
91 | // Removes all items and deletes them at the same time. |
---|
92 | |
---|
93 | void push_back( G4PhysicsVector* ); |
---|
94 | void insert (G4PhysicsVector*); |
---|
95 | // Pushes new element to collection. |
---|
96 | |
---|
97 | void insertAt (size_t, G4PhysicsVector*); |
---|
98 | // insert element at the specified position in the collection. |
---|
99 | |
---|
100 | void resize(size_t, G4PhysicsVector* vec = (G4PhysicsVector*)(0)); |
---|
101 | // resize collection |
---|
102 | |
---|
103 | size_t entries() const; |
---|
104 | size_t length() const; |
---|
105 | // Return collection's size. |
---|
106 | |
---|
107 | G4bool isEmpty() const; |
---|
108 | // Flags if collection is empty or not. |
---|
109 | |
---|
110 | G4bool ExistPhysicsTable(const G4String& fileName) const; |
---|
111 | // Check if the specified file exists or not |
---|
112 | |
---|
113 | G4bool StorePhysicsTable(const G4String& filename, G4bool ascii=false); |
---|
114 | // Stores PhysicsTable in a file (returns false in case of failure). |
---|
115 | |
---|
116 | G4bool RetrievePhysicsTable(const G4String& filename, G4bool ascii=false); |
---|
117 | // Retrieves Physics from a file (returns false in case of failure). |
---|
118 | |
---|
119 | void ResetFlagArray(); |
---|
120 | // Reset the array of flags and all flags are set "true" |
---|
121 | // This flag is supposed to be used as "recalc-needed" flag |
---|
122 | // associated with each physics vector |
---|
123 | |
---|
124 | G4bool GetFlag(size_t i) const; |
---|
125 | void ClearFlag(size_t i); |
---|
126 | // Get/Clear the flag for the 'i-th' physics vector |
---|
127 | |
---|
128 | friend std::ostream& operator<<(std::ostream& out, G4PhysicsTable& table); |
---|
129 | |
---|
130 | protected: |
---|
131 | |
---|
132 | G4PhysicsVector* CreatePhysicsVector(G4int type); |
---|
133 | G4FlagCollection vecFlag; |
---|
134 | |
---|
135 | private: |
---|
136 | |
---|
137 | G4PhysicsTable(const G4PhysicsTable&); |
---|
138 | G4PhysicsTable& operator=(const G4PhysicsTable&); |
---|
139 | // Private copy constructor and assignment operator. |
---|
140 | |
---|
141 | }; |
---|
142 | |
---|
143 | typedef G4PhysicsTable::iterator G4PhysicsTableIterator; |
---|
144 | |
---|
145 | #include "G4PhysicsVector.hh" |
---|
146 | #include "G4PhysicsTable.icc" |
---|
147 | |
---|
148 | #endif |
---|