LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
lar_content::OverlapTensor< T >::Element Class Reference

Element class. More...

#include "LArOverlapTensor.h"

Public Member Functions

 Element (const pandora::Cluster *const pClusterU, const pandora::Cluster *const pClusterV, const pandora::Cluster *const pClusterW, const OverlapResult &overlapResult)
 Constructor. More...
 
const pandora::Cluster * GetClusterU () const
 Get the address of the u cluster. More...
 
const pandora::Cluster * GetClusterV () const
 Get the address of the v cluster. More...
 
const pandora::Cluster * GetClusterW () const
 Get the address of the w cluster. 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_pClusterU
 The address of the u cluster. More...
 
const pandora::Cluster * m_pClusterV
 The address of the v cluster. More...
 
const pandora::Cluster * m_pClusterW
 The address of the w cluster. More...
 
OverlapResult m_overlapResult
 The overlap result. More...
 

Detailed Description

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

Element class.

Definition at line 31 of file LArOverlapTensor.h.

Constructor & Destructor Documentation

template<typename T >
lar_content::OverlapTensor< T >::Element::Element ( const pandora::Cluster *const  pClusterU,
const pandora::Cluster *const  pClusterV,
const pandora::Cluster *const  pClusterW,
const OverlapResult overlapResult 
)
inline

Constructor.

Parameters
pClusterUthe address of the u cluster
pClusterVthe address of the v cluster
pClusterWthe address of the w cluster
overlapResultthe overlap result

Definition at line 399 of file LArOverlapTensor.h.

400  :
401  m_pClusterU(pClusterU),
402  m_pClusterV(pClusterV),
403  m_pClusterW(pClusterW),
404  m_overlapResult(overlapResult)
405 {
406 }
OverlapResult m_overlapResult
The overlap result.
const pandora::Cluster * m_pClusterW
The address of the w cluster.
const pandora::Cluster * m_pClusterU
The address of the u cluster.
const pandora::Cluster * m_pClusterV
The address of the v cluster.

Member Function Documentation

template<typename T >
const pandora::Cluster * lar_content::OverlapTensor< T >::Element::GetClusterU ( ) const
inline

Get the address of the u cluster.

Returns
address of the u cluster

Definition at line 411 of file LArOverlapTensor.h.

References lar_content::OverlapTensor< T >::Element::m_pClusterU.

412 {
413  return m_pClusterU;
414 }
const pandora::Cluster * m_pClusterU
The address of the u cluster.
template<typename T >
const pandora::Cluster * lar_content::OverlapTensor< T >::Element::GetClusterV ( ) const
inline

Get the address of the v cluster.

Returns
address of the v cluster

Definition at line 419 of file LArOverlapTensor.h.

References lar_content::OverlapTensor< T >::Element::m_pClusterV.

420 {
421  return m_pClusterV;
422 }
const pandora::Cluster * m_pClusterV
The address of the v cluster.
template<typename T >
const pandora::Cluster * lar_content::OverlapTensor< T >::Element::GetClusterW ( ) const
inline

Get the address of the w cluster.

Returns
address of the w cluster

Definition at line 427 of file LArOverlapTensor.h.

References lar_content::OverlapTensor< T >::Element::m_pClusterW.

428 {
429  return m_pClusterW;
430 }
const pandora::Cluster * m_pClusterW
The address of the w cluster.
template<typename T >
const OverlapTensor< T >::OverlapResult & lar_content::OverlapTensor< T >::Element::GetOverlapResult ( ) const
inline

Get the overlap result.

Returns
the overlap result

Definition at line 435 of file LArOverlapTensor.h.

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

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

436 {
437  return m_overlapResult;
438 }
OverlapResult m_overlapResult
The overlap result.
template<typename T >
bool lar_content::OverlapTensor< T >::Element::operator< ( const Element rhs) const

Element less than operator.

Parameters
rhsthe element for comparison

Definition at line 443 of file LArOverlapTensor.h.

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

444 {
445  if (this == &rhs)
446  return false;
447 
448  return (this->GetOverlapResult() < rhs.GetOverlapResult());
449 }
const OverlapResult & GetOverlapResult() const
Get the overlap result.

Member Data Documentation

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

The overlap result.

Definition at line 83 of file LArOverlapTensor.h.

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

template<typename T>
const pandora::Cluster* lar_content::OverlapTensor< T >::Element::m_pClusterU
private

The address of the u cluster.

Definition at line 80 of file LArOverlapTensor.h.

Referenced by lar_content::OverlapTensor< T >::Element::GetClusterU().

template<typename T>
const pandora::Cluster* lar_content::OverlapTensor< T >::Element::m_pClusterV
private

The address of the v cluster.

Definition at line 81 of file LArOverlapTensor.h.

Referenced by lar_content::OverlapTensor< T >::Element::GetClusterV().

template<typename T>
const pandora::Cluster* lar_content::OverlapTensor< T >::Element::m_pClusterW
private

The address of the w cluster.

Definition at line 82 of file LArOverlapTensor.h.

Referenced by lar_content::OverlapTensor< T >::Element::GetClusterW().


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