LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_content::OverlapMatrix< T >::Element Class Reference

Element class. More...

#include "LArOverlapMatrix.h"

Public Member Functions

 Element (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2, const OverlapResult &overlapResult)
 Constructor. More...
 
const pandora::Cluster * GetCluster1 () const
 Get the address of cluster 1. More...
 
const pandora::Cluster * GetCluster2 () const
 Get the address of cluster 2. More...
 
const OverlapResultGetOverlapResult () const
 Get the overlap result. More...
 
bool operator< (const Element &rhs) const
 Element less than operator. More...
 

Private Attributes

const pandora::Cluster * m_pCluster1
 The address of cluster 1. More...
 
const pandora::Cluster * m_pCluster2
 The address of cluster 2. More...
 
OverlapResult m_overlapResult
 The overlap result. More...
 

Detailed Description

template<typename T>
class lar_content::OverlapMatrix< T >::Element

Element class.

Definition at line 31 of file LArOverlapMatrix.h.

Constructor & Destructor Documentation

template<typename T >
lar_content::OverlapMatrix< T >::Element::Element ( const pandora::Cluster *const  pCluster1,
const pandora::Cluster *const  pCluster2,
const OverlapResult overlapResult 
)
inline

Constructor.

Parameters
pCluster1the address of cluster 1
pCluster2the address of cluster 2
overlapResultthe overlap result

Definition at line 336 of file LArOverlapMatrix.h.

337  :
338  m_pCluster1(pCluster1),
339  m_pCluster2(pCluster2),
340  m_overlapResult(overlapResult)
341 {
342 }
OverlapResult m_overlapResult
The overlap result.
const pandora::Cluster * m_pCluster1
The address of cluster 1.
const pandora::Cluster * m_pCluster2
The address of cluster 2.

Member Function Documentation

template<typename T >
const pandora::Cluster * lar_content::OverlapMatrix< T >::Element::GetCluster1 ( ) const
inline

Get the address of cluster 1.

Returns
address of cluster 1

Definition at line 347 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::Element::m_pCluster1.

348 {
349  return m_pCluster1;
350 }
const pandora::Cluster * m_pCluster1
The address of cluster 1.
template<typename T >
const pandora::Cluster * lar_content::OverlapMatrix< T >::Element::GetCluster2 ( ) const
inline

Get the address of cluster 2.

Returns
address of cluster 2

Definition at line 355 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::Element::m_pCluster2.

356 {
357  return m_pCluster2;
358 }
const pandora::Cluster * m_pCluster2
The address of cluster 2.
template<typename T >
const OverlapMatrix< T >::OverlapResult & lar_content::OverlapMatrix< T >::Element::GetOverlapResult ( ) const
inline

Get the overlap result.

Returns
the overlap result

Definition at line 363 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::Element::m_overlapResult.

Referenced by lar_content::OverlapMatrix< T >::Element::operator<().

364 {
365  return m_overlapResult;
366 }
OverlapResult m_overlapResult
The overlap result.
template<typename T >
bool lar_content::OverlapMatrix< T >::Element::operator< ( const Element rhs) const

Element less than operator.

Parameters
rhsthe element for comparison

Definition at line 371 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::Element::GetOverlapResult().

372 {
373  if (this == &rhs)
374  return false;
375 
376  return (this->GetOverlapResult() < rhs.GetOverlapResult());
377 }
const OverlapResult & GetOverlapResult() const
Get the overlap result.

Member Data Documentation

template<typename T>
OverlapResult lar_content::OverlapMatrix< T >::Element::m_overlapResult
private

The overlap result.

Definition at line 74 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::Element::GetOverlapResult().

template<typename T>
const pandora::Cluster* lar_content::OverlapMatrix< T >::Element::m_pCluster1
private

The address of cluster 1.

Definition at line 72 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::Element::GetCluster1().

template<typename T>
const pandora::Cluster* lar_content::OverlapMatrix< T >::Element::m_pCluster2
private

The address of cluster 2.

Definition at line 73 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::Element::GetCluster2().


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