//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4PhysicalVolumeStore
//
// Class description:
//
// Container for all physical volumes, with functionality derived from
// std::vector<T>. The class is a 'singleton', in that only
// one can exist, and access is provided via the static method
// G4PhysicalVolumeStore::GetInstance()
//
// All volumes should be registered with G4PhysicalVolumeStore, 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.
//
// If much additional functionality is added, should consider containment
// instead of inheritance for std::vector<T>.

// Authors: Gabriele Cosmo & Paul Kent (CERN), 25.07.1995 - Initial version
// --------------------------------------------------------------------
#ifndef G4PHYSICALVOLUMESTORE_HH
#define G4PHYSICALVOLUMESTORE_HH

#include <vector>
#include <map>

#include "G4VPhysicalVolume.hh"
#include "G4VStoreNotifier.hh"

/**
 * @brief G4PhysicalVolumeStore is a singleton class, acting as container
 * for all physical volumes, with functionality derived from std::vector<T>.
 * All physical volumes should be registered with G4PhysicalVolumeStore, 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 G4PhysicalVolumeStore : public std::vector<G4VPhysicalVolume*>
{
  public:

    /**
     * Destructor: takes care to delete allocated physical volumes.
     */
    virtual ~G4PhysicalVolumeStore();

    /**
     * Copy constructor and assignment operator not allowed.
     */
    G4PhysicalVolumeStore(const G4PhysicalVolumeStore&) = delete;
    G4PhysicalVolumeStore& operator=(const G4PhysicalVolumeStore&) = delete;

    /**
     * Adds the logical volume 'pVolume' to the collection.
     */
    static void Register(G4VPhysicalVolume* pVolume);

    /**
     * Removes the logical volume 'pVolume' from the collection.
     */
    static void DeRegister(G4VPhysicalVolume* pVolume);

    /**
     * Returns a pointer to the unique instance of G4PhysicalVolumeStore,
     * creating it if necessary.
     */
    static G4PhysicalVolumeStore* GetInstance();

    /**
     * Assigns a notifier for allocation/deallocation of the physical volumes.
     */
    static void SetNotifier(G4VStoreNotifier* pNotifier);

    /**
     * Deletes all physical volumes from the store. Mother logical volumes
     * are automatically notified and have their daughters de-registered.
     */
    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).
     */
    G4VPhysicalVolume* 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; }

    /**
     * Return the internal map.
     */
    inline const std::map<G4String,
            std::vector<G4VPhysicalVolume*> >& GetMap() const { return bmap; }

    /**
     * Brings contents of the internal map up to date and resets validity flag.
     */
    void UpdateMap();

  protected:

    /**
     * Protected constructor.
     */
    G4PhysicalVolumeStore();

  private:

    static G4PhysicalVolumeStore* fgInstance;
    static G4ThreadLocal G4VStoreNotifier* fgNotifier;
    static G4ThreadLocal G4bool locked;

    std::map<G4String, std::vector<G4VPhysicalVolume*> > bmap;
    G4bool mvalid = false;  // Flag to indicate if map is up to date or not
};

#endif