CaloClusterNavigable Class Reference

Navigable part of CaloCluster, use CaloCellLink. More...

#include <CaloClusterNavigable.h>

Inheritance diagram for CaloClusterNavigable:

Collaboration diagram for CaloClusterNavigable:

Public Types
typedef CaloCellLink::cell_iterator	object_iter
	external cell iterator type
typedef CaloClusterLinkTemplate< CaloCellLinkContainer >::link_type	cell_link_type

Public Member Functions
	CaloClusterNavigable ()
	default constructor
	CaloClusterNavigable (CaloCellLinkContainer *pLinkCont, CaloCellLink *pLink)
	constructor
	CaloClusterNavigable (CaloCellLink *pLink)
	constructor
virtual	~CaloClusterNavigable ()
	destructor
void	putElement (const CaloCellContainer *pContainer, const CaloCell *pCell, const double &weight=double(1.))
	add element to the Navigable: use pointer
void	putElement (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	add element to the Navigable: use element index (direct access!)
void	insertElement (const CaloCellContainer *pContainer, const CaloCell *pCell, const double &weight=double(1.))
	insert element without checking if already in store: use element pointer
void	insertElement (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	insert element without checking if already in store: use index
void	insertElement (const CaloCellContainer *pContainer, size_t iCell, const double weight, size_t size_hint)
	same, with a size hint.
void	insertElement (const ElementLink< CaloCellContainer > &el, const double weight, size_t size_hint=0)
	Insert element via ElementLink.
void	reweight (const CaloCell *pCell, const double &weight=double(1.))
	re-weight (overwrite old weight)
void	reweight (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	re-weight (overwrite old weight)
void	reweight (object_iter &cellIter, const double &weight=double(1.))
	re-weight (overwrite old weight)
bool	remove (const CaloCell *pCell)
	remove object from the Navigable
bool	remove (const CaloCellContainer *pContainer, size_t &iCell)
	remove object from the Navigable
bool	removeAll ()
	remove all objects from the Navigable
bool	contains (const CaloCell *pCell) const
	check if constituent is already there
bool	contains (const CaloCellContainer *pContainer, size_t &iCell) const
	check if constituent is already there
virtual object_iter	begin () const
	begin iterator for public object access
virtual object_iter	end () const
	end iterator for public object access
virtual unsigned int	nCells () const
	size of object access
double	getParameter (const CaloCell *pCell) const
	public container access: relational parameter retrieval
double	getParameter (const CaloCellContainer *pContainer, size_t &iCell) const
	public container access: relational parameter retrieval
double	getParameter (object_iter &cellIter) const
	public container access: relational parameter retrieval
const CaloCellContainer *	getContainer (const CaloCell *pCell) const
	public container access: retrieve Container for given object pointer
const CaloCellContainer *	getContainer (object_iter cellIter) const
	public container access: retrieve Container for given object iterator
bool	getIndex (const CaloCell *pCell, size_t &iCell) const
	get index of child in original container, given a pointer
bool	getIndex (object_iter cellIter, size_t &iCell) const
	get index of child in original container, given an iterator
virtual void	fillToken (INavigationToken &iToken) const
	fill token for navigation
virtual void	fillToken (INavigationToken &iToken, const std::any &rPar) const
	fill token for navigation
virtual bool	isCellLinkValid () const
const cell_link_type &	cellLink () const
	Access to underlying link.
void	resetCellLink (const cell_link_type &cellLink)

Protected Member Functions
CaloCellLink *	getCellLink ()
const CaloCellLink *	getCellLink () const
bool	setCellLink (CaloCellLinkContainer *pLink)
bool	setLinkStore (CaloCellLink *pLink, bool ownStores=true)
CaloCellLink *	getCellLinkPtr ()
const CaloCellLink *	getCellLinkPtr () const

Protected Attributes
bool	m_ownLinkStore

Private Attributes
cell_link_type	m_cellLink
	Local pointer to cell store.

Friends
class	CaloClusterStoreHelper
class	CaloClusterContainerCnv_p2
class	CaloClusterContainerCnv_p3
class	CaloClusterContainerCnv_p4
class	CaloClusterContainerCnv_p5
class	CaloClusterContainerCnv_p6
class	CaloClusterContainerCnv_p7
class	CaloClusterContainerCnvTestMakeCluster

Detailed Description

Navigable part of CaloCluster, use CaloCellLink.

Author

Peter Loch

Definition at line 33 of file CaloClusterNavigable.h.

Member Typedef Documentation

cell_link_type

typedef CaloClusterLinkTemplate<CaloCellLinkContainer>::link_type CaloClusterNavigable::cell_link_type

Definition at line 146 of file CaloClusterNavigable.h.

object_iter

typedef CaloCellLink::cell_iterator CaloClusterNavigable::object_iter

external cell iterator type

Definition at line 51 of file CaloClusterNavigable.h.

Constructor & Destructor Documentation

CaloClusterNavigable() [1/3]

CaloClusterNavigable::CaloClusterNavigable

(

)

default constructor

Definition at line 15 of file CaloClusterNavigable.cxx.

  : m_ownLinkStore(false)
{ }

CaloClusterNavigable() [2/3]

CaloClusterNavigable::CaloClusterNavigable	(	CaloCellLinkContainer *	pLinkCont,
		CaloCellLink *	pLink )

constructor

Definition at line 19 of file CaloClusterNavigable.cxx.

  : m_ownLinkStore(false)
{
  CaloClusterLinkTemplate<CaloCellLinkContainer>::setLink(pLinkColl,
                              pLink,
                              m_cellLink);
}

CaloClusterNavigable() [3/3]

CaloClusterNavigable::CaloClusterNavigable

(

CaloCellLink *

pLink

)

constructor

Definition at line 28 of file CaloClusterNavigable.cxx.

  : m_ownLinkStore(true)
{
  m_cellLink.setElement(pLink);
}

~CaloClusterNavigable()

CaloClusterNavigable::~CaloClusterNavigable ( )

virtual

destructor

Definition at line 34 of file CaloClusterNavigable.cxx.

{ 
  // If we own the store, the link holds the pointer directly.
  if ( m_ownLinkStore ) delete m_cellLink.cachedElement();
}

Member Function Documentation

begin()

CaloClusterNavigable::object_iter CaloClusterNavigable::begin ( ) const

inlinevirtual

begin iterator for public object access

Definition at line 303 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->begin();
}

cellLink()

const cell_link_type & CaloClusterNavigable::cellLink ( ) const

inline

Access to underlying link.

Definition at line 149 of file CaloClusterNavigable.h.

{ return m_cellLink; }

contains() [1/2]

bool CaloClusterNavigable::contains ( const CaloCell * pCell ) const

inline

check if constituent is already there

Definition at line 290 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->contains(pCell);
}

contains() [2/2]

bool CaloClusterNavigable::contains ( const CaloCellContainer * pContainer, size_t & iCell ) const

inline

check if constituent is already there

Definition at line 296 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->contains(pContainer,iCell);
}

end()

CaloClusterNavigable::object_iter CaloClusterNavigable::end ( ) const

inlinevirtual

end iterator for public object access

Definition at line 309 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->end();
}

fillToken() [1/2]

void CaloClusterNavigable::fillToken ( INavigationToken & iToken ) const

inlinevirtual

fill token for navigation

Implements INavigable.

Definition at line 390 of file CaloClusterNavigable.h.

{
  if ( this->getCellLink() )
    (this->getCellLink())->fillToken(iToken);
}

fillToken() [2/2]

void CaloClusterNavigable::fillToken ( INavigationToken & iToken, const std::any & rPar ) const

inlinevirtual

fill token for navigation

Implements INavigable.

Definition at line 397 of file CaloClusterNavigable.h.

{
  if ( this->getCellLink() )
    (this->getCellLink())->fillToken(iToken,rPar);
}

getCellLink() [1/2]

CaloCellLink * CaloClusterNavigable::getCellLink ( )

protected

Definition at line 40 of file CaloClusterNavigable.cxx.

{
  if ( m_ownLinkStore )
    {
      if ( *m_cellLink == nullptr ) m_cellLink.setElement(new CaloCellLink());
      // Ok, because this happens only if we own the pointer.
      CaloCellLink* link ATLAS_THREAD_SAFE = const_cast<CaloCellLink*>(*m_cellLink);
      return link;
    }
  else
    {
      return (CaloCellLink*)nullptr;
    }
 
  // check if local pointer to store
  //  if ( m_cellLinkPointer != 0 ) { return m_cellLinkPointer;}
  // check if linked pointer to store
  //  if ( m_cellLink.isValid() && *m_cellLink != 0 ) 
  //    { 
      // FIXME
  //     CaloCellLink* pLink = const_cast<CaloCellLink*>(*m_cellLink);
  //      return pLink; 
  //    }
  // create a new local store/
  //  m_cellLinkPointer = new CaloCellLink();
  //  return m_cellLinkPointer;
}

getCellLink() [2/2]

const CaloCellLink * CaloClusterNavigable::getCellLink ( ) const

protected

Definition at line 69 of file CaloClusterNavigable.cxx.

{
  // return *m_cellLink;
 
  //  if ( m_cellLinkPointer != 0 )
  //  {
      //      std::cout << "[CaloClusterNavigable@" << this << "] return "
      //        << "cell link @" << m_cellLinkPointer << std::endl;
      //      return m_cellLinkPointer;
      //    } 
  //  if ( *m_cellLink == 0 )
  //    {
  //      std::cout << "[CaloClusterNavigable@" << this << "] problem with "
  //        << "cell link store, unexpected pointer = "
  //        << *m_cellLink << std::endl;
  //    }
  return m_cellLink.isValid() ? *m_cellLink : nullptr;
}

getCellLinkPtr() [1/2]

CaloCellLink * CaloClusterNavigable::getCellLinkPtr ( )

inlineprotected

Definition at line 426 of file CaloClusterNavigable.h.

{ 
  CaloCellLink* ret;
  if (m_cellLink.isValid())
    ret = const_cast<CaloCellLink*>(*m_cellLink); 
  else
    ret = 0;
  return ret;
 
}

getCellLinkPtr() [2/2]

const CaloCellLink * CaloClusterNavigable::getCellLinkPtr ( ) const

inlineprotected

Definition at line 438 of file CaloClusterNavigable.h.

                                           { 
  const CaloCellLink* ret;
  if (m_cellLink.isValid())
    ret = *m_cellLink; 
  else
    ret = 0;
  return ret;
}

getContainer() [1/2]

const CaloCellContainer * CaloClusterNavigable::getContainer ( const CaloCell * pCell ) const

inline

public container access: retrieve Container for given object pointer

Definition at line 347 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getContainer(pCell);
}

getContainer() [2/2]

const CaloCellContainer * CaloClusterNavigable::getContainer ( object_iter cellIter ) const

inline

public container access: retrieve Container for given object iterator

Definition at line 354 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getContainer(cellIter);
}

getIndex() [1/2]

bool CaloClusterNavigable::getIndex ( const CaloCell * pCell, size_t & iCell ) const

inline

get index of child in original container, given a pointer

Definition at line 360 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getIndex(pCell,iCell);
}

getIndex() [2/2]

bool CaloClusterNavigable::getIndex ( object_iter cellIter, size_t & iCell ) const

inline

get index of child in original container, given an iterator

Definition at line 366 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getIndex(cellIter,iCell);
}

getParameter() [1/3]

double CaloClusterNavigable::getParameter ( const CaloCell * pCell ) const

inline

public container access: relational parameter retrieval

Definition at line 327 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(pCell);
}

getParameter() [2/3]

double CaloClusterNavigable::getParameter ( const CaloCellContainer * pContainer, size_t & iCell ) const

inline

public container access: relational parameter retrieval

Definition at line 333 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(pContainer,iCell);
}

getParameter() [3/3]

double CaloClusterNavigable::getParameter ( object_iter & cellIter ) const

inline

public container access: relational parameter retrieval

Definition at line 340 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(cellIter);
}

insertElement() [1/4]

void CaloClusterNavigable::insertElement ( const CaloCellContainer * pContainer, const CaloCell * pCell, const double & weight = double(1.) )

inline

insert element without checking if already in store: use element pointer

Definition at line 217 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,pCell,weight);
}

insertElement() [2/4]

void CaloClusterNavigable::insertElement ( const CaloCellContainer * pContainer, size_t & iCell, const double & weight = double(1.) )

inline

insert element without checking if already in store: use index

Definition at line 225 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,iCell,weight);
}

insertElement() [3/4]

void CaloClusterNavigable::insertElement ( const CaloCellContainer * pContainer, size_t iCell, const double weight, size_t size_hint )

inline

same, with a size hint.

Definition at line 233 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,iCell,weight,size_hint);
}

insertElement() [4/4]

void CaloClusterNavigable::insertElement ( const ElementLink< CaloCellContainer > & el, const double weight, size_t size_hint = 0 )

inline

Insert element via ElementLink.

Definition at line 243 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(el,weight,size_hint);
}

isCellLinkValid()

bool CaloClusterNavigable::isCellLinkValid ( ) const

inlinevirtual

Definition at line 449 of file CaloClusterNavigable.h.

{
  return this->getCellLinkPtr() !=0;
}

nCells()

unsigned int CaloClusterNavigable::nCells ( ) const

inlinevirtual

size of object access

Definition at line 315 of file CaloClusterNavigable.h.

{
 
  const CaloCellLink* link = this->getCellLinkPtr();
  if (link) 
    return link->size();
  else
    return 0; 
 
}

putElement() [1/2]

void CaloClusterNavigable::putElement ( const CaloCellContainer * pContainer, const CaloCell * pCell, const double & weight = double(1.) )

inline

add element to the Navigable: use pointer

Definition at line 201 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->putElement(pContainer,pCell,weight);
}

putElement() [2/2]

void CaloClusterNavigable::putElement ( const CaloCellContainer * pContainer, size_t & iCell, const double & weight = double(1.) )

inline

add element to the Navigable: use element index (direct access!)

Definition at line 209 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->putElement(pContainer,iCell,weight);
}

remove() [1/2]

bool CaloClusterNavigable::remove ( const CaloCell * pCell )

inline

remove object from the Navigable

Definition at line 271 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->remove(pCell);
}

remove() [2/2]

bool CaloClusterNavigable::remove ( const CaloCellContainer * pContainer, size_t & iCell )

inline

remove object from the Navigable

Definition at line 277 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->remove(pContainer,iCell);
}

removeAll()

bool CaloClusterNavigable::removeAll ( )

inline

remove all objects from the Navigable

Definition at line 284 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->removeAll();
}

resetCellLink()

void CaloClusterNavigable::resetCellLink ( const cell_link_type & cellLink )

inline

Definition at line 151 of file CaloClusterNavigable.h.

  {
    m_cellLink = cellLink;
  }

reweight() [1/3]

void CaloClusterNavigable::reweight ( const CaloCell * pCell, const double & weight = double(1.) )

inline

re-weight (overwrite old weight)

Definition at line 251 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(pCell,weight);
}

reweight() [2/3]

void CaloClusterNavigable::reweight ( const CaloCellContainer * pContainer, size_t & iCell, const double & weight = double(1.) )

inline

re-weight (overwrite old weight)

Definition at line 257 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(pContainer,iCell,weight);
}

reweight() [3/3]

void CaloClusterNavigable::reweight ( object_iter & cellIter, const double & weight = double(1.) )

inline

re-weight (overwrite old weight)

Definition at line 265 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(cellIter,weight);
}

setCellLink()

bool CaloClusterNavigable::setCellLink ( CaloCellLinkContainer * pLink )

inlineprotected

Definition at line 405 of file CaloClusterNavigable.h.

{
  if (!pLinkStore) 
    return false;
 
  CaloCellLink* pLink = *m_cellLink != 0 
    ? const_cast<CaloCellLink*>(*m_cellLink) : (CaloCellLink*)0;
 
  m_ownLinkStore = !pLinkStore->ownElements();
  return CaloClusterLinkTemplate<CaloCellLinkContainer>::setLink(pLinkStore,
                                 pLink,
                                 m_cellLink);
}

setLinkStore()

bool CaloClusterNavigable::setLinkStore ( CaloCellLink * pLink, bool ownStores = true )

inlineprotected

Definition at line 191 of file CaloClusterNavigable.h.

{
  m_cellLink.setElement(pLink);
  m_ownLinkStore = ownStores;
  //  m_cellLinkPointer = pLink;
  return *m_cellLink != 0;
}

Friends And Related Symbol Documentation

CaloClusterContainerCnv_p2

friend class CaloClusterContainerCnv_p2

friend

Definition at line 160 of file CaloClusterNavigable.h.

CaloClusterContainerCnv_p3

friend class CaloClusterContainerCnv_p3

friend

Definition at line 161 of file CaloClusterNavigable.h.

CaloClusterContainerCnv_p4

friend class CaloClusterContainerCnv_p4

friend

Definition at line 162 of file CaloClusterNavigable.h.

CaloClusterContainerCnv_p5

friend class CaloClusterContainerCnv_p5

friend

Definition at line 163 of file CaloClusterNavigable.h.

CaloClusterContainerCnv_p6

friend class CaloClusterContainerCnv_p6

friend

Definition at line 164 of file CaloClusterNavigable.h.

CaloClusterContainerCnv_p7

friend class CaloClusterContainerCnv_p7

friend

Definition at line 165 of file CaloClusterNavigable.h.

CaloClusterContainerCnvTestMakeCluster

friend class CaloClusterContainerCnvTestMakeCluster

friend

Definition at line 166 of file CaloClusterNavigable.h.

CaloClusterStoreHelper

friend class CaloClusterStoreHelper

friend

Definition at line 159 of file CaloClusterNavigable.h.

Member Data Documentation

m_cellLink

cell_link_type CaloClusterNavigable::m_cellLink

private

Local pointer to cell store.

Link to cell links object

Definition at line 186 of file CaloClusterNavigable.h.

m_ownLinkStore

bool CaloClusterNavigable::m_ownLinkStore

protected

Definition at line 178 of file CaloClusterNavigable.h.

---

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

• CaloClusterNavigable.h
• CaloClusterNavigable.cxx