ATLAS Offline Software
Toggle main menu visibility
Loading...
Searching...
No Matches
Simulation
ISF
ISF_Core
ISF_Event
ISF_Event
TruthBinding.h
Go to the documentation of this file.
1
/*
2
Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
3
*/
4
5
#ifndef ISF_EVENT_TRUTHBINDING_H
6
#define ISF_EVENT_TRUTHBINDING_H
7
8
// HepMC
9
#include "
AtlasHepMC/GenParticle.h
"
10
11
namespace
ISF
{
12
17
18
class
TruthBinding
{
19
public
:
21
TruthBinding
() =
delete
;
22
24
inline
TruthBinding
(
HepMC::GenParticlePtr
allTruthP);
26
inline
TruthBinding
(
HepMC::GenParticlePtr
truthP,
HepMC::GenParticlePtr
primaryTruthP,
HepMC::GenParticlePtr
genZeroTruthP);
27
29
inline
TruthBinding
(
const
TruthBinding
&rhs) =
default
;
30
inline
TruthBinding
(
TruthBinding
&& rhs) =
default
;
31
32
//** assignment operators */
33
inline
TruthBinding
&
operator=
(
const
TruthBinding
&rhs) =
default
;
34
inline
TruthBinding
&
operator=
(
TruthBinding
&& rhs) =
default
;
35
37
inline
bool
operator==
(
const
TruthBinding
& rhs)
const
;
38
inline
bool
isEqual
(
const
TruthBinding
& rhs)
const
;
39
inline
bool
isIdent
(
const
TruthBinding
& rhs)
const
;
40
42
inline
~TruthBinding
();
43
45
inline
HepMC::GenParticlePtr
getCurrentGenParticle
();
46
inline
HepMC::ConstGenParticlePtr
getCurrentGenParticle
()
const
;
47
inline
void
setCurrentGenParticle
(
HepMC::GenParticlePtr
p);
48
50
inline
HepMC::GenParticlePtr
getPrimaryGenParticle
();
51
inline
HepMC::ConstGenParticlePtr
getPrimaryGenParticle
()
const
;
52
54
inline
HepMC::GenParticlePtr
getGenerationZeroGenParticle
();
55
inline
HepMC::ConstGenParticlePtr
getGenerationZeroGenParticle
()
const
;
56
inline
void
setGenerationZeroGenParticle
(
HepMC::GenParticlePtr
p);
57
59
inline
TruthBinding
*
childTruthBinding
(
HepMC::GenParticlePtr
childP);
60
61
private
:
62
HepMC::GenParticlePtr
m_truthParticle
{};
63
HepMC::GenParticlePtr
m_primaryGenParticle
{};
64
HepMC::GenParticlePtr
m_generationZeroGenParticle
{};
65
};
66
67
}
// end of namespace
68
69
/* implementation for inlined methods */
70
#include <
ISF_Event/TruthBinding.icc
>
71
72
#endif
// ISF_EVENT_TRUTHBINDING_H
GenParticle.h
TruthBinding.icc
ISF::TruthBinding::setGenerationZeroGenParticle
void setGenerationZeroGenParticle(HepMC::GenParticlePtr p)
ISF::TruthBinding::m_generationZeroGenParticle
HepMC::GenParticlePtr m_generationZeroGenParticle
pointer to corresponding truth particle before any regenration
Definition
TruthBinding.h:64
ISF::TruthBinding::getPrimaryGenParticle
HepMC::ConstGenParticlePtr getPrimaryGenParticle() const
ISF::TruthBinding::isEqual
bool isEqual(const TruthBinding &rhs) const
ISF::TruthBinding::getGenerationZeroGenParticle
HepMC::ConstGenParticlePtr getGenerationZeroGenParticle() const
ISF::TruthBinding::getCurrentGenParticle
HepMC::ConstGenParticlePtr getCurrentGenParticle() const
ISF::TruthBinding::TruthBinding
TruthBinding(HepMC::GenParticlePtr truthP, HepMC::GenParticlePtr primaryTruthP, HepMC::GenParticlePtr genZeroTruthP)
constructor setting all truth particle pointers individually
ISF::TruthBinding::getPrimaryGenParticle
HepMC::GenParticlePtr getPrimaryGenParticle()
pointer to the primary particle in the simulation truth
ISF::TruthBinding::~TruthBinding
~TruthBinding()
destructor
ISF::TruthBinding::isIdent
bool isIdent(const TruthBinding &rhs) const
ISF::TruthBinding::TruthBinding
TruthBinding(const TruthBinding &rhs)=default
copy constructors
ISF::TruthBinding::setCurrentGenParticle
void setCurrentGenParticle(HepMC::GenParticlePtr p)
ISF::TruthBinding::TruthBinding
TruthBinding(HepMC::GenParticlePtr allTruthP)
constructor setting all truth particle pointers to the given particle
ISF::TruthBinding::m_truthParticle
HepMC::GenParticlePtr m_truthParticle
pointer to particle in MC truth
Definition
TruthBinding.h:62
ISF::TruthBinding::operator==
bool operator==(const TruthBinding &rhs) const
comparisons
ISF::TruthBinding::TruthBinding
TruthBinding(TruthBinding &&rhs)=default
ISF::TruthBinding::m_primaryGenParticle
HepMC::GenParticlePtr m_primaryGenParticle
pointer to corresponding primary (generator) particle
Definition
TruthBinding.h:63
ISF::TruthBinding::operator=
TruthBinding & operator=(const TruthBinding &rhs)=default
ISF::TruthBinding::getCurrentGenParticle
HepMC::GenParticlePtr getCurrentGenParticle()
pointer to the particle in the simulation truth
ISF::TruthBinding::operator=
TruthBinding & operator=(TruthBinding &&rhs)=default
ISF::TruthBinding::TruthBinding
TruthBinding()=delete
No default constructor.
ISF::TruthBinding::getGenerationZeroGenParticle
HepMC::GenParticlePtr getGenerationZeroGenParticle()
pointer to the simulation truth particle before any regeneration happened (eg.
ISF::TruthBinding::childTruthBinding
TruthBinding * childTruthBinding(HepMC::GenParticlePtr childP)
Create a TruthBinding for a child particle.
HepMC::GenParticlePtr
HepMC3::GenParticlePtr GenParticlePtr
Definition
GenParticle.h:19
HepMC::ConstGenParticlePtr
HepMC3::ConstGenParticlePtr ConstGenParticlePtr
Definition
GenParticle.h:20
ISF
ISFParticleOrderedQueue.
Definition
PrimaryParticleInformation.h:13
Generated on
for ATLAS Offline Software by
1.17.0