FCS_Param::detail::SDWrapper< SDType, HitContainerType > Class Template Reference

A template class which wraps multiple sensitive detectors. More...

#include <SDWrapper.h>

Inheritance diagram for FCS_Param::detail::SDWrapper< SDType, HitContainerType >:

Collaboration diagram for FCS_Param::detail::SDWrapper< SDType, HitContainerType >:

Public Types
using	SDList_t = std::vector< std::unique_ptr< SDType > >
	Alias to the SD list type. More...

Public Member Functions
	SDWrapper (const std::string &name, const std::string &hitCollectionName)
	Construct the wrapper from the output collection name. More...
void	addSD (std::unique_ptr< SDType > sd)
	Add an SD to this wrapper. More...
virtual void	Initialize (G4HCofThisEvent *) override final
	Beginning of G4 event; initialize the hit collection. More...
virtual bool	ProcessHits (G4Step *, G4TouchableHistory *) override final
	This method should not be called. It will throw. More...
void	EndOfAthenaEvent ()
	Gather the hits into the WriteHandle from all the SDs. More...

Private Attributes
std::string	m_hitCollName
	The hit container name. More...
SG::WriteHandle< HitContainerType >	m_hitColl
	The hit container handle. More...
SDList_t	m_sdList
	The list of sensitive detectors that I own and manage. More...

Detailed Description

template<class SDType, class HitContainerType>
class FCS_Param::detail::SDWrapper< SDType, HitContainerType >

A template class which wraps multiple sensitive detectors.

Allows for SD tools to manage several SDs which collaborate to fill one hit container in a multi-threading-friendly way. The wrapper owns the WriteHandle for the hit container and gathers hits from each SD at the end of an event.

The inheritance from G4VSensitiveDetector is merely a trick so the SD tool can save this object in the SensitiveDetectorBase thread-local container. It also allows to create the hit container at the right time via the SD Initialize method invoked by Geant4.

Clients shouldn't use this generic template directly, but should use the explicitly allowed specializations given below.

Author

Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 50 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h.

Member Typedef Documentation

SDList_t

template<class SDType , class HitContainerType >

using FCS_Param::detail::SDWrapper< SDType, HitContainerType >::SDList_t = std::vector< std::unique_ptr<SDType> >

Alias to the SD list type.

Definition at line 56 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h.

Constructor & Destructor Documentation

SDWrapper()

template<class SDType , class HitContainerType >

FCS_Param::detail::SDWrapper< SDType, HitContainerType >::SDWrapper	(	const std::string &	name,
		const std::string &	hitCollectionName
	)

Construct the wrapper from the output collection name.

Definition at line 28 of file SDWrapper.cxx.

      : G4VSensitiveDetector(name),
        m_hitCollName(hitCollectionName),
        m_hitColl(hitCollectionName)
    {}

Member Function Documentation

addSD()

template<class SDType , class HitContainerType >

void FCS_Param::detail::SDWrapper< SDType, HitContainerType >::addSD

(

std::unique_ptr< SDType >

sd

)

Add an SD to this wrapper.

Definition at line 39 of file SDWrapper.cxx.

    {
      m_sdList.push_back( std::move(sd) );
    }

EndOfAthenaEvent()

template<class SDType , class HitContainerType >

void FCS_Param::detail::SDWrapper< SDType, HitContainerType >::EndOfAthenaEvent

Gather the hits into the WriteHandle from all the SDs.

Definition at line 78 of file SDWrapper.cxx.

    {
      if(!m_hitColl.isValid()) {
        G4cerr << GetName() << " \tERROR\t" << "Hit collection WriteHandle is "
               << "invalid!" << G4endl;
        throw std::runtime_error("Invalid hit container WriteHandle: " +
                                 m_hitColl.name());
      }
      // Loop over each SD and fill the container
      for(auto& sd : m_sdList) {
        sd->EndOfAthenaEvent( &*m_hitColl );
      }
    }

Initialize()

template<class SDType , class HitContainerType >

void FCS_Param::detail::SDWrapper< SDType, HitContainerType >::Initialize ( G4HCofThisEvent *  )

finaloverridevirtual

Beginning of G4 event; initialize the hit collection.

Definition at line 49 of file SDWrapper.cxx.

    {
      if(!m_hitColl.isValid()) {
        if(verboseLevel >= 5) {
          G4cout << GetName() << " \tDEBUG\t" << "Initializing hit container: "
                 << m_hitCollName << G4endl;
        }
        m_hitColl = std::make_unique<HitContainerType>();
      }
    }

ProcessHits()

template<class SDType , class HitContainerType >

bool FCS_Param::detail::SDWrapper< SDType, HitContainerType >::ProcessHits ( G4Step *  , G4TouchableHistory *    )

finaloverridevirtual

This method should not be called. It will throw.

Definition at line 65 of file SDWrapper.cxx.

    {
      G4ExceptionDescription description;
      description << "ProcessHits: this SD shouldn't be assigned to volumes!";
      G4Exception(GetName(), "SDError", FatalException, description);
      return false;
    }

Member Data Documentation

m_hitColl

template<class SDType , class HitContainerType >

SG::WriteHandle<HitContainerType> FCS_Param::detail::SDWrapper< SDType, HitContainerType >::m_hitColl

private

The hit container handle.

Definition at line 79 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h.

m_hitCollName

template<class SDType , class HitContainerType >

std::string FCS_Param::detail::SDWrapper< SDType, HitContainerType >::m_hitCollName

private

The hit container name.

Definition at line 76 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h.

m_sdList

template<class SDType , class HitContainerType >

SDList_t FCS_Param::detail::SDWrapper< SDType, HitContainerType >::m_sdList

private

The list of sensitive detectors that I own and manage.

Definition at line 82 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h.

---

The documentation for this class was generated from the following files:

• Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimSD/src/SDWrapper.h
• SDWrapper.cxx