#include "StreamingAlgorithm.h"

Inheritance diagram for lar_content::StreamingAlgorithm:

[legend]

Collaboration diagram for lar_content::StreamingAlgorithm:

[legend]

Public Member Functions
	StreamingAlgorithm ()
	Default constructor.

virtual	~StreamingAlgorithm ()

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 Types
typedef std::map< std::string, pandora::StringVector >	StreamAlgorithmMap

Private Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

Private Attributes
std::string	m_outputListName
	The name of the output list.

std::string	m_listType
	The type of the input lists (currently only Cluster is supported)

pandora::StringVector	m_inputListNames
	The names of the input lists.

pandora::StringVector	m_outputListNames
	Names of the output lists if not combining into a single list at the end.

StreamAlgorithmMap	m_streamAlgorithmMap
	A map from individual streams to the algorithms that stream should run.

Detailed Description

StreamingAlgorithm class.

Definition at line 19 of file StreamingAlgorithm.h.

Member Typedef Documentation

◆ StreamAlgorithmMap

typedef std::map<std::string, pandora::StringVector> lar_content::StreamingAlgorithm::StreamAlgorithmMap

private

Definition at line 30 of file StreamingAlgorithm.h.

Constructor & Destructor Documentation

◆ StreamingAlgorithm()

lar_content::StreamingAlgorithm::StreamingAlgorithm ( )

Default constructor.

Definition at line 26 of file StreamingAlgorithm.cc.

◆ ~StreamingAlgorithm()

lar_content::StreamingAlgorithm::~StreamingAlgorithm ( )

virtual

Definition at line 32 of file StreamingAlgorithm.cc.

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::StreamingAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 80 of file StreamingAlgorithm.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::StreamingAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 38 of file StreamingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputListNames

pandora::StringVector lar_content::StreamingAlgorithm::m_inputListNames

private

The names of the input lists.

Definition at line 36 of file StreamingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_listType

std::string lar_content::StreamingAlgorithm::m_listType

private

The type of the input lists (currently only Cluster is supported)

Definition at line 35 of file StreamingAlgorithm.h.

◆ m_outputListName

std::string lar_content::StreamingAlgorithm::m_outputListName

private

The name of the output list.

Definition at line 34 of file StreamingAlgorithm.h.

◆ m_outputListNames

pandora::StringVector lar_content::StreamingAlgorithm::m_outputListNames

private

Names of the output lists if not combining into a single list at the end.

Definition at line 37 of file StreamingAlgorithm.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_streamAlgorithmMap

StreamAlgorithmMap lar_content::StreamingAlgorithm::m_streamAlgorithmMap

private

A map from individual streams to the algorithms that stream should run.

Definition at line 38 of file StreamingAlgorithm.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/LArControlFlow/StreamingAlgorithm.h
LArContent/larpandoracontent/LArControlFlow/StreamingAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StreamAlgorithmMap

Constructor & Destructor Documentation

◆ StreamingAlgorithm()

◆ ~StreamingAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputListNames

◆ m_instanceName

◆ m_listType

◆ m_outputListName

◆ m_outputListNames

◆ m_pPandora

◆ m_streamAlgorithmMap

◆ m_type