lar_content::ListMergingAlgorithm Class Reference

ListMergingAlgorithm class. More...

#include "ListMergingAlgorithm.h"

Inheritance diagram for lar_content::ListMergingAlgorithm:

Collaboration diagram for lar_content::ListMergingAlgorithm:

Public Member Functions
const std::string &	GetType () const
	Get the type.
const std::string &	GetInstanceName () const
	Get the instance name.
const Pandora &	GetPandora () const
	Get the associated pandora instance.

Protected Member Functions
virtual StatusCode	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.
virtual StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.
StatusCode	RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
	Register i) the pandora instance that will run the process and ii) the process type.

Protected Attributes
const Pandora *	m_pPandora
	The pandora object that will run the process.
std::string	m_type
	The process type.
std::string	m_instanceName
	The process instance name.

Private Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

Private Attributes
pandora::StringVector	m_sourceVertexListNames
	The source vertex list names.
pandora::StringVector	m_targetVertexListNames
	The target vertex list names.
pandora::StringVector	m_sourceClusterListNames
	The source cluster list names.
pandora::StringVector	m_targetClusterListNames
	The target cluster list names.
pandora::StringVector	m_sourcePfoListNames
	The source pfo list names.
pandora::StringVector	m_targetPfoListNames
	The target pfo list names.

Detailed Description

ListMergingAlgorithm class.

Definition at line 19 of file ListMergingAlgorithm.h.

Member Function Documentation

GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const

inlineinherited

Get the instance name.

Returns

The instance name

Definition at line 109 of file Process.h.

GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const

inlineinherited

Get the associated pandora instance.

Returns

the associated pandora instance

Definition at line 116 of file Process.h.

GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns

The type

Definition at line 102 of file Process.h.

Initialize()

StatusCode pandora::Process::Initialize ( )

inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

ReadSettings()

StatusCode lar_content::ListMergingAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle

the relevant xml handle

Implements pandora::Process.

Definition at line 121 of file ListMergingAlgorithm.cc.

Here is the call graph for this function:

RegisterDetails()

StatusCode pandora::Process::RegisterDetails ( const Pandora *const  pPandora, const std::string &  type, const std::string &  instanceName  )

inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

Reset()

StatusCode pandora::Process::Reset ( )

inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

Run()

StatusCode lar_content::ListMergingAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 18 of file ListMergingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

m_pPandora

const Pandora* pandora::Process::m_pPandora

protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

m_sourceClusterListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_sourceClusterListNames

private

The source cluster list names.

Definition at line 28 of file ListMergingAlgorithm.h.

m_sourcePfoListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_sourcePfoListNames

private

The source pfo list names.

Definition at line 31 of file ListMergingAlgorithm.h.

m_sourceVertexListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_sourceVertexListNames

private

The source vertex list names.

Definition at line 25 of file ListMergingAlgorithm.h.

m_targetClusterListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_targetClusterListNames

private

The target cluster list names.

Definition at line 29 of file ListMergingAlgorithm.h.

m_targetPfoListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_targetPfoListNames

private

The target pfo list names.

Definition at line 32 of file ListMergingAlgorithm.h.

m_targetVertexListNames

pandora::StringVector lar_content::ListMergingAlgorithm::m_targetVertexListNames

private

The target vertex list names.

Definition at line 26 of file ListMergingAlgorithm.h.

m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

---

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

• LArContent/larpandoracontent/LArUtility/ListMergingAlgorithm.h
• LArContent/larpandoracontent/LArUtility/ListMergingAlgorithm.cc