ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4TransportationManager.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4TransportationManager.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 // class G4TransportationManager
27 //
28 // Class description:
29 //
30 // A singleton class which stores the (volume) navigator used by
31 // the transportation process to do the geometrical tracking.
32 // It also stores a pointer to the propagator used in a (magnetic)
33 // field and to the field manager.
34 // The class instance is created before main() is called, and
35 // in turn creates the navigator and the rest.
36 
37 // Created: 10 March 1997, J. Apostolakis
38 // Reviewed: 26 April 2006, G. Cosmo
39 // --------------------------------------------------------------------
40 #ifndef G4TransportationManager_hh
41 #define G4TransportationManager_hh
42 
43 #include "G4Navigator.hh"
44 #include "G4SafetyHelper.hh"
45 
46 #include <vector>
47 
50 class G4FieldManager;
51 class G4VPhysicalVolume;
52 
54 {
55  public: // with description
56 
58  // Retrieve the static instance
60  // Retrieve singleton instance pointer.
61 
63  inline void SetPropagatorInField(G4PropagatorInField* newFieldPropagator);
64  inline G4FieldManager* GetFieldManager() const;
65  void SetFieldManager( G4FieldManager* newFieldManager );
66  // Accessors for field handling
67 
68  inline G4Navigator* GetNavigatorForTracking() const;
69  void SetNavigatorForTracking( G4Navigator* newNavigator );
70  // Accessors for the navigator for tracking
71 
72  inline void SetWorldForTracking(G4VPhysicalVolume* theWorld);
73  // Set the world volume for tracking
74  // This method is to be invoked by G4RunManagerKernel.
75 
76  inline size_t GetNoActiveNavigators() const;
77  inline std::vector<G4Navigator*>::iterator GetActiveNavigatorsIterator();
78  // Return an iterator to the list of active navigators
79 
80  inline size_t GetNoWorlds() const;
81  inline std::vector<G4VPhysicalVolume*>::iterator GetWorldsIterator();
82  // Return an iterator to the list of registered worlds
83 
84  inline G4SafetyHelper* GetSafetyHelper() const;
85  // Return the pointer to the navigation safety helper instance
86 
87  G4VPhysicalVolume* GetParallelWorld ( const G4String& worldName );
88  // Return an exact copy of the tracking world volume. If already
89  // existing just return the pointer
90 
91  G4VPhysicalVolume* IsWorldExisting ( const G4String& worldName );
92  // Verify existance or not of an istance of the world volume with
93  // same name in the collection
94 
95  G4Navigator* GetNavigator ( const G4String& worldName );
97  // Return a navigator associated to either the world volume name
98  // or the pointer to world physical volume. If not existing already
99  // create it and register it in the collection
100 
102  void DeRegisterNavigator( G4Navigator* aNavigator );
103  G4int ActivateNavigator( G4Navigator* aNavigator );
104  void DeActivateNavigator( G4Navigator* aNavigator );
105  void InactivateAll();
106  // Methods for handling navigators. Navigator for tracking is always the
107  // first, i.e. position 0 in the collection and cannot be de-registered
108 
110  static void SetFirstTrackingNavigator(G4Navigator *nav);
111  // Retrieve/set first navigator pointer for 'mass' geometry
112  //
113  // It will be used as a template for cloning the tracking
114  // navigator of additional threads.
115 
116  public: // without description
117 
118  void ClearParallelWorlds();
119  // Clear collection of navigators and delete allocated objects
120  // associated with parallel worlds. Internal method called only
121  // by the RunManager when the entire geometry is rebuilt from scratch.
122 
124  // Destructor
125 
126  protected:
127 
129  // Singleton. Protected constructor
130 
131  private:
132 
133  void ClearNavigators();
134  // Clear collection of navigators and delete allocated objects
135  void DeRegisterWorld( G4VPhysicalVolume* aWorld );
136  // Register/de-register an already allocated world volume.
137  // The pointed object is not deleted.
138 
139  private:
140 
141  std::vector<G4Navigator*> fNavigators;
142  // The collection of all navigators registered
143  std::vector<G4Navigator*> fActiveNavigators;
144  // The collection of only active navigators
145  std::vector<G4VPhysicalVolume*> fWorlds;
146  // The collection of worlds associated to the registered navigators
147 
152 
154 
156 };
157 
158 #include "G4TransportationManager.icc"
159 
160 #endif