GGSTIntHitBase Class Reference

Base class for storing G4 integrated hits. More...

#include <GGSTHits.h>

Inheritance diagram for GGSTIntHitBase:

Collaboration diagram for GGSTIntHitBase:

Public Member Functions
	GGSTIntHitBase ()
	Constructor.
	~GGSTIntHitBase ()
	Destructor.
void	Clear (Option_t *)
	Resets the data members. More...
const TString &	GetDetectorName ()
	Retrieves the name of the detector associated to the hit. More...
const TArrayF &	GetTimeBins ()
	Retrieves the time bins for the hit. More...
const TString &	GetVolumeName ()
	Retrieves the name of the volume associated to the hit. More...
const Float_t *	GetVolumePosition ()
	Retrieves the position of the volume associated to the hit. More...
Int_t	GetVolumeID ()
	Retrieves the ID of the volume associated to the hit. More...
Int_t	GetNPartHits ()
	Gets the number of particle hits. More...
GGSTPartHitBase *	GetPartHit (unsigned int iHit)
	Get the specified particle hit. More...
std::string	GetPartHitsClassName ()
	Gets the name of the class of the particle hits. More...

Data Fields
Float_t	eDep
	Deposited energy (transient).
TArrayF	eDepTimeBin
	Energy deposit in each time bin.

Friends
class	GGSHitsAction
class	GGSTHitsReader

Detailed Description

Base class for storing G4 integrated hits.

This class is used to write on ROOT files the informations stored in GGSIntHit. It inherits form TObject and has just data members for energy deposit and volume information.

Definition at line 218 of file GGSTHits.h.

Member Function Documentation

void GGSTIntHitBase::Clear

(

Option_t *

)

Resets the data members.

Will clear also the TClonesArray of particle hits by passing the opt parameter (i.e. if opt is "C" then also the particle hits will be cleared).

Parameters

opt	The cleaning option.

Definition at line 167 of file GGSTHits.cpp.

                                     {
  eDep = 0.;
  eDepTimeBin.Reset();
  _volumeIndex = 0;
  if (_partHits)
    _partHits->Clear("C");
}

const TString& GGSTIntHitBase::GetDetectorName ( )

inline

Retrieves the name of the detector associated to the hit.

Returns

The name of the detector (i.e. logical volume).

Definition at line 257 of file GGSTHits.h.

                                   {
    static const TString nullString("");
    if (_hitDetInfo)
      return _hitDetInfo->detectorName;
    else
      return nullString;
  }

Int_t GGSTIntHitBase::GetNPartHits

(

)

Gets the number of particle hits.

Returns

The number of hits (0 if the information is not available).

Definition at line 175 of file GGSTHits.cpp.

                                   {
  if (_partHits)
    return (_partHits->GetEntries());
  else
    return 0;
}

GGSTPartHitBase * GGSTIntHitBase::GetPartHit

(

unsigned int

iHit

)

Get the specified particle hit.

Parameters

iHit	The desired hit.

Returns

Pointer to the hit object (NULL if iHit is out of bounds).

Definition at line 182 of file GGSTHits.cpp.

                                                             {
  GGSTPartHitBase *hit = nullptr;
  if (_partHits) {
    hit = (GGSTPartHitBase *)(_partHits->At(iHit));
  }
  return hit;
}

std::string GGSTIntHitBase::GetPartHitsClassName

(

)

Gets the name of the class of the particle hits.

Returns

The particle hits class name.

Definition at line 190 of file GGSTHits.cpp.

                                               {
  if (_partHits == nullptr) {
    return "";
  }
  std::string retValue = _partHits->GetName();
  return retValue.substr(0, retValue.size() - 1);
}

const TArrayF& GGSTIntHitBase::GetTimeBins ( )

inline

Retrieves the time bins for the hit.

See GGSIntHit::GetTimeBins for details.

Returns

The time bins

Definition at line 271 of file GGSTHits.h.

{ return *_timeBins; }

Int_t GGSTIntHitBase::GetVolumeID ( )

inline

Retrieves the ID of the volume associated to the hit.

Returns

The ID of the volume.

Definition at line 300 of file GGSTHits.h.

                      {
    if (_hitVolInfo)
      return _hitVolInfo->id;
    else
      return -1;
  }

const TString& GGSTIntHitBase::GetVolumeName ( )

inline

Retrieves the name of the volume associated to the hit.

Returns

The name of the volume.

Definition at line 277 of file GGSTHits.h.

                                 {
    static const TString nullString("");
    if (_hitVolInfo)
      return _hitVolInfo->volumeName;
    else
      return nullString;
  }

const Float_t* GGSTIntHitBase::GetVolumePosition ( )

inline

Retrieves the position of the volume associated to the hit.

Returns

The position of the volume (as a Float_t[3] array containing (X,Y,Z) coordinates in cm)).

Definition at line 289 of file GGSTHits.h.

                                     {
    if (_hitVolInfo)
      return _hitVolInfo->volumePos;
    else
      return NULL;
  }

---

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

• GGSTHits.h
• GGSTHits.cpp