LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
MultiPandoraApi Class Reference

MultiPandoraApi class. More...

#include "MultiPandoraApi.h"

Static Public Member Functions

static const PandoraInstanceMapGetPandoraInstanceMap ()
 Get the pandora instance map. More...
 
static const pandora::Pandora * GetPandoraInstance (const pandora::Pandora *const pPrimaryPandora, const unsigned int volumeId)
 Get the address of the pandora instance associated with a given primary pandora instance and volume id number. More...
 
static const PandoraInstanceListGetDaughterPandoraInstanceList (const pandora::Pandora *const pPrimaryPandora)
 Get the list of daughter pandora instances associated with a given primary pandora instance. More...
 
static const pandora::Pandora * GetPrimaryPandoraInstance (const pandora::Pandora *const pDaughterPandora)
 Get the address of the primary pandora instance associated with a given daughter pandora instance. More...
 
static unsigned int GetVolumeId (const pandora::Pandora *const pPandora)
 Get the volume id associated with a given pandora instance. More...
 
static void AddPrimaryPandoraInstance (const pandora::Pandora *const pPrimaryPandora)
 Declare a new primary pandora instance and receive the relevant multi pandora book-keeping instance. More...
 
static void AddDaughterPandoraInstance (const pandora::Pandora *const pPrimaryPandora, const pandora::Pandora *const pDaughterPandora)
 Add a pandora daughter instance, associated to a primary pandora instance. More...
 
static void DeletePandoraInstances (const pandora::Pandora *const pPrimaryPandora)
 Delete all pandora instances associated with (and including) a specified primary pandora instance. More...
 
static void SetVolumeId (const pandora::Pandora *const pPandora, const unsigned int volumeId)
 Set the volume id associated with a given pandora instance. More...
 

Static Private Attributes

static MultiPandoraApiImpl m_multiPandoraApiImpl
 The multi pandora api implementation. More...
 

Detailed Description

MultiPandoraApi class.

Definition at line 30 of file MultiPandoraApi.h.

Member Function Documentation

void MultiPandoraApi::AddDaughterPandoraInstance ( const pandora::Pandora *const  pPrimaryPandora,
const pandora::Pandora *const  pDaughterPandora 
)
static

Add a pandora daughter instance, associated to a primary pandora instance.

Parameters
pPrimaryPandorathe address of the primary pandora instance
pDaughterPandorathe address of the daughter pandora instance

Definition at line 61 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::AddDaughterPandoraInstance(), and m_multiPandoraApiImpl.

Referenced by lar_content::MasterAlgorithm::CreatePfo().

62 {
63  m_multiPandoraApiImpl.AddDaughterPandoraInstance(pPrimaryPandora, pDaughterPandora);
64 }
void AddDaughterPandoraInstance(const pandora::Pandora *const pPrimaryPandora, const pandora::Pandora *const pDaughterPandora)
Add a pandora daughter instance, associated to a primary pandora instance.
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
void MultiPandoraApi::AddPrimaryPandoraInstance ( const pandora::Pandora *const  pPrimaryPandora)
static

Declare a new primary pandora instance and receive the relevant multi pandora book-keeping instance.

Parameters
pPrimaryPandorathe address of the primary pandora instance
Returns
the multipandora instance

Definition at line 54 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::AddPrimaryPandoraInstance(), and m_multiPandoraApiImpl.

Referenced by lar_pandora::StandardPandora::CreatePandoraInstances().

55 {
57 }
void AddPrimaryPandoraInstance(const pandora::Pandora *const pPrimaryPandora)
Declare a new primary pandora instance.
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
void MultiPandoraApi::DeletePandoraInstances ( const pandora::Pandora *const  pPrimaryPandora)
static

Delete all pandora instances associated with (and including) a specified primary pandora instance.

Parameters
pPrimaryPandorathe address of the primary pandora instance

Definition at line 68 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::DeletePandoraInstances(), and m_multiPandoraApiImpl.

Referenced by lar_pandora::StandardPandora::DeletePandoraInstances().

69 {
71 }
void DeletePandoraInstances(const pandora::Pandora *const pPrimaryPandora)
Delete all pandora instances associated with (and including) a specified primary pandora instance...
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
const PandoraInstanceList & MultiPandoraApi::GetDaughterPandoraInstanceList ( const pandora::Pandora *const  pPrimaryPandora)
static

Get the list of daughter pandora instances associated with a given primary pandora instance.

Parameters
pPrimaryPandorathe address of the primary pandora instance
Returns
the daughter pandora instance list

Definition at line 33 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::GetDaughterPandoraInstanceList(), and m_multiPandoraApiImpl.

Referenced by lar_pandora::LArPandoraOutput::GetPandoraInstance().

34 {
36 }
const PandoraInstanceList & GetDaughterPandoraInstanceList(const pandora::Pandora *const pPrimaryPandora) const
Get the list of daughter pandora instances associated with a given primary pandora instance...
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
const pandora::Pandora * MultiPandoraApi::GetPandoraInstance ( const pandora::Pandora *const  pPrimaryPandora,
const unsigned int  volumeId 
)
static

Get the address of the pandora instance associated with a given primary pandora instance and volume id number.

Parameters
pPrimaryPandorathe address of the primary pandora instance
volumeIdthe volume identifier number
Returns
the address of the pandora instance

Definition at line 26 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::GetPandoraInstance(), and m_multiPandoraApiImpl.

27 {
28  return m_multiPandoraApiImpl.GetPandoraInstance(pPrimaryPandora, volumeId);
29 }
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
const pandora::Pandora * GetPandoraInstance(const pandora::Pandora *const pPrimaryPandora, const unsigned int volumeId) const
Get the address of the pandora instance associated with a given primary pandora instance and volume i...
const PandoraInstanceMap & MultiPandoraApi::GetPandoraInstanceMap ( )
static

Get the pandora instance map.

Returns
the pandora instance map

Definition at line 19 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::GetPandoraInstanceMap(), and m_multiPandoraApiImpl.

Referenced by lar_content::LArStitchingHelper::FindClosestTPC().

20 {
22 }
const PandoraInstanceMap & GetPandoraInstanceMap() const
Get the pandora instance map.
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
const pandora::Pandora * MultiPandoraApi::GetPrimaryPandoraInstance ( const pandora::Pandora *const  pDaughterPandora)
static

Get the address of the primary pandora instance associated with a given daughter pandora instance.

Parameters
pDaughterPandorathe address of the daughter pandora instance
Returns
the address of the primary pandora instance

Definition at line 40 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::GetPrimaryPandoraInstance(), and m_multiPandoraApiImpl.

41 {
42  return m_multiPandoraApiImpl.GetPrimaryPandoraInstance(pDaughterPandora);
43 }
const pandora::Pandora * GetPrimaryPandoraInstance(const pandora::Pandora *const pDaughterPandora) const
Get the address of the primary pandora instance associated with a given daughter pandora instance...
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
unsigned int MultiPandoraApi::GetVolumeId ( const pandora::Pandora *const  pPandora)
static

Get the volume id associated with a given pandora instance.

Parameters
pPandorathe address of the pandora instance
Returns
the volume id

Definition at line 47 of file MultiPandoraApi.cc.

References MultiPandoraApiImpl::GetVolumeId(), and m_multiPandoraApiImpl.

48 {
49  return m_multiPandoraApiImpl.GetVolumeId(pPandora);
50 }
unsigned int GetVolumeId(const pandora::Pandora *const pPandora) const
Get the volume id associated with a given pandora instance.
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.
void MultiPandoraApi::SetVolumeId ( const pandora::Pandora *const  pPandora,
const unsigned int  volumeId 
)
static

Set the volume id associated with a given pandora instance.

Parameters
pPandorathe address of the pandora instance
volumeIdthe volume id

Definition at line 75 of file MultiPandoraApi.cc.

References m_multiPandoraApiImpl, and MultiPandoraApiImpl::SetVolumeId().

76 {
77  m_multiPandoraApiImpl.SetVolumeId(pPandora, volumeId);
78 }
void SetVolumeId(const pandora::Pandora *const pPandora, const unsigned int volumeId)
Set the volume id associated with a given pandora instance.
static MultiPandoraApiImpl m_multiPandoraApiImpl
The multi pandora api implementation.

Member Data Documentation


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