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 308 of file GenEvent.h.

Constructor & Destructor Documentation

ShadowParticle() [1/2]

HepMC::ShadowParticle::ShadowParticle ( )

inline

Default constructor.

Definition at line 312 of file GenEvent.h.

{}

ShadowParticle() [2/2]

HepMC::ShadowParticle::ShadowParticle ( ConstGenParticlePtr p )

inline

Constructor initializing attribute value.

Definition at line 315 of file GenEvent.h.

    : Attribute(), m_shadow(p) {}

Member Function Documentation

from_string()

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

inlineoverridevirtual

Implementation of Attribute::from_string.

Definition at line 319 of file GenEvent.h.

{ return false; }

to_string()

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

inlineoverridevirtual

Implementation of Attribute::to_string.

Definition at line 322 of file GenEvent.h.

  {
    att =  "ShadowParticle";
    return true;
  }

value()

ConstGenParticlePtr HepMC::ShadowParticle::value ( ) const

inline

get a pointer to the shadow particle.

Definition at line 328 of file GenEvent.h.

                                    {
    return m_shadow;
  }

Member Data Documentation

m_shadow

ConstGenParticlePtr HepMC::ShadowParticle::m_shadow

private

The shadow particle.

Definition at line 334 of file GenEvent.h.

---

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

• GenEvent.h