ATLAS Offline Software
Loading...
Searching...
No Matches
HepMC::ShadowParticle Class Reference

Attribute for linking GenParticles between GenEvents. More...

#include <GenEvent.h>

Inheritance diagram for HepMC::ShadowParticle:
Collaboration diagram for HepMC::ShadowParticle:

Public Member Functions

 ShadowParticle ()
 Default constructor.
 ShadowParticle (ConstGenParticlePtr p)
 Constructor initializing attribute value.
virtual bool from_string (const std::string &) override
 Implementation of Attribute::from_string.
virtual bool to_string (std::string &att) const override
 Implementation of Attribute::to_string.
ConstGenParticlePtr value () const
 get a pointer to the shadow particle.

Private Attributes

ConstGenParticlePtr m_shadow
 The shadow particle.

Detailed Description

Attribute for linking GenParticles between GenEvents.

Variation of the AssociatedParticle Attribute, which allows GenParticles to be linked between GenEvents. For transient use only as the from_string(...) method is not defined

Definition at line 311 of file GenEvent.h.

Constructor & Destructor Documentation

◆ ShadowParticle() [1/2]

HepMC::ShadowParticle::ShadowParticle ( )
inline

Default constructor.

Definition at line 315 of file GenEvent.h.

315{}

◆ ShadowParticle() [2/2]

HepMC::ShadowParticle::ShadowParticle ( ConstGenParticlePtr p)
inline

Constructor initializing attribute value.

Definition at line 318 of file GenEvent.h.

319 : Attribute(), m_shadow(p) {}
ConstGenParticlePtr m_shadow
The shadow particle.
Definition GenEvent.h:337

Member Function Documentation

◆ from_string()

virtual bool HepMC::ShadowParticle::from_string ( const std::string & )
inlineoverridevirtual

Implementation of Attribute::from_string.

Definition at line 322 of file GenEvent.h.

322{ return false; }

◆ to_string()

virtual bool HepMC::ShadowParticle::to_string ( std::string & att) const
inlineoverridevirtual

Implementation of Attribute::to_string.

Definition at line 325 of file GenEvent.h.

326 {
327 att = "ShadowParticle";
328 return true;
329 }

◆ value()

ConstGenParticlePtr HepMC::ShadowParticle::value ( ) const
inline

get a pointer to the shadow particle.

Definition at line 331 of file GenEvent.h.

331 {
332 return m_shadow;
333 }

Member Data Documentation

◆ m_shadow

ConstGenParticlePtr HepMC::ShadowParticle::m_shadow
private

The shadow particle.

Definition at line 337 of file GenEvent.h.


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