Class describing a pile-up truth event in the MC record. More...

#include <TruthPileupEvent_v1.h>

Inheritance diagram for xAOD::TruthPileupEvent_v1:

Collaboration diagram for xAOD::TruthPileupEvent_v1:

Public Member Functions
	TruthPileupEvent_v1 ()
	Default constructor.
virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration.
void	toPersistent ()
	Function making sure that the object is ready for persistification.

Access to all the particles associated with the event
const TruthParticleLinks_t &	truthParticleLinks () const
	Get all the truth particles.
void	setTruthParticleLinks (const TruthParticleLinks_t &plinks)
	Set all the truth particles.
size_t	nTruthParticles () const
	Get the number of truth particles.
const TruthParticleLink_t &	truthParticleLink (size_t index) const
	Get the link to one of the truth particles.
const TruthParticle *	truthParticle (size_t index) const
	Get a pointer to one of the truth particles.
void	addTruthParticleLink (const TruthParticleLink_t &plink)
	Add one truth particle.
void	clearTruthParticleLinks ()
	Remove all truth particles.
typedef ElementLink< TruthParticleContainer >	TruthParticleLink_t
	Type of a single truth particle link.
typedef std::vector< TruthParticleLink_t >	TruthParticleLinks_t
	Type of the truth particle links vector.

Access to all the vertices associated with the event
const TruthVertexLinks_t &	truthVertexLinks () const
	Get all the truth vertices.
void	setTruthVertexLinks (const TruthVertexLinks_t &links)
	Set all the truth vertices.
size_t	nTruthVertices () const
	Get the number of truth vertices.
const TruthVertexLink_t &	truthVertexLink (size_t index) const
	Get the link to one of the truth vertices.
const TruthVertex *	truthVertex (size_t index) const
	Get a pointer to one of the truth vertices.
void	addTruthVertexLink (const TruthVertexLink_t &vlink)
	Add one truth vertex.
void	clearTruthVertexLinks ()
	Remove all truth vertices.
typedef ElementLink< TruthVertexContainer >	TruthVertexLink_t
	Type of a single truth vertex link.
typedef std::vector< TruthVertexLink_t >	TruthVertexLinks_t
	Type of the truth particle links vector.

Detailed Description

Class describing a pile-up truth event in the MC record.

Author: Andy Buckley Andy..nosp@m.Buck.nosp@m.ley@c.nosp@m.ern..nosp@m.ch; Jovan Mitrevski Jovan.nosp@m..Mit.nosp@m.revsk.nosp@m.i@ce.nosp@m.rn.ch

Revision: 622193

Date: 2014-10-16 18:08:34 +0200 (Thu, 16 Oct 2014)

Definition at line 23 of file TruthPileupEvent_v1.h.

Member Typedef Documentation

◆ TruthParticleLink_t

typedef ElementLink< TruthParticleContainer > xAOD::TruthEventBase_v1::TruthParticleLink_t

inherited

Type of a single truth particle link.

Definition at line 48 of file TruthEventBase_v1.h.

◆ TruthParticleLinks_t

typedef std::vector< TruthParticleLink_t > xAOD::TruthEventBase_v1::TruthParticleLinks_t

inherited

Type of the truth particle links vector.

Definition at line 50 of file TruthEventBase_v1.h.

◆ TruthVertexLink_t

typedef ElementLink< TruthVertexContainer > xAOD::TruthEventBase_v1::TruthVertexLink_t

inherited

Type of a single truth vertex link.

Definition at line 73 of file TruthEventBase_v1.h.

◆ TruthVertexLinks_t

typedef std::vector< TruthVertexLink_t > xAOD::TruthEventBase_v1::TruthVertexLinks_t

inherited

Type of the truth particle links vector.

Definition at line 75 of file TruthEventBase_v1.h.

Constructor & Destructor Documentation

◆ TruthPileupEvent_v1()

xAOD::TruthPileupEvent_v1::TruthPileupEvent_v1 ( )

Default constructor.

Definition at line 12 of file TruthPileupEvent_v1.cxx.

      : TruthEventBase_v1() {
 
   }

Member Function Documentation

◆ addTruthParticleLink()

void xAOD::TruthEventBase_v1::addTruthParticleLink ( const TruthParticleLink_t & plink )

inherited

Add one truth particle.

Definition at line 68 of file TruthEventBase_v1.cxx.

                                                                            {
 
      truthParticleLinksAcc( *this ).push_back( link );
      return;
   }

◆ addTruthVertexLink()

void xAOD::TruthEventBase_v1::addTruthVertexLink ( const TruthVertexLink_t & vlink )

inherited

Add one truth vertex.

Definition at line 129 of file TruthEventBase_v1.cxx.

                                                                             {
 
      truthVertexLinksAcc( *this ).push_back( link );
      return;
   }

◆ clearTruthParticleLinks()

void xAOD::TruthEventBase_v1::clearTruthParticleLinks ( )

inherited

Remove all truth particles.

Definition at line 74 of file TruthEventBase_v1.cxx.

                                                   {
 
      truthParticleLinksAcc( *this ).clear();
      return;
   }

◆ clearTruthVertexLinks()

void xAOD::TruthEventBase_v1::clearTruthVertexLinks ( )

inherited

Remove all truth vertices.

Definition at line 135 of file TruthEventBase_v1.cxx.

                                                 {
 
      truthVertexLinksAcc( *this ).clear();
      return;
   }

◆ nTruthParticles()

size_t xAOD::TruthEventBase_v1::nTruthParticles ( ) const

inherited

Get the number of truth particles.

◆ nTruthVertices()

size_t xAOD::TruthEventBase_v1::nTruthVertices ( ) const

inherited

Get the number of truth vertices.

◆ setTruthParticleLinks()

void xAOD::TruthEventBase_v1::setTruthParticleLinks ( const TruthParticleLinks_t & plinks )

inherited

Set all the truth particles.

◆ setTruthVertexLinks()

void xAOD::TruthEventBase_v1::setTruthVertexLinks ( const TruthVertexLinks_t & links )

inherited

Set all the truth vertices.

◆ toPersistent()

void xAOD::TruthEventBase_v1::toPersistent ( )

inherited

Function making sure that the object is ready for persistification.

Definition at line 143 of file TruthEventBase_v1.cxx.

                                        {
 
      // Prepare the truth particle links for writing:
      if( truthParticleLinksAcc.isAvailableWritable( *this ) ) {
         TruthParticleLinks_t::iterator itr =
            truthParticleLinksAcc( *this ).begin();
         TruthParticleLinks_t::iterator end =
            truthParticleLinksAcc( *this ).end();
         for( ; itr != end; ++itr ) {
            itr->toPersistent();
         }
      }
 
      // Prepare the truth vertex links for writing:
      if( truthVertexLinksAcc.isAvailableWritable( *this ) ) {
         TruthVertexLinks_t::iterator itr =
            truthVertexLinksAcc( *this ).begin();
         TruthVertexLinks_t::iterator end =
            truthVertexLinksAcc( *this ).end();
         for( ; itr != end; ++itr ) {
            itr->toPersistent();
         }
      }
 
      return;
   }

◆ truthParticle()

const TruthParticle * xAOD::TruthEventBase_v1::truthParticle ( size_t index ) const

inherited

Get a pointer to one of the truth particles.

Definition at line 50 of file TruthEventBase_v1.cxx.

                                                                             {
 
      // Check if the variable is available:
      if( ! truthParticleLinksAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Check if the link is valid:
      const TruthParticleLinks_t& links = truthParticleLinksAcc( *this );
      if( ! links[ index ].isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *( links[ index ] );
   }

◆ truthParticleLink()

const TruthEventBase_v1::TruthParticleLink_t & xAOD::TruthEventBase_v1::truthParticleLink ( size_t index ) const

inherited

Get the link to one of the truth particles.

Definition at line 45 of file TruthEventBase_v1.cxx.

                                                            {
 
      return truthParticleLinksAcc( *this ).at( index );
   }

◆ truthParticleLinks()

const TruthParticleLinks_t & xAOD::TruthEventBase_v1::truthParticleLinks ( ) const

inherited

Get all the truth particles.

◆ truthVertex()

const TruthVertex * xAOD::TruthEventBase_v1::truthVertex ( size_t index ) const

inherited

Get a pointer to one of the truth vertices.

Definition at line 112 of file TruthEventBase_v1.cxx.

                                                                         {
 
      // Check if the variable is available:
      if( ! truthVertexLinksAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Check if the link is valid:
      const TruthVertexLinks_t& links = truthVertexLinksAcc( *this );
      if( ! links[ index ].isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *( links[ index ] );
   }

◆ truthVertexLink()

const TruthEventBase_v1::TruthVertexLink_t & xAOD::TruthEventBase_v1::truthVertexLink ( size_t index ) const

inherited

Get the link to one of the truth vertices.

Definition at line 107 of file TruthEventBase_v1.cxx.

                                                          {
 
      return truthVertexLinksAcc( *this ).at(index);
   }

◆ truthVertexLinks()

const TruthVertexLinks_t & xAOD::TruthEventBase_v1::truthVertexLinks ( ) const

inherited

Get all the truth vertices.

◆ type()

Type::ObjectType xAOD::TruthPileupEvent_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Todo: Some identifying info about the type of pile-up, bunch xing, etc.?

Implements xAOD::TruthEventBase_v1.

Definition at line 17 of file TruthPileupEvent_v1.cxx.

                                                  {
 
      return Type::TruthPileupEvent;
   }

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

Public Member Functions

Access to all the particles associated with the event

Access to all the vertices associated with the event

Detailed Description

Member Typedef Documentation

◆ TruthParticleLink_t

◆ TruthParticleLinks_t

◆ TruthVertexLink_t

◆ TruthVertexLinks_t

Constructor & Destructor Documentation

◆ TruthPileupEvent_v1()

Member Function Documentation

◆ addTruthParticleLink()

◆ addTruthVertexLink()

◆ clearTruthParticleLinks()

◆ clearTruthVertexLinks()

◆ nTruthParticles()

◆ nTruthVertices()

◆ setTruthParticleLinks()

◆ setTruthVertexLinks()

◆ toPersistent()

◆ truthParticle()

◆ truthParticleLink()

◆ truthParticleLinks()

◆ truthVertex()

◆ truthVertexLink()

◆ truthVertexLinks()

◆ type()