RecordingEnvelope Class Reference

Responsible for finding the G4LogicalVolume pointer for each recording envelope and for creating and filling the corresponding TrackRecordCollection. More...

#include <RecordingEnvelope.h>

Collaboration diagram for RecordingEnvelope:

Public Member Functions
	RecordingEnvelope (const std::string &envelopeVolumeName, const std::string &trackRecordCollectionName)
	Constructor. More...
	~RecordingEnvelope ()
	Destructor. More...
bool	Initialize ()
	Finds the pointer to the G4LogicalVolume called m_envelopeVolumeName and the number of levels beneath the world volume that it lies. More...
void	BeginOfEvent ()
	Called at the start of each G4 event. More...
int	GetLevel () const
	Returns the number of levels beneath the world volume that the G4LogicalVolume associated with this recording envelope lies. More...
std::string	GetVolumeName () const
	Returns the name of the recording envelope volume. More...
const G4LogicalVolume *	GetLogicalVolume () const
	Returns the pointer to the G4LogicalVolume used by this recording envelope. More...
std::string	GetTrackRecordCollectionName () const
	Returns the name of the TrackRecordCollection to which tracks crossing this recording envelope should be written. More...
void	AddTrackRecord (const G4Step *aStep)
	Add a TrackRecord to the TrackRecordCollection owned by this recording envelope based on the information in aStep. More...

Private Member Functions
bool	checkDaughters (const G4LogicalVolume *possibleParent, const G4VPhysicalVolume *thePhysicalVolume, int &level) const
	Recursively called method used to hunt for the G4LogicalVolume associated with this recording envelope by the Initialize method. More...

Private Attributes
int	m_level
	The number of levels beneath the world that the G4LogicalVolume called m_envelopeVolumeName lies. More...
G4LogicalVolume *	m_logicalVolume
	Pointer to the G4LogicalVolume used by this recording envelope. More...
const std::string	m_envelopeVolumeName
	Name of the G4LogicalVolume used by this recording envelope. More...
SG::WriteHandle< TrackRecordCollection >	m_trackRecordCollection
	WriteHandle to the TrackRecordCollection used by this envelope. More...

Detailed Description

Responsible for finding the G4LogicalVolume pointer for each recording envelope and for creating and filling the corresponding TrackRecordCollection.

Definition at line 24 of file RecordingEnvelope.h.

Constructor & Destructor Documentation

RecordingEnvelope()

RecordingEnvelope::RecordingEnvelope	(	const std::string &	envelopeVolumeName,
		const std::string &	trackRecordCollectionName
	)

Constructor.

Definition at line 19 of file RecordingEnvelope.cxx.

                                                                                                                   :
  m_level(-1),
  m_logicalVolume(nullptr),
  m_envelopeVolumeName(envelopeVolumeName),
  m_trackRecordCollection(trackRecordCollectionName)
{
 
}

~RecordingEnvelope()

RecordingEnvelope::~RecordingEnvelope

(

)

Destructor.

Definition at line 28 of file RecordingEnvelope.cxx.

{
 
}

Member Function Documentation

AddTrackRecord()

void RecordingEnvelope::AddTrackRecord

(

const G4Step *

aStep

)

Add a TrackRecord to the TrackRecordCollection owned by this recording envelope based on the information in aStep.

Definition at line 68 of file RecordingEnvelope.cxx.

{
  const std::string pname = aStep->GetTrack()->GetDefinition()->GetParticleName();
  const int pdgcode = (pname=="geantino") ? 999 : aStep->GetTrack()->GetDefinition()->GetPDGEncoding();
  TrackHelper trHelp(aStep->GetTrack());
  const int barcode = trHelp.GetBarcode();
  const int status = trHelp.GetStatus();
  const int id = trHelp.GetUniqueID();
 
  G4StepPoint *postStep=aStep->GetPostStepPoint();
  G4ThreeVector pos=postStep->GetPosition();
  G4ThreeVector mom=postStep->GetMomentum();
  const double ener=postStep->GetTotalEnergy();
  const double time=postStep->GetGlobalTime();
 
  G4StepPoint *preStep=aStep->GetPreStepPoint();
  G4VPhysicalVolume *preVol=preStep->GetPhysicalVolume();
 
  m_trackRecordCollection->Emplace(pdgcode,status,ener,mom,pos,time,barcode,id,preVol->GetName());
 
  return;
}

BeginOfEvent()

void RecordingEnvelope::BeginOfEvent

(

)

Called at the start of each G4 event.

Recreates the TrackRecordCollection if necessary.

Definition at line 63 of file RecordingEnvelope.cxx.

{
  if (!m_trackRecordCollection.isValid()) m_trackRecordCollection = std::make_unique<TrackRecordCollection>(m_trackRecordCollection.name());
  return;
}

checkDaughters()

bool RecordingEnvelope::checkDaughters ( const G4LogicalVolume *  possibleParent, const G4VPhysicalVolume *  thePhysicalVolume, int &  level  ) const

private

Recursively called method used to hunt for the G4LogicalVolume associated with this recording envelope by the Initialize method.

Definition at line 33 of file RecordingEnvelope.cxx.

{
  if (possibleParent->IsDaughter(thePhysicalVolume))
   {
     ++level;
     return true;
   }
  // Otherwise Loop over the daughters
  const G4int nDaughters(possibleParent->GetNoDaughters());
  for(G4int daughter(0); daughter<nDaughters; ++daughter)
      {
        const G4VPhysicalVolume* daughterPhysVol = possibleParent->GetDaughter(daughter);
        const G4LogicalVolume* daughterLogVol = daughterPhysVol->GetLogicalVolume();
        if (this->checkDaughters(daughterLogVol, thePhysicalVolume,level))
          {
            ++level;
            return true;
          }
      }
   return false;
}

GetLevel()

int RecordingEnvelope::GetLevel ( ) const

inline

Returns the number of levels beneath the world volume that the G4LogicalVolume associated with this recording envelope lies.

Definition at line 98 of file RecordingEnvelope.h.

{
  return m_level;
}

GetLogicalVolume()

const G4LogicalVolume * RecordingEnvelope::GetLogicalVolume ( ) const

inline

Returns the pointer to the G4LogicalVolume used by this recording envelope.

Definition at line 88 of file RecordingEnvelope.h.

{
  return m_logicalVolume;
}

GetTrackRecordCollectionName()

std::string RecordingEnvelope::GetTrackRecordCollectionName ( ) const

inline

Returns the name of the TrackRecordCollection to which tracks crossing this recording envelope should be written.

Definition at line 93 of file RecordingEnvelope.h.

{
  return m_trackRecordCollection.name();
}

GetVolumeName()

std::string RecordingEnvelope::GetVolumeName ( ) const

inline

Returns the name of the recording envelope volume.

Definition at line 83 of file RecordingEnvelope.h.

{
  return m_envelopeVolumeName;
}

Initialize()

bool RecordingEnvelope::Initialize

(

)

Finds the pointer to the G4LogicalVolume called m_envelopeVolumeName and the number of levels beneath the world volume that it lies.

Definition at line 54 of file RecordingEnvelope.cxx.

{
  const G4VPhysicalVolume *thePhysicalVolume = G4PhysicalVolumeStore::GetInstance()->GetVolume(m_envelopeVolumeName,false);
  m_logicalVolume=thePhysicalVolume->GetLogicalVolume();
  const G4LogicalVolume * logicalWorld = G4TransportationManager::GetTransportationManager()->GetNavigatorForTracking()->GetWorldVolume()->GetLogicalVolume();
  m_level=0;
  return this->checkDaughters(logicalWorld, thePhysicalVolume,m_level);
}

Member Data Documentation

m_envelopeVolumeName

const std::string RecordingEnvelope::m_envelopeVolumeName

private

Name of the G4LogicalVolume used by this recording envelope.

Definition at line 77 of file RecordingEnvelope.h.

m_level

int RecordingEnvelope::m_level

private

The number of levels beneath the world that the G4LogicalVolume called m_envelopeVolumeName lies.

Definition at line 69 of file RecordingEnvelope.h.

m_logicalVolume

G4LogicalVolume* RecordingEnvelope::m_logicalVolume

private

Pointer to the G4LogicalVolume used by this recording envelope.

Definition at line 74 of file RecordingEnvelope.h.

m_trackRecordCollection

SG::WriteHandle<TrackRecordCollection> RecordingEnvelope::m_trackRecordCollection

private

WriteHandle to the TrackRecordCollection used by this envelope.

Definition at line 80 of file RecordingEnvelope.h.

---

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

• RecordingEnvelope.h
• RecordingEnvelope.cxx