QuadTreeItem< AData > Class Template Reference

This class serves as a wrapper around all things that should go into a QuadTree. More...

#include <QuadTreeItem.h>

Public Member Functions
	QuadTreeItem (AData *data)
	Constructor.
AData *	getPointer () const
	Returns the underlying data.
bool	isUsed () const
	Flag is set if the item was used as a result of the quad tree search and should not be used in the next quad tree search round.
void	setUsedFlag (bool usedFlag=true)
	Set the used flag if you do not want that item to go into the next search round again.
void	unsetUsedFlag ()
	Unset the used flag again if you have noticed that a previous setting was wrong.
bool	isUsed () const
	As special case: the QuadTreeHitWrapper has a used flag itself.
void	setUsedFlag (bool usedFlag)
	As special case: the QuadTreeHitWrapper has a used flag itself.
bool	isUsed () const
	As special case: the CDCSegment2D has a used flag itself.
void	setUsedFlag (bool usedFlag)
	As special case: the CDCSegment2D has a used flag itself.

Private Member Functions
	QuadTreeItem (const QuadTreeItem &copy)=delete
	Do not copy!
QuadTreeItem &	operator= (QuadTreeItem const &copy)=delete
	Do not copy!

Private Attributes
AData *	m_data
	A pointer to the underlying item data.
bool	m_usedFlag
	This flag can be set to not use the item in the next quad tree search round.

Detailed Description

template<class AData>
class Belle2::TrackFindingCDC::QuadTreeItem< AData >

This class serves as a wrapper around all things that should go into a QuadTree.

For usage in the QuadTree we need to provide a used flag. If your AData-class does provide a used flag itself, just spezialize this template as done for the CDCWireHit and CDCSegment2D below.

Definition at line 27 of file QuadTreeItem.h.

Constructor & Destructor Documentation

QuadTreeItem()

template<class AData>

QuadTreeItem ( AData * data )

inlineexplicit

Constructor.

Definition at line 30 of file QuadTreeItem.h.

        : m_data(data)
        , m_usedFlag(false) {};

Member Function Documentation

getPointer()

template<class AData>

AData * getPointer ( ) const

inline

Returns the underlying data.

Definition at line 43 of file QuadTreeItem.h.

      {
        return m_data;
      }

isUsed() [1/3]

template<class AData>

bool isUsed ( ) const

inline

Flag is set if the item was used as a result of the quad tree search and should not be used in the next quad tree search round.

Definition at line 52 of file QuadTreeItem.h.

      {
        return m_usedFlag;
      }

isUsed() [2/3]

bool isUsed ( ) const

inline

As special case: the QuadTreeHitWrapper has a used flag itself.

Defined here rather than in the source file because the quad tree search asks for the used flag of an item millions of times per event.

Definition at line 84 of file QuadTreeItem.h.

    {
      return (*getPointer())->hasTakenFlag() or (*getPointer())->hasMaskedFlag();
    }

isUsed() [3/3]

bool isUsed ( ) const

inline

As special case: the CDCSegment2D has a used flag itself.

Definition at line 102 of file QuadTreeItem.h.

    {
      return getPointer()->getAutomatonCell().hasTakenFlag();
    }

setUsedFlag() [1/3]

void setUsedFlag ( bool usedFlag )

inline

As special case: the QuadTreeHitWrapper has a used flag itself.

Definition at line 93 of file QuadTreeItem.h.

    {
      (*getPointer())->setTakenFlag(usedFlag);
    }

setUsedFlag() [2/3]

void setUsedFlag ( bool usedFlag )

inline

As special case: the CDCSegment2D has a used flag itself.

Definition at line 111 of file QuadTreeItem.h.

    {
      getPointer()->getAutomatonCell().setTakenFlag(usedFlag);
    }

setUsedFlag() [3/3]

template<class AData>

void setUsedFlag ( bool usedFlag = true )

inline

Set the used flag if you do not want that item to go into the next search round again.

Definition at line 58 of file QuadTreeItem.h.

      {
        m_usedFlag = usedFlag;
      }

unsetUsedFlag()

template<class AData>

void unsetUsedFlag ( )

inline

Unset the used flag again if you have noticed that a previous setting was wrong.

Definition at line 64 of file QuadTreeItem.h.

      {
        setUsedFlag(false);
      }

Member Data Documentation

m_data

template<class AData>

AData* m_data

private

A pointer to the underlying item data.

Definition at line 71 of file QuadTreeItem.h.

m_usedFlag

template<class AData>

bool m_usedFlag

private

This flag can be set to not use the item in the next quad tree search round.

Definition at line 74 of file QuadTreeItem.h.

---

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

• tracking/trackFindingCDC/legendre/quadtree/include/QuadTreeItem.h