Herd::Readers::GGSCaloSpdHitsReader Class Reference

SpdHits reader class. More...

#include <dataproviders/readers/event/GGSCaloSpdHitsReader.h>

Public Member Functions
	GGSCaloSpdHitsReader (std::shared_ptr< GGSTRootReader > ggsReader)
bool	IsCaloSpdHitsAvailable ()
	Checks if SPD hits are available in the simulation file. More...
RetrievalResult	GetCaloSpdHits (ObjectWrapper &wrapper)
	Get the SPD Hits. More...
std::vector< std::string >	FreeObjects (const std::vector< std::string > &objs, Memory::Status memStatus)
	Free the memory of unneeded objects. More...
void	SetCaloSpdHitIDFromGGSPos (std::function< unsigned int(const float *)> conversionFunction)
	Set the volID calculator for the SPD. More...
void	SetSameIDs (bool value)
	Sets the same IDs flag. More...

Private Attributes
std::shared_ptr< GGSTRootReader >	m_ggsReader
GGSTHitsReader *	m_hitReader = nullptr
long long int	m_lastReadEvent = std::numeric_limits<long long int>::max()
std::function< unsigned int(const float *)>	m_spdVolIDFromGGSPos
bool	m_sameIDs
int	m_caloDetIndex = std::numeric_limits<int>::lowest()
CaloSpdHits	m_CaloSpdHits

Detailed Description

SpdHits reader class.

Class for reading the SpdHits object from a GGS simulation file.

Constructor & Destructor Documentation

GGSCaloSpdHitsReader()

Herd::Readers::GGSCaloSpdHitsReader::GGSCaloSpdHitsReader ( std::shared_ptr< GGSTRootReader >  ggsReader )

inline

Member Function Documentation

FreeObjects()

std::vector< std::string > Herd::Readers::GGSCaloSpdHitsReader::FreeObjects	(	const std::vector< std::string > &	objs,
		Memory::Status	memStatus
	)

Free the memory of unneeded objects.

Currently this method frees the memory of the provided objects if memStatus is EXHAUSTED. This reader frees the following objects:

• SpdHitsGGS

Parameters

objs	The list of objects to be freed.
memStatus	The current memory occupation status.

Returns

a list of freed objects.

GetCaloSpdHits()

RetrievalResult Herd::Readers::GGSCaloSpdHitsReader::GetCaloSpdHits

(

ObjectWrapper &

wrapper

)

Get the SPD Hits.

Parameters

wrapper

A wrapper to the SPDHits object

Returns

RetrievalResult The result of the operation (SUCCESS or ERROR)

IsCaloSpdHitsAvailable()

bool Herd::Readers::GGSCaloSpdHitsReader::IsCaloSpdHitsAvailable

(

)

Checks if SPD hits are available in the simulation file.

Check the GGS reader for the presence of SPD hits

Returns

true

false

SetCaloSpdHitIDFromGGSPos()

void Herd::Readers::GGSCaloSpdHitsReader::SetCaloSpdHitIDFromGGSPos ( std::function< unsigned int(const float *)>  conversionFunction )

inline

Set the volID calculator for the SPD.

Sets the function that handles the computation of the volumeID for a SPD at a given position.

Parameters

conversionFunction

the conversion function.

SetSameIDs()

void Herd::Readers::GGSCaloSpdHitsReader::SetSameIDs ( bool  value )

inline

Sets the same IDs flag.

When the flag is set to true the GGSCaloHitsReader will assume that the GGS volume IDs are equal to the Herd volume IDs and will not call the function set by SetCaloSpdHitIDFromGGSPos to determine the Herd volume ID from GGS position.

Parameters

value

The flag value.

Member Data Documentation

m_caloDetIndex

int Herd::Readers::GGSCaloSpdHitsReader::m_caloDetIndex = std::numeric_limits<int>::lowest()

private

m_CaloSpdHits

CaloSpdHits Herd::Readers::GGSCaloSpdHitsReader::m_CaloSpdHits

private

m_ggsReader

std::shared_ptr<GGSTRootReader> Herd::Readers::GGSCaloSpdHitsReader::m_ggsReader

private

m_hitReader

GGSTHitsReader* Herd::Readers::GGSCaloSpdHitsReader::m_hitReader = nullptr

private

m_lastReadEvent

long long int Herd::Readers::GGSCaloSpdHitsReader::m_lastReadEvent = std::numeric_limits<long long int>::max()

private

m_sameIDs

bool Herd::Readers::GGSCaloSpdHitsReader::m_sameIDs

private

m_spdVolIDFromGGSPos

std::function<unsigned int(const float *)> Herd::Readers::GGSCaloSpdHitsReader::m_spdVolIDFromGGSPos

private

---

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

• /builds/herd/HerdSoftware/include/herd/analysis/dataproviders/readers/event/GGSCaloSpdHitsReader.h
• /builds/herd/HerdSoftware/src/analysis/dataproviders/readers/event/GGSCaloSpdHitsReader.cpp