april_content::Branch Class Reference

Branch class. More...

#include <Branch.h>

Public Types
typedef std::vector< const CaloHit * >	List
typedef List::value_type	value_type
typedef List::iterator	iterator
typedef List::const_iterator	const_iterator
typedef List::reverse_iterator	reverse_iterator
typedef List::const_reverse_iterator	const_reverse_iterator

Public Member Functions
	Branch ()
	Default constructor.
	Branch (const_iterator first, const_iterator last)
	Constructor with iterators on a branch. More...
	Branch (const Branch &branch)
	Copy constructor.
virtual	~Branch ()
	Destructor.
pandora::StatusCode	BuildFromCaloHit (const CaloHit *const pCaloHit)
	Build-up a branch from the calo hit by looking a UNIQUE backward connection. Stops when no connection is found. More...
iterator	begin ()
	Returns an begin iterator on branch.
const_iterator	begin () const
	Returns an begin iterator on branch.
iterator	end ()
	Returns an end iterator on branch.
const_iterator	end () const
	Returns an end iterator on branch.
reverse_iterator	rbegin ()
	Returns a begin reverse iterator on branch.
const_reverse_iterator	rbegin () const
	Returns a begin reverse iterator on branch.
reverse_iterator	rend ()
	Returns an end reverse iterator on branch.
const_reverse_iterator	rend () const
	Returns an end reverse iterator on branch.
void	clear ()
	Clear the branch content.
size_t	size () const
	Returns the size of the branch (n calo hits)
pandora::StatusCode	push_back (const CaloHit *const pCaloHit)
	Add a calo hit to the branch (outermost calo hit). A check is performed to test whether the calo hit is connected with the last calo hit. More...
pandora::StatusCode	push_front (const CaloHit *const pCaloHit)
	Add a calo hit to the branch (innermost calo hit). A check is performed to test whether the calo hit is connected with the first calo hit. More...
pandora::StatusCode	Cut (iterator position, bool keepForwardPart=true)
	Cut the branch and keep only a part of the branch including the calo hit of the iterator. More...
bool	IsValid () const
	Whether the branch is still valid in terms of connected calo hits. Returns true if the structure still follow a branch structure and false if the branch structure is broken (some connections removed)
Branch &	operator= (const Branch &branch)
	Assignment operator.

Private Attributes
std::vector< const CaloHit * >	m_caloHitList

Detailed Description

Branch class.

Constructor & Destructor Documentation

april_content::Branch::Branch	(	const_iterator	first,
		const_iterator	last
	)

Constructor with iterators on a branch.

Parameters

first	the starting iterator of the branch
last	the ending iterator of the branch

Member Function Documentation

pandora::StatusCode april_content::Branch::BuildFromCaloHit

(

const CaloHit *const

pCaloHit

)

Build-up a branch from the calo hit by looking a UNIQUE backward connection. Stops when no connection is found.

Parameters

pCaloHit

the calo hit to start with

pandora::StatusCode april_content::Branch::Cut	(	iterator	position,
		bool	keepForwardPart = true
	)

Cut the branch and keep only a part of the branch including the calo hit of the iterator.

Parameters

position	an iterator pointing on the calo hit from/to which the branch has to be cut
keepForwardPart	whether to keep the forward part of the branch

pandora::StatusCode april_content::Branch::push_back

(

const CaloHit *const

pCaloHit

)

Add a calo hit to the branch (outermost calo hit). A check is performed to test whether the calo hit is connected with the last calo hit.

Parameters

pCaloHit

the calo hit to add

pandora::StatusCode april_content::Branch::push_front

(

const CaloHit *const

pCaloHit

)

Add a calo hit to the branch (innermost calo hit). A check is performed to test whether the calo hit is connected with the first calo hit.

Parameters

pCaloHit

the calo hit to add

---

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

• APRILContent/include/APRILObjects/Branch.h
• APRILContent/src/APRILObjects/Branch.cc