ATLAS Offline Software
Public Member Functions | List of all members
ITruthParticleCnvTool Class Referenceabstract

#include <ITruthParticleCnvTool.h>

Inheritance diagram for ITruthParticleCnvTool:
Collaboration diagram for ITruthParticleCnvTool:

Public Member Functions

 DeclareInterfaceID (ITruthParticleCnvTool, 1, 0)
 
virtual ~ITruthParticleCnvTool ()
 Destructor: More...
 
virtual StatusCode execute () const =0
 
virtual StatusCode execute (const EventContext &ctx) const =0
 
virtual StatusCode convert (const McEventCollection *mcEvts, const unsigned int genEvtIndex, TruthParticleContainer *mcParts, const ITruthParticleVisitor *visitor=0) const =0
 Convert a McEventCollection into an TruthParticleContainer. More...
 
StatusCode convert (const McEventCollection *mcCollection, TruthParticleContainer *container) const
 Convert the first element of a McEventCollection into a TruthParticleContainer. More...
 
StatusCode convertMcEventCollection (const McEventCollection *mcCollection, TruthParticleContainer *container) const
 Convert a McEventCollection into an TruthParticleContainer. More...
 

Detailed Description

interface for AlgTools which want to convert McEventCollection objects into a TruthParticleContainer objects. It is also used by the custom POOL converter for TruthParticleContainer to recreate the TruthParticleContainers on the fly (save some disk space). ITruthParticleCnvTool also provides some helper functions related with mother/daughter relationships in the TruthParticle context.

Definition at line 38 of file ITruthParticleCnvTool.h.

Constructor & Destructor Documentation

◆ ~ITruthParticleCnvTool()

ITruthParticleCnvTool::~ITruthParticleCnvTool ( )
virtual

Destructor:

Public methods:

Constructors Destructor

Definition at line 25 of file ITruthParticleCnvTool.cxx.

26 {}

Member Function Documentation

◆ convert() [1/2]

StatusCode ITruthParticleCnvTool::convert ( const McEventCollection mcCollection,
TruthParticleContainer container 
) const
inline

Convert the first element of a McEventCollection into a TruthParticleContainer.

Inline methods:

Definition at line 94 of file ITruthParticleCnvTool.h.

96 {
97  const unsigned int genEvtIndex = 0;
98  const ITruthParticleVisitor* dummyVisitor = 0;
99  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
100 }

◆ convert() [2/2]

virtual StatusCode ITruthParticleCnvTool::convert ( const McEventCollection mcEvts,
const unsigned int  genEvtIndex,
TruthParticleContainer mcParts,
const ITruthParticleVisitor visitor = 0 
) const
pure virtual

Convert a McEventCollection into an TruthParticleContainer.

@in mcEvts the McEventCollection holding the HepMC::GenEvent we want to convert into a TruthParticleContainer @in genEvtIndex the index to the HepMC::GenEvent to be converted @out mcParts a valid pointer to a TruthParticleContainer which will be filled with adaptors to HepMC::GenParticles.

◆ convertMcEventCollection()

StatusCode ITruthParticleCnvTool::convertMcEventCollection ( const McEventCollection mcCollection,
TruthParticleContainer container 
) const
inline

Convert a McEventCollection into an TruthParticleContainer.

deprecated Note that the pointer to the TruthParticleContainer MUST be valid.

Definition at line 103 of file ITruthParticleCnvTool.h.

105 {
106  const unsigned int genEvtIndex = 0;
107  const ITruthParticleVisitor* dummyVisitor = 0;
108  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
109 }

◆ DeclareInterfaceID()

ITruthParticleCnvTool::DeclareInterfaceID ( ITruthParticleCnvTool  ,
,
 
)

◆ execute() [1/2]

virtual StatusCode ITruthParticleCnvTool::execute ( ) const
pure virtual

◆ execute() [2/2]

virtual StatusCode ITruthParticleCnvTool::execute ( const EventContext &  ctx) const
pure virtual

The documentation for this class was generated from the following files:
ITruthParticleCnvTool::convert
virtual StatusCode convert(const McEventCollection *mcEvts, const unsigned int genEvtIndex, TruthParticleContainer *mcParts, const ITruthParticleVisitor *visitor=0) const =0
Convert a McEventCollection into an TruthParticleContainer.
ITruthParticleVisitor
Definition: ITruthParticleVisitor.h:30