LArSoft  v09_90_00
Liquid Argon Software toolkit - https://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 * GetCluster (const pandora::HitType hitType) const
 Get the address of the given hit type cluster. 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 412 of file LArOverlapTensor.h.

413  :
414  m_pClusterU(pClusterU),
415  m_pClusterV(pClusterV),
416  m_pClusterW(pClusterW),
417  m_overlapResult(overlapResult)
418 {
419 }
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 Cluster * lar_content::OverlapTensor< T >::Element::GetCluster ( const pandora::HitType  hitType) const

Get the address of the given hit type cluster.

Parameters
hitTypehit type of the required cluster
Returns
address of the required cluster

Definition at line 31 of file LArOverlapTensor.cc.

32 {
33  if ((hitType != TPC_VIEW_U) && (hitType != TPC_VIEW_V) && (hitType != TPC_VIEW_W))
34  throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
35 
36  return (hitType == TPC_VIEW_U) ? m_pClusterU : (hitType == TPC_VIEW_V) ? m_pClusterV : m_pClusterW;
37 }
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.
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 424 of file LArOverlapTensor.h.

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

425 {
426  return m_pClusterU;
427 }
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 432 of file LArOverlapTensor.h.

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

433 {
434  return m_pClusterV;
435 }
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 440 of file LArOverlapTensor.h.

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

441 {
442  return m_pClusterW;
443 }
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 448 of file LArOverlapTensor.h.

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

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

449 {
450  return m_overlapResult;
451 }
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 456 of file LArOverlapTensor.h.

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

457 {
458  if (this == &rhs)
459  return false;
460 
461  return (this->GetOverlapResult() < rhs.GetOverlapResult());
462 }
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 93 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 90 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 91 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 92 of file LArOverlapTensor.h.

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


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