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

#include <ITruthParticleCnvTool.h>

Inheritance diagram for ITruthParticleCnvTool:
Collaboration diagram for ITruthParticleCnvTool:

Public Member Functions

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...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Inline methods:
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 39 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.

Definition at line 112 of file ITruthParticleCnvTool.h.

114 {
115  const unsigned int genEvtIndex = 0;
116  const ITruthParticleVisitor* dummyVisitor = 0;
117  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
118 }

◆ 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.

Implemented in TruthParticleCnvTool, and RootTruthParticleCnvTool.

◆ 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 121 of file ITruthParticleCnvTool.h.

123 {
124  const unsigned int genEvtIndex = 0;
125  const ITruthParticleVisitor* dummyVisitor = 0;
126  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
127 }

◆ execute() [1/2]

virtual StatusCode ITruthParticleCnvTool::execute ( ) const
pure virtual

◆ execute() [2/2]

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

◆ interfaceID()

const InterfaceID & ITruthParticleCnvTool::interfaceID ( )
inlinestatic

Inline methods:

Definition at line 106 of file ITruthParticleCnvTool.h.

107 {
108  return IID_ITruthParticleCnvTool;
109 }

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