Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EventWritingAlgorithm Class Reference

EventWritingAlgorithm class. More...

#include "EventWritingAlgorithm.h"

Inheritance diagram for EventWritingAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for EventWritingAlgorithm:
Collaboration graph
[legend]

Classes

class  Factory
 Factory class for instantiating algorithm. More...
 

Public Member Functions

 EventWritingAlgorithm ()
 Default constructor.
 
 ~EventWritingAlgorithm ()
 Destructor.
 
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

pandora::StatusCode Initialize ()
 Perform any operations that must occur after reading settings, but before running the process.
 
pandora::StatusCode Run ()
 Run the algorithm.
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
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

pandora::FileType m_geometryFileType
 The geometry file type.
 
pandora::FileType m_eventFileType
 The event file type.
 
bool m_shouldWriteGeometry
 Whether to write geometry to a specified file.
 
std::string m_geometryFileName
 Name of the output geometry file.
 
bool m_shouldWriteEvents
 Whether to write events to a specified file.
 
std::string m_eventFileName
 Name of the output event file.
 
bool m_shouldWriteMCRelationships
 Whether to write mc relationship information to the events file.
 
bool m_shouldWriteTrackRelationships
 Whether to write track relationship information to the events file.
 
bool m_shouldOverwriteEventFile
 Whether to overwrite existing event file with specified name, or append.
 
bool m_shouldOverwriteGeometryFile
 Whether to overwrite existing geometry file with specified name, or append.
 
pandora::FileWriter * m_pEventFileWriter
 Address of the event file writer.
 
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.
 

Detailed Description

EventWritingAlgorithm class.

Definition at line 22 of file EventWritingAlgorithm.h.

Constructor & Destructor Documentation

◆ EventWritingAlgorithm()

EventWritingAlgorithm::EventWritingAlgorithm ( )

Default constructor.

Definition at line 17 of file EventWritingAlgorithm.cc.

Here is the caller graph for this function:

◆ ~EventWritingAlgorithm()

EventWritingAlgorithm::~EventWritingAlgorithm ( )

Destructor.

Definition at line 32 of file EventWritingAlgorithm.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 EventWritingAlgorithm::Initialize ( )
protectedvirtual

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

Reimplemented from pandora::Process.

Definition at line 39 of file EventWritingAlgorithm.cc.

Here is the call graph for this function:

◆ ReadSettings()

StatusCode EventWritingAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
protectedvirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 106 of file EventWritingAlgorithm.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
pPandoraaddress of the pandora object that will run the process
typethe process type
instanceNamethe 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 EventWritingAlgorithm::Run ( )
protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 84 of file EventWritingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_eventFileName

std::string EventWritingAlgorithm::m_eventFileName
protected

Name of the output event file.

Definition at line 56 of file EventWritingAlgorithm.h.

◆ m_eventFileType

pandora::FileType EventWritingAlgorithm::m_eventFileType
protected

The event file type.

Definition at line 50 of file EventWritingAlgorithm.h.

◆ m_geometryFileName

std::string EventWritingAlgorithm::m_geometryFileName
protected

Name of the output geometry file.

Definition at line 53 of file EventWritingAlgorithm.h.

◆ m_geometryFileType

pandora::FileType EventWritingAlgorithm::m_geometryFileType
protected

The geometry file type.

Definition at line 49 of file EventWritingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName
protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_pEventFileWriter

pandora::FileWriter* EventWritingAlgorithm::m_pEventFileWriter
protected

Address of the event file writer.

Definition at line 64 of file EventWritingAlgorithm.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_shouldOverwriteEventFile

bool EventWritingAlgorithm::m_shouldOverwriteEventFile
protected

Whether to overwrite existing event file with specified name, or append.

Definition at line 61 of file EventWritingAlgorithm.h.

◆ m_shouldOverwriteGeometryFile

bool EventWritingAlgorithm::m_shouldOverwriteGeometryFile
protected

Whether to overwrite existing geometry file with specified name, or append.

Definition at line 62 of file EventWritingAlgorithm.h.

◆ m_shouldWriteEvents

bool EventWritingAlgorithm::m_shouldWriteEvents
protected

Whether to write events to a specified file.

Definition at line 55 of file EventWritingAlgorithm.h.

◆ m_shouldWriteGeometry

bool EventWritingAlgorithm::m_shouldWriteGeometry
protected

Whether to write geometry to a specified file.

Definition at line 52 of file EventWritingAlgorithm.h.

◆ m_shouldWriteMCRelationships

bool EventWritingAlgorithm::m_shouldWriteMCRelationships
protected

Whether to write mc relationship information to the events file.

Definition at line 58 of file EventWritingAlgorithm.h.

◆ m_shouldWriteTrackRelationships

bool EventWritingAlgorithm::m_shouldWriteTrackRelationships
protected

Whether to write track relationship information to the events file.

Definition at line 59 of file EventWritingAlgorithm.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: