Import Geant4 11.4.0 source tree

source/geometry/management/include/G4LogicalVolumeStore.hh

@@ -41,10 +41,10 @@
 // If much additional functionality is added, should consider containment
 // instead of inheritance for std::vector<T>.
 
-// 10.07.95, P.Kent, G.Cosmo - Initial version
+// Authors: Gabriele Cosmo & Paul Kent (CERN), 10.07.1995 - Initial version
 // --------------------------------------------------------------------
 #ifndef G4LOGICALVOLUMESTORE_HH
-#define G4LOGICALVOLUMESTORE_HH 1
+#define G4LOGICALVOLUMESTORE_HH
 
 #include <vector>
 #include <map>
@@ -52,45 +52,89 @@
 #include "G4LogicalVolume.hh"
 #include "G4VStoreNotifier.hh"
 
+/**
+ * @brief G4LogicalVolumeStore is a singleton class, acting as container
+ * for all logical volumes, with functionality derived from std::vector<T>.
+ * All logical volumes should be registered with G4LogicalVolumeStore,
+ * and removed on their destruction. The underlying container initially has
+ * a capacity of 100. A map indexed by volume names is also recorded for fast
+ * search; pointers to volumes with same name are stored in buckets.
+*/
+
 class G4LogicalVolumeStore : public std::vector<G4LogicalVolume*>
 {
   public:
 
-    static void Register(G4LogicalVolume* pVolume);
-      // Add the logical volume to the collection.
-    static void DeRegister(G4LogicalVolume* pVolume);
-      // Remove the logical volume from the collection.
-    static G4LogicalVolumeStore* GetInstance();
-      // Get a ptr to the unique G4LogicalVolumeStore, creating it if necessary.
-    static void SetNotifier(G4VStoreNotifier* pNotifier);
-      // Assign a notifier for allocation/deallocation of the logical volumes.
-    static void Clean();
-      // Delete all volumes from the store.
-
-    G4LogicalVolume* GetVolume(const G4String& name, G4bool verbose=true,
-                  G4bool reverseSearch=false) const;
-      // Return the pointer of the first or last volume in the collection having
-      // that name. Uses the internal map for fast search and warns if
-      // a volume in the collection is not unique or not found.
-
-    inline G4bool IsMapValid() const  { return mvalid; }
-    inline void SetMapValid(G4bool val)  { mvalid = val; }
-      // Accessor to assess validity of the internal map.
-    inline const std::map<G4String,
-            std::vector<G4LogicalVolume*> >& GetMap() const { return bmap; }
-      // Return the internal map.
-    void UpdateMap();
-      // Bring contents of internal map up to date and resets validity flag.
-
+    /**
+     * Destructor: takes care to delete allocated logical volumes.
+     */
     virtual ~G4LogicalVolumeStore();
-      // Destructor: takes care to delete allocated logical volumes.
 
+    /**
+     * Copy constructor and assignment operator not allowed.
+     */
     G4LogicalVolumeStore(const G4LogicalVolumeStore&) = delete;
     G4LogicalVolumeStore& operator=(const G4LogicalVolumeStore&) = delete;
-      // Forbidden copy constructor and assignment operator
+
+    /**
+     * Adds the logical volume 'pVolume' to the collection.
+     */
+    static void Register(G4LogicalVolume* pVolume);
+
+    /**
+     * Removes the logical volume 'pVolume' from the collection.
+     */
+    static void DeRegister(G4LogicalVolume* pVolume);
+
+    /**
+     * Returns a pointer to the unique instance of G4LogicalVolumeStore,
+     * creating it if necessary.
+     */
+    static G4LogicalVolumeStore* GetInstance();
+
+    /**
+     * Assigns a notifier for allocation/deallocation of the logical volumes.
+     */
+    static void SetNotifier(G4VStoreNotifier* pNotifier);
+
+    /**
+     * Deletes all volumes from the store.
+     */
+    static void Clean();
+
+    /**
+     * Returns a pointer to the first or last volume in the collection having
+     * that 'name'. Uses the internal map for fast search and warns if
+     * a volume in the collection is not unique or not found.
+     *  @param[in] name The name of the volume to search.
+     *  @param[in] verbose Flag for enabling verbosity (default true).
+     *  @param[in] reverseSearch Flag to enable inverse search (default false).
+     */
+    G4LogicalVolume* GetVolume(const G4String& name, G4bool verbose=true,
+                               G4bool reverseSearch=false) const;
+
+    /**
+     * Accessor and modifier to assess validity of the internal map.
+     */
+    inline G4bool IsMapValid() const { return mvalid; }
+    inline void SetMapValid(G4bool val) { mvalid = val; }
+
+    /**
+     * Returns the internal map.
+     */
+    inline const std::map<G4String,
+            std::vector<G4LogicalVolume*> >& GetMap() const { return bmap; }
+
+    /**
+     * Brings contents of the internal map up to date and resets validity flag.
+     */
+    void UpdateMap();
 
   protected:
 
+    /**
+     * Protected singleton constructor.
+     */
     G4LogicalVolumeStore();
 
   private: