ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4FieldManagerStore.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4FieldManagerStore.hh
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 // G4FieldManagerStore
27 //
28 // Class description:
29 //
30 // Container for all FieldManagers, with functionality derived
31 // from std::vector<T>. The class is a 'singleton', in that only
32 // one can exist, and access is provided via the static function
33 // G4FieldManagerStore::GetInstance().
34 //
35 // All FieldManagers should be registered with G4FieldManagerStore,
36 // and removed on their destruction.
37 // Intended principally to enable resetting of 'state' at start of event.
38 // The underlying container initially has a capacity of 100.
39 
40 // Author: J.Apostolakis, 07.12.2007 - Initial version
41 // --------------------------------------------------------------------
42 #ifndef G4FIELDMANAGERSTORE_HH
43 #define G4FIELDMANAGERSTORE_HH
44 
45 #include <vector>
46 
47 #include "G4FieldManager.hh"
48 
49 class G4FieldManagerStore : public std::vector<G4FieldManager*>
50 {
51  public: // with description
52 
53  static void Register(G4FieldManager* pVolume);
54  // Add the logical volume to the collection.
55  static void DeRegister(G4FieldManager* pVolume);
56  // Remove the logical volume from the collection.
58  // Get a ptr to the unique G4FieldManagerStore, creating it if necessary.
60  // Get a ptr to the unique G4FieldManagerStore.
61  static void Clean();
62  // Delete all volumes from the store.
63 
65  // Looping over all field managers, call each one to reset step estimate
66 
68  // Destructor: takes care to delete allocated field managers.
69 
70  protected:
71 
73 
74  private:
75 
78 };
79 
80 #endif