Calo hit lists arranged by pseudo layer. More...

#include "OrderedCaloHitList.h"

Public Types
typedef std::map< unsigned int, CaloHitList * >	TheList

typedef TheList::value_type	value_type

typedef TheList::const_iterator	const_iterator

typedef TheList::const_reverse_iterator	const_reverse_iterator

Public Member Functions
	OrderedCaloHitList ()
	Default constructor.

	OrderedCaloHitList (const OrderedCaloHitList &rhs)
	Copy constructor.

	~OrderedCaloHitList ()
	Destructor.

StatusCode	Add (const OrderedCaloHitList &rhs)
	Add the hits from a second ordered calo hit list to this list.

StatusCode	Remove (const OrderedCaloHitList &rhs)
	Remove the hits in a second ordered calo hit list from this list.

StatusCode	Add (const CaloHitList &caloHitList)
	Add a list of calo hits to the ordered calo hit list.

StatusCode	Remove (const CaloHitList &caloHitList)
	Remove a list of calo hits from the ordered calo hit list.

StatusCode	Add (const CaloHit *const pCaloHit)
	Add a calo hit to the ordered calo hit list.

StatusCode	Remove (const CaloHit *const pCaloHit)
	Remove a calo hit from the ordered calo hit list.

StatusCode	GetCaloHitsInPseudoLayer (const unsigned int pseudoLayer, CaloHitList *&pCaloHitList) const
	Get calo hits in specified pseudo layer.

unsigned int	GetNCaloHitsInPseudoLayer (const unsigned int pseudoLayer) const
	Get the number of calo hits in a specified pseudo layer.

void	Reset ()
	Reset the ordered calo hit list, emptying its contents.

void	FillCaloHitList (CaloHitList &caloHitList) const
	Fill a provided calo hit list with all the calo hits in the ordered calo hit list.

const_iterator	begin () const
	Returns a const iterator referring to the first element in the ordered calo hit list.

const_iterator	end () const
	Returns a const iterator referring to the past-the-end element in the ordered calo hit list.

const_reverse_iterator	rbegin () const
	Returns a const reverse iterator referring to the first element in the ordered calo hit list.

const_reverse_iterator	rend () const
	Returns a const reverse iterator referring to the past-the-end element in the ordered calo hit list.

const_iterator	find (const unsigned int index) const
	Searches the container for an element with specified layer and returns an iterator to it if found, otherwise it returns an iterator to the past-the-end element.

unsigned int	size () const
	Returns the number of elements in the container.

bool	empty () const
	Returns whether the map container is empty (i.e. whether its size is 0)

bool	operator= (const OrderedCaloHitList &rhs)
	Assignment operator.

Private Member Functions
void	clear ()
	Clear the ordered calo hit list.

StatusCode	Add (const CaloHit *const pCaloHit, const unsigned int pseudoLayer)
	Add a calo hit to a specified pseudo layer.

StatusCode	Remove (const CaloHit *const pCaloHit, const unsigned int pseudoLayer)
	Remove a calo hit from a specified pseudo layer.

Private Attributes
TheList	m_theList
	The ordered calo hit list.

Detailed Description

Calo hit lists arranged by pseudo layer.

Definition at line 24 of file OrderedCaloHitList.h.

Member Typedef Documentation

◆ const_iterator

typedef TheList::const_iterator pandora::OrderedCaloHitList::const_iterator

Definition at line 29 of file OrderedCaloHitList.h.

◆ const_reverse_iterator

typedef TheList::const_reverse_iterator pandora::OrderedCaloHitList::const_reverse_iterator

Definition at line 30 of file OrderedCaloHitList.h.

◆ TheList

typedef std::map<unsigned int, CaloHitList *> pandora::OrderedCaloHitList::TheList

Definition at line 27 of file OrderedCaloHitList.h.

◆ value_type

typedef TheList::value_type pandora::OrderedCaloHitList::value_type

Definition at line 28 of file OrderedCaloHitList.h.

Constructor & Destructor Documentation

◆ OrderedCaloHitList() [1/2]

pandora::OrderedCaloHitList::OrderedCaloHitList ( )

Default constructor.

Definition at line 17 of file OrderedCaloHitList.cc.

◆ OrderedCaloHitList() [2/2]

pandora::OrderedCaloHitList::OrderedCaloHitList ( const OrderedCaloHitList & rhs )

Copy constructor.

Parameters

rhs	the ordered calo hit list to copy

Definition at line 23 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

◆ ~OrderedCaloHitList()

pandora::OrderedCaloHitList::~OrderedCaloHitList ( )

Destructor.

Definition at line 30 of file OrderedCaloHitList.cc.

Member Function Documentation

◆ Add() [1/4]

StatusCode pandora::OrderedCaloHitList::Add ( const CaloHit *const pCaloHit )

inline

Add a calo hit to the ordered calo hit list.

Parameters

pCaloHit the address of the calo hit

Definition at line 238 of file OrderedCaloHitList.h.

Here is the call graph for this function:

◆ Add() [2/4]

StatusCode pandora::OrderedCaloHitList::Add	(	const CaloHit *const	pCaloHit,
		const unsigned int	pseudoLayer
	)

private

Add a calo hit to a specified pseudo layer.

Parameters

pCaloHit	the address of the calo hit
pseudoLayer	the pesudo layer

Definition at line 154 of file OrderedCaloHitList.cc.

◆ Add() [3/4]

StatusCode pandora::OrderedCaloHitList::Add ( const CaloHitList & caloHitList )

Add a list of calo hits to the ordered calo hit list.

Parameters

caloHitList the calo hit list

Definition at line 68 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

◆ Add() [4/4]

StatusCode pandora::OrderedCaloHitList::Add ( const OrderedCaloHitList & rhs )

Add the hits from a second ordered calo hit list to this list.

Parameters

rhs	the source ordered calo hit list

Definition at line 38 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ begin()

OrderedCaloHitList::const_iterator pandora::OrderedCaloHitList::begin ( ) const

inline

Returns a const iterator referring to the first element in the ordered calo hit list.

Definition at line 190 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ clear()

void pandora::OrderedCaloHitList::clear ( )

inlineprivate

Clear the ordered calo hit list.

Definition at line 252 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ empty()

bool pandora::OrderedCaloHitList::empty ( ) const

inline

Returns whether the map container is empty (i.e. whether its size is 0)

Definition at line 231 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ end()

OrderedCaloHitList::const_iterator pandora::OrderedCaloHitList::end ( ) const

inline

Returns a const iterator referring to the past-the-end element in the ordered calo hit list.

Definition at line 197 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ FillCaloHitList()

void pandora::OrderedCaloHitList::FillCaloHitList ( CaloHitList & caloHitList ) const

Fill a provided calo hit list with all the calo hits in the ordered calo hit list.

Parameters

caloHitList to receive the list of calo hits

Definition at line 131 of file OrderedCaloHitList.cc.

Here is the caller graph for this function:

◆ find()

OrderedCaloHitList::const_iterator pandora::OrderedCaloHitList::find ( const unsigned int index ) const

inline

Searches the container for an element with specified layer and returns an iterator to it if found, otherwise it returns an iterator to the past-the-end element.

Definition at line 204 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ GetCaloHitsInPseudoLayer()

StatusCode pandora::OrderedCaloHitList::GetCaloHitsInPseudoLayer	(	const unsigned int	pseudoLayer,
		CaloHitList *&	pCaloHitList
	)		const

Get calo hits in specified pseudo layer.

Parameters

pseudoLayer	the pseudo layer
pCaloHitList	to receive the address of the relevant calo hit list

Definition at line 92 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNCaloHitsInPseudoLayer()

unsigned int pandora::OrderedCaloHitList::GetNCaloHitsInPseudoLayer ( const unsigned int pseudoLayer ) const

Get the number of calo hits in a specified pseudo layer.

Parameters

pseudoLayer the pseudo layer

Returns: The number of calo hits in the specified pseudo layer

Definition at line 106 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

◆ operator=()

bool pandora::OrderedCaloHitList::operator= ( const OrderedCaloHitList & rhs )

Assignment operator.

Parameters

rhs	the ordered calo hit list to assign

Definition at line 141 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

◆ rbegin()

OrderedCaloHitList::const_reverse_iterator pandora::OrderedCaloHitList::rbegin ( ) const

inline

Returns a const reverse iterator referring to the first element in the ordered calo hit list.

Definition at line 211 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ Remove() [1/4]

StatusCode pandora::OrderedCaloHitList::Remove ( const CaloHit *const pCaloHit )

inline

Remove a calo hit from the ordered calo hit list.

Parameters

pCaloHit the address of the calo hit

Definition at line 245 of file OrderedCaloHitList.h.

Here is the call graph for this function:

◆ Remove() [2/4]

StatusCode pandora::OrderedCaloHitList::Remove	(	const CaloHit *const	pCaloHit,
		const unsigned int	pseudoLayer
	)

private

Remove a calo hit from a specified pseudo layer.

Parameters

pCaloHit	the address of the calo hit
pseudoLayer	the pesudo layer

Definition at line 182 of file OrderedCaloHitList.cc.

◆ Remove() [3/4]

StatusCode pandora::OrderedCaloHitList::Remove ( const CaloHitList & caloHitList )

Remove a list of calo hits from the ordered calo hit list.

Parameters

caloHitList the calo hit list

Definition at line 80 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

◆ Remove() [4/4]

StatusCode pandora::OrderedCaloHitList::Remove ( const OrderedCaloHitList & rhs )

Remove the hits in a second ordered calo hit list from this list.

Parameters

rhs	the source ordered calo hit list

Definition at line 53 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rend()

OrderedCaloHitList::const_reverse_iterator pandora::OrderedCaloHitList::rend ( ) const

inline

Returns a const reverse iterator referring to the past-the-end element in the ordered calo hit list.

Definition at line 218 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

◆ Reset()

void pandora::OrderedCaloHitList::Reset ( )

Reset the ordered calo hit list, emptying its contents.

Definition at line 118 of file OrderedCaloHitList.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

unsigned int pandora::OrderedCaloHitList::size ( ) const

inline

Returns the number of elements in the container.

Definition at line 224 of file OrderedCaloHitList.h.

Here is the caller graph for this function:

Member Data Documentation

◆ m_theList

TheList pandora::OrderedCaloHitList::m_theList

private

The ordered calo hit list.

Definition at line 185 of file OrderedCaloHitList.h.

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

PandoraSDK/include/Objects/OrderedCaloHitList.h
PandoraSDK/src/Objects/OrderedCaloHitList.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ TheList

◆ value_type

Constructor & Destructor Documentation

◆ OrderedCaloHitList() [1/2]

◆ OrderedCaloHitList() [2/2]

◆ ~OrderedCaloHitList()

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ begin()

◆ clear()

◆ empty()

◆ end()

◆ FillCaloHitList()

◆ find()

◆ GetCaloHitsInPseudoLayer()

◆ GetNCaloHitsInPseudoLayer()

◆ operator=()

◆ rbegin()

◆ Remove() [1/4]

◆ Remove() [2/4]

◆ Remove() [3/4]

◆ Remove() [4/4]

◆ rend()

◆ Reset()

◆ size()

Member Data Documentation

◆ m_theList