pandora::CaloHitMetadata Class Reference

CaloHitMetadata class. More...

#include "Metadata.h"

Public Member Functions
	CaloHitMetadata (CaloHitList *const pCaloHitList, const std::string &caloHitListName, const bool initialHitAvailability)
	Constructor.
	~CaloHitMetadata ()
	Destructor.
template<typename T >
bool	IsAvailable (const T *const pT) const
	Is a calo hit, or a list of calo hits, available to add to a cluster.
template<typename T >
StatusCode	SetAvailability (const T *const pT, bool isAvailable)
	Set availability of a calo hit, or a list of calo hits, to be added to a cluster.
StatusCode	Update (const CaloHitMetadata &caloHitMetadata)
	Update metadata to account for changes by daughter recluster processes.
StatusCode	Update (const CaloHitReplacement &caloHitReplacement)
	Update metadata to account for a specific calo hit replacement.
void	Clear ()
	Clear all metadata content.
const CaloHitUsageMap &	GetCaloHitUsageMap () const
	Get the calo hit usage map.
const CaloHitReplacementList &	GetCaloHitReplacementList () const
	Get the calo hit replacement list.
template<>
bool	IsAvailable (const CaloHit *const pCaloHit) const
template<>
bool	IsAvailable (const CaloHitList *const pCaloHitList) const
template<>
StatusCode	SetAvailability (const CaloHit *const pCaloHit, bool isAvailable)
template<>
StatusCode	SetAvailability (const CaloHitList *const pCaloHitList, bool isAvailable)

Private Attributes
CaloHitList *	m_pCaloHitList
	Address of the associated calo hit list.
std::string	m_caloHitListName
	The name of the associated calo hit list.
CaloHitUsageMap	m_caloHitUsageMap
	The calo hit usage map.
CaloHitReplacementList	m_caloHitReplacementList
	The calo hit replacement list.

Detailed Description

CaloHitMetadata class.

Definition at line 38 of file Metadata.h.

Constructor & Destructor Documentation

CaloHitMetadata()

pandora::CaloHitMetadata::CaloHitMetadata	(	CaloHitList *const	pCaloHitList,
		const std::string &	caloHitListName,
		const bool	initialHitAvailability
	)

Constructor.

Parameters

pCaloHitList	address of the associated calo hit list
caloHitListName	name of the associated calo hit list
initialHitAvailability	the initial availability of the calo hits

Definition at line 18 of file Metadata.cc.

~CaloHitMetadata()

pandora::CaloHitMetadata::~CaloHitMetadata

(

)

Destructor.

Definition at line 31 of file Metadata.cc.

Member Function Documentation

Clear()

void pandora::CaloHitMetadata::Clear

(

)

Clear all metadata content.

Definition at line 172 of file Metadata.cc.

Here is the caller graph for this function:

GetCaloHitReplacementList()

const CaloHitReplacementList & pandora::CaloHitMetadata::GetCaloHitReplacementList ( ) const

inline

Get the calo hit replacement list.

Returns

the calo hit replacement list

Definition at line 188 of file Metadata.h.

Here is the caller graph for this function:

GetCaloHitUsageMap()

const CaloHitUsageMap & pandora::CaloHitMetadata::GetCaloHitUsageMap ( ) const

inline

Get the calo hit usage map.

Returns

the calo hit usage map

Definition at line 181 of file Metadata.h.

Here is the caller graph for this function:

IsAvailable() [1/3]

template<>

bool pandora::CaloHitMetadata::IsAvailable

(

const CaloHit *const

pCaloHit

)

const

Definition at line 45 of file Metadata.cc.

IsAvailable() [2/3]

template<>

bool pandora::CaloHitMetadata::IsAvailable

(

const CaloHitList *const

pCaloHitList

)

const

Definition at line 56 of file Metadata.cc.

IsAvailable() [3/3]

template<typename T >

bool pandora::CaloHitMetadata::IsAvailable

(

const T *const

pT

)

const

Is a calo hit, or a list of calo hits, available to add to a cluster.

Parameters

pT	address of the object or object list

Returns

boolean

Here is the caller graph for this function:

SetAvailability() [1/3]

template<>

StatusCode pandora::CaloHitMetadata::SetAvailability	(	const CaloHit *const	pCaloHit,
		bool	isAvailable
	)

Definition at line 72 of file Metadata.cc.

SetAvailability() [2/3]

template<>

StatusCode pandora::CaloHitMetadata::SetAvailability	(	const CaloHitList *const	pCaloHitList,
		bool	isAvailable
	)

Definition at line 85 of file Metadata.cc.

SetAvailability() [3/3]

template<typename T >

StatusCode pandora::CaloHitMetadata::SetAvailability	(	const T *const	pT,
		bool	isAvailable
	)

Set availability of a calo hit, or a list of calo hits, to be added to a cluster.

Parameters

pT	the address of the object or object list
isAvailable	the availability

Here is the caller graph for this function:

Update() [1/2]

StatusCode pandora::CaloHitMetadata::Update

(

const CaloHitMetadata &

caloHitMetadata

)

Update metadata to account for changes by daughter recluster processes.

Parameters

caloHitMetadata

description of the changes made by daughter reclustering processes

Definition at line 102 of file Metadata.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Update() [2/2]

StatusCode pandora::CaloHitMetadata::Update

(

const CaloHitReplacement &

caloHitReplacement

)

Update metadata to account for a specific calo hit replacement.

Parameters

caloHitReplacement

the calo hit replacement

Definition at line 132 of file Metadata.cc.

Member Data Documentation

m_caloHitListName

std::string pandora::CaloHitMetadata::m_caloHitListName

private

The name of the associated calo hit list.

Definition at line 109 of file Metadata.h.

m_caloHitReplacementList

CaloHitReplacementList pandora::CaloHitMetadata::m_caloHitReplacementList

private

The calo hit replacement list.

Definition at line 111 of file Metadata.h.

m_caloHitUsageMap

CaloHitUsageMap pandora::CaloHitMetadata::m_caloHitUsageMap

private

The calo hit usage map.

Definition at line 110 of file Metadata.h.

m_pCaloHitList

CaloHitList* pandora::CaloHitMetadata::m_pCaloHitList

private

Address of the associated calo hit list.

Definition at line 108 of file Metadata.h.

---

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

• PandoraSDK/include/Managers/Metadata.h
• PandoraSDK/src/Managers/Metadata.cc