Geant4  10.01.p03
G4TransportationManager.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 //
27 // $Id: G4TransportationManager.hh 83466 2014-08-25 10:31:39Z gcosmo $
28 //
29 // class G4TransportationManager
30 //
31 // Class description:
32 //
33 // A singleton class which stores the (volume) navigator used by
34 // the transportation process to do the geometrical tracking.
35 // It also stores a pointer to the propagator used in a (magnetic)
36 // field and to the field manager.
37 // The class instance is created before main() is called, and
38 // in turn creates the navigator and the rest.
39 
40 // Created: 10 March 1997, J. Apostolakis
41 // Reviewed: 26 April 2006, G. Cosmo
42 // --------------------------------------------------------------------
43 
44 #ifndef G4TransportationManager_hh
45 #define G4TransportationManager_hh
46 
47 #include "G4Navigator.hh"
48 #include "G4SafetyHelper.hh"
49 
50 #include <vector>
51 
54 class G4FieldManager;
55 class G4VPhysicalVolume;
56 
58 {
59  public: // with description
60 
62  // Retrieve the static instance
63 
65  inline void SetPropagatorInField( G4PropagatorInField* newFieldPropagator );
66  inline G4FieldManager* GetFieldManager() const;
67  void SetFieldManager( G4FieldManager* newFieldManager );
68  // Accessors for field handling
69 
70  inline G4Navigator* GetNavigatorForTracking() const;
71  void SetNavigatorForTracking( G4Navigator* newNavigator );
72  // Accessors for the navigator for tracking
73 
74  inline void SetWorldForTracking(G4VPhysicalVolume* theWorld);
75  // Set the world volume for tracking
76  // This method is to be invoked by G4RunManagerKernel.
77 
78  inline size_t GetNoActiveNavigators() const;
79  inline std::vector<G4Navigator*>::iterator GetActiveNavigatorsIterator();
80  // Return an iterator to the list of active navigators
81 
82  inline size_t GetNoWorlds() const;
83  inline std::vector<G4VPhysicalVolume*>::iterator GetWorldsIterator();
84  // Return an iterator to the list of registered worlds
85 
86  inline G4SafetyHelper* GetSafetyHelper() const;
87  // Return the pointer to the navigation safety helper instance
88 
89  G4VPhysicalVolume* GetParallelWorld ( const G4String& worldName );
90  // Return an exact copy of the tracking world volume. If already
91  // existing just return the pointer
92 
93  G4VPhysicalVolume* IsWorldExisting ( const G4String& worldName );
94  // Verify existance or not of an istance of the world volume with
95  // same name in the collection
96 
97  G4Navigator* GetNavigator ( const G4String& worldName );
99  // Return a navigator associated to either the world volume name
100  // or the pointer to world physical volume. If not existing already
101  // create it and register it in the collection
102 
104  void DeRegisterNavigator( G4Navigator* aNavigator );
105  G4int ActivateNavigator( G4Navigator* aNavigator );
106  void DeActivateNavigator( G4Navigator* aNavigator );
107  void InactivateAll();
108  // Methods for handling navigators. Navigator for tracking is always the
109  // first, i.e. position 0 in the collection and cannot be de-registered
110 
111  public: // without description
112 
113  void ClearParallelWorlds();
114  // Clear collection of navigators and delete allocated objects
115  // associated with parallel worlds. Internal method called only
116  // by the RunManager when the entire geometry is rebuilt from scratch.
117 
118  protected:
119 
122  // Singleton. Protected constructor and destructor
123 
124  private:
125 
126  void ClearNavigators();
127  // Clear collection of navigators and delete allocated objects
128  void DeRegisterWorld( G4VPhysicalVolume* aWorld );
129  // Register/de-register an already allocated world volume.
130  // The pointed object is not deleted.
131 
132  private:
133 
134  std::vector<G4Navigator*> fNavigators;
135  // The collection of all navigators registered
136  std::vector<G4Navigator*> fActiveNavigators;
137  // The collection of only active navigators
138  std::vector<G4VPhysicalVolume*> fWorlds;
139  // The collection of worlds associated to the registered navigators
140 
145 
147 };
148 
150 
151 #endif
G4VPhysicalVolume * IsWorldExisting(const G4String &worldName)
G4SafetyHelper * GetSafetyHelper() const
std::vector< G4VPhysicalVolume * >::iterator GetWorldsIterator()
G4Navigator * GetNavigatorForTracking() const
void SetFieldManager(G4FieldManager *newFieldManager)
#define G4ThreadLocal
Definition: tls.hh:89
int G4int
Definition: G4Types.hh:78
std::vector< G4VPhysicalVolume * > fWorlds
G4PropagatorInField * fPropagatorInField
size_t GetNoActiveNavigators() const
std::vector< G4Navigator * > fActiveNavigators
bool G4bool
Definition: G4Types.hh:79
void DeActivateNavigator(G4Navigator *aNavigator)
void DeRegisterNavigator(G4Navigator *aNavigator)
G4GeometryMessenger * fGeomMessenger
static G4TransportationManager * GetTransportationManager()
G4FieldManager * GetFieldManager() const
G4VPhysicalVolume * GetParallelWorld(const G4String &worldName)
G4int ActivateNavigator(G4Navigator *aNavigator)
G4Navigator * GetNavigator(const G4String &worldName)
std::vector< G4Navigator * >::iterator GetActiveNavigatorsIterator()
void SetPropagatorInField(G4PropagatorInField *newFieldPropagator)
static G4ThreadLocal G4TransportationManager * fTransportationManager
void DeRegisterWorld(G4VPhysicalVolume *aWorld)
size_t GetNoWorlds() const
std::vector< G4Navigator * > fNavigators
G4bool RegisterWorld(G4VPhysicalVolume *aWorld)
void SetWorldForTracking(G4VPhysicalVolume *theWorld)
G4PropagatorInField * GetPropagatorInField() const
void SetNavigatorForTracking(G4Navigator *newNavigator)