HerdSoftware  0.3.2
Public Member Functions | Private Attributes | List of all members
Herd::Hit Class Reference

Hit object for transient data model. More...

#include <dataobjects/Hit.h>

Public Member Functions

 Hit ()
 Constructor. More...
 
 Hit (float eDep, unsigned int volumeID)
 
virtual ~Hit ()=default
 Virtual destructor. More...
 
float EDep () const
 Get the deposited energy. More...
 
void SetEDep (float eDep)
 Set the energy deposit of the hit. More...
 
unsigned int VolumeID () const
 Get the unique identifier of the sensitive element. More...
 
void SetVolumeID (unsigned int volumeID)
 Set the ID of the hit volume. More...
 

Private Attributes

float _eDep
 Deposited energy [GeV]. More...
 
unsigned int _volumeId
 Id of the hit volume. More...
 

Detailed Description

Hit object for transient data model.

This class hold the information about a single energy deposit in a single sensitive element of the detector.

Constructor & Destructor Documentation

◆ Hit() [1/2]

Herd::Hit::Hit ( )
inline

Constructor.

◆ Hit() [2/2]

Herd::Hit::Hit ( float  eDep,
unsigned int  volumeID 
)
inline

◆ ~Hit()

virtual Herd::Hit::~Hit ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ EDep()

float Herd::Hit::EDep ( ) const
inline

Get the deposited energy.

Returns
The deposited energy [GeV].

◆ SetEDep()

void Herd::Hit::SetEDep ( float  eDep)
inline

Set the energy deposit of the hit.

Parameters
eDepThe deposited energy [GeV]

◆ SetVolumeID()

void Herd::Hit::SetVolumeID ( unsigned int  volumeID)
inline

Set the ID of the hit volume.

Parameters
volumeIDThe ID of the volume.

◆ VolumeID()

unsigned int Herd::Hit::VolumeID ( ) const
inline

Get the unique identifier of the sensitive element.

Returns
The id of the sensitive element associated to the hit

Member Data Documentation

◆ _eDep

float Herd::Hit::_eDep
private

Deposited energy [GeV].

◆ _volumeId

unsigned int Herd::Hit::_volumeId
private

Id of the hit volume.


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