Files
geant4/source/geometry/volumes/include/G4AssemblyStore.hh
2025-12-05 08:54:02 +01:00

115 lines
3.9 KiB
C++

//
// ********************************************************************
// * 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. *
// ********************************************************************
//
// G4AssemblyStore
//
// Class description:
//
// Container for all assemblies, 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
// G4AssemblyStore::GetInstance().
//
// All assemblies should be registered with G4AssemblyStore, and removed on
// their destruction. The underlying container initially has a capacity of 20.
//
// If much additional functionality is added, should consider containment
// instead of inheritance for std::vector<T>.
// Author: Gabriele Cosmo (CERN), 9 October 2018
// --------------------------------------------------------------------
#ifndef G4ASSEMBLYSTORE_HH
#define G4ASSEMBLYSTORE_HH
#include <vector>
#include "G4Types.hh"
#include "G4String.hh"
#include "G4VStoreNotifier.hh"
class G4AssemblyVolume;
/**
* @brief G4AssemblyStore is a container for all assemblies, with functionality
* derived from std::vector<T>. The class is a singleton.
* All assemblies are registered with G4AssemblyStore, and removed on their
* destruction.
*/
class G4AssemblyStore : public std::vector<G4AssemblyVolume*>
{
public:
/**
Adds the assembly to the collection.
*/
static void Register(G4AssemblyVolume* pAssembly);
/**
Removes the assembly from the collection.
*/
static void DeRegister(G4AssemblyVolume* pAssembly);
/**
Gets a pointer to the unique G4AssemblyStore, creating it if necessary.
*/
static G4AssemblyStore* GetInstance();
/**
Assigns a notifier for allocation/deallocation of assemblies.
*/
static void SetNotifier(G4VStoreNotifier* pNotifier);
/**
Deletes all assemblies from the store.
*/
static void Clean();
/**
Returns an assembly through its Id number specification.
*/
G4AssemblyVolume* GetAssembly(unsigned int id, G4bool verbose=true) const;
private:
/**
Private singleton constructor.
*/
G4AssemblyStore();
/**
Private destructor. Takes care to delete allocated assemblies.
*/
virtual ~G4AssemblyStore();
private:
static G4AssemblyStore* fgInstance;
static G4ThreadLocal G4VStoreNotifier* fgNotifier;
static G4ThreadLocal G4bool locked;
};
#endif