All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
daq::IFakeParticle Class Referenceabstract

IFakeParticle interface class definiton. More...

#include <IFakeParticle.h>

Inheritance diagram for daq::IFakeParticle:
daq::FakeParticle

Public Types

using VectorShort = std::vector< short >
 Creates a fake particle and overlays on the input fragment. More...
 
using VectorFloat = std::vector< float >
 
using ArrayShort = std::vector< VectorShort >
 
using ArrayFloat = std::vector< VectorFloat >
 

Public Member Functions

virtual ~IFakeParticle () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual void overlayFakeParticle (detinfo::DetectorClocksData const &clockData, ArrayFloat &waveforms)=0
 

Detailed Description

IFakeParticle interface class definiton.

Definition at line 30 of file IFakeParticle.h.

Member Typedef Documentation

Definition at line 53 of file IFakeParticle.h.

Definition at line 52 of file IFakeParticle.h.

using daq::IFakeParticle::VectorFloat = std::vector<float>

Definition at line 51 of file IFakeParticle.h.

using daq::IFakeParticle::VectorShort = std::vector<short>

Creates a fake particle and overlays on the input fragment.

Parameters
waveformsThe waveform container to place fake particle on

Definition at line 50 of file IFakeParticle.h.

Constructor & Destructor Documentation

virtual daq::IFakeParticle::~IFakeParticle ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void daq::IFakeParticle::configure ( const fhicl::ParameterSet &  )
pure virtual

Interface for configuring the particular algorithm tool.

Parameters
ParameterSetThe input set of parameters for configuration

Implemented in daq::FakeParticle.

virtual void daq::IFakeParticle::overlayFakeParticle ( detinfo::DetectorClocksData const &  clockData,
ArrayFloat waveforms 
)
pure virtual

Implemented in daq::FakeParticle.


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