Class describing a truth vertex in the MC record. More...

#include <TruthVertex_v1.h>

Inheritance diagram for xAOD::TruthVertex_v1:

Collaboration diagram for xAOD::TruthVertex_v1:

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

Public Member Functions
	TruthVertex_v1 ()
	Default constructor. More...

Type::ObjectType	type () const
	The type of the object as a simple enumeration. More...

void	toPersistent ()
	Function making sure that the object is ready for persistification. More...

const SG::AuxVectorData *	container () const
	Return the container holding this element. More...

SG::AuxVectorData *	container ()
	Return the container holding this element. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...

void	makePrivateStore ()
	Create a new (empty) private store for this object. More...

template<class U1 >
void	makePrivateStore (const U1 &other)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other)
	Create a new private store for this object and copy aux data. More...

void	releasePrivateStore ()
	Release and free any private store associated with this object. More...

void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...

void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...

void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`. More...

void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`. More...

bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...

bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...

const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...

SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...

void	clearCache ()
	Clear the cached aux data pointers. More...

const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...

bool	hasStore () const
	Return true if this object has an associated store. More...

bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...

bool	clearDecorations () const
	Clear all decorations. More...

bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...

size_t	index () const
	Return the index of this element within its container. More...

size_t	index () const
	Return the index of this element within its container. More...

Functions identifying the vertex in the MC record
void	setId (int value)
	Obsolete function Set vertex ID code HepMC2 id == HepMC3 status, i.e. More...

int	id () const
	Obsolete function Vertex ID code HepMC2 id == HepMC3 status, i.e. More...

int	status () const
	New function Vertex status HepMC2 id == HepMC3 status, i.e. More...

void	setStatus (int value)
	New function Set vertex status HepMC2 id == HepMC3 status, i.e. More...

void	setBarcode (int value)
	Set barcode. More...

int	barcode () const
	Barcode. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...

bool	havePrivateData () const
	True if this element currently has private data. More...

bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...

void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

void	makePrivateStore1 (const void *)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other)
	Create a new private store for this object and copy aux data. More...

AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	clearAux ()
	Clear all aux data associated with this element. More...

void	copyAux (const ConstAuxElement &other)
	Copy aux data from another object. More...

void	setNoPrivateData ()
	Record that this element does not have private data. More...

void	setHavePrivateData ()
	Record that this element currently has private data. More...

void	setHadPrivateData ()
	Record that this element used to have private data. More...

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...

size_t	m_index
	The index of this element within its container. More...

PrivateStoreState	m_privateStoreState

Links to the particles associated with this vertex
typedef ElementLink< TruthParticleContainer >	TPLink_t
	Type of one truth particle link. More...

typedef std::vector< TPLink_t >	TPLinks_t
	Type used to save the links to incoming and outgoing particles. More...

const TPLinks_t &	incomingParticleLinks () const
	Get all the incoming particles. More...

void	setIncomingParticleLinks (const TPLinks_t &links)
	Set all the incoming particles. More...

size_t	nIncomingParticles () const
	Get the number of incoming particles. More...

const TruthParticle_v1 *	incomingParticle (size_t index) const
	Get one of the incoming particles. More...

void	addIncomingParticleLink (const TPLink_t &link)
	Add one incoming particle. More...

void	clearIncomingParticleLinks ()
	Remove all incoming particles. More...

const TPLinks_t &	outgoingParticleLinks () const
	Get all the outgoing particles. More...

void	setOutgoingParticleLinks (const TPLinks_t &links)
	Set all the outgoing particles. More...

size_t	nOutgoingParticles () const
	Get the number of outgoing particles. More...

const TruthParticle_v1 *	outgoingParticle (size_t index) const
	Get one of the outgoing particles. More...

std::vector< const TruthParticle * >	particles_in () const
	Get the incoming particles. More...

std::vector< const TruthParticle * >	particles_out () const
	Get the outgoing particles. More...

void	addOutgoingParticleLink (const TPLink_t &link)
	Add one outgoing particle. More...

void	clearOutgoingParticleLinks ()
	Remove all outgoing particles. More...

Vertex position functions
typedef TLorentzVector	FourVec_t
	The 4-vector type. More...

typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzE4D< double > >	GenVecFourVec_t
	Base 4 Momentum type for TruthVector. More...

float	x () const
	Vertex x displacement. More...

void	setX (float value)
	Set the x displacement of the vertex. More...

float	y () const
	Vertex y displacement. More...

void	setY (float value)
	Set the y displacement of the vertex. More...

float	z () const
	Vertex longitudinal distance along the beam line form the origin. More...

void	setZ (float value)
	Set the vertex's longitudinal distance from the origin. More...

float	perp () const
	Vertex transverse distance from the beam line. More...

float	eta () const
	Vertex pseudorapidity. More...

float	phi () const
	Vertex azimuthal angle. More...

float	t () const
	Vertex time. More...

void	setT (float value)
	Set the vertex time. More...

FourVec_t	v4 () const
	The full 4-vector of the vertex. More...

GenVecFourVec_t	genvecV4 () const
	The full 4-vector of the particle : GenVector form. More...

Detailed Description

Class describing a truth vertex in the MC record.

The xAOD truth record mimicks the structure of HepMC. Truth particles and truth vertices form a decay tree. Where each truth particle is connected to a single production and decay vertex. And each vertex is connected to one or more incoming, and one or more outgoing particles.

Author: Andy Buckley Andy..nosp@m.Buck.nosp@m.ley@c.nosp@m.ern..nosp@m.ch

Revision: 624338

Date: 2014-10-27 16:08:55 +0100 (Mon, 27 Oct 2014)

Definition at line 41 of file TruthVertex_v1.h.

Member Typedef Documentation

◆ Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 522 of file AuxElement.h.

◆ ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 519 of file AuxElement.h.

◆ Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 525 of file AuxElement.h.

◆ FourVec_t

typedef TLorentzVector xAOD::TruthVertex_v1::FourVec_t

The 4-vector type.

Definition at line 143 of file TruthVertex_v1.h.

◆ GenVecFourVec_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > xAOD::TruthVertex_v1::GenVecFourVec_t

Base 4 Momentum type for TruthVector.

Definition at line 149 of file TruthVertex_v1.h.

◆ TPLink_t

typedef ElementLink< TruthParticleContainer > xAOD::TruthVertex_v1::TPLink_t

Type of one truth particle link.

Definition at line 76 of file TruthVertex_v1.h.

◆ TPLinks_t

typedef std::vector< TPLink_t > xAOD::TruthVertex_v1::TPLinks_t

Type used to save the links to incoming and outgoing particles.

Definition at line 78 of file TruthVertex_v1.h.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 516 of file AuxElement.h.

Member Enumeration Documentation

◆ PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

   {
     NO_PRIVATE = 0,
     HAVE_PRIVATE = 1,
     HAD_PRIVATE = 2,
   };

Constructor & Destructor Documentation

◆ TruthVertex_v1()

xAOD::TruthVertex_v1::TruthVertex_v1 ( )

Default constructor.

Definition at line 19 of file TruthVertex_v1.cxx.

    : SG::AuxElement() {
  
    }

Member Function Documentation

◆ addIncomingParticleLink()

void xAOD::TruthVertex_v1::addIncomingParticleLink ( const TPLink_t & link )

Add one incoming particle.

Definition at line 89 of file TruthVertex_v1.cxx.

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

◆ addOutgoingParticleLink()

void xAOD::TruthVertex_v1::addOutgoingParticleLink ( const TPLink_t & link )

Add one outgoing particle.

Definition at line 139 of file TruthVertex_v1.cxx.

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

◆ auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdata() [3/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata	(	const std::string &	name,
		const std::string &	clsname
	)

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [4/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ barcode()

int xAOD::TruthVertex_v1::barcode ( ) const

Barcode.

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 535 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     r.clear (auxid, *container(), index(), 1);
   }
 }

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 319 of file AuxElement.cxx.

 {
   if (container())
     container()->clearCache();
 }

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 385 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->clearDecorations();
   return false;
 }

◆ clearIncomingParticleLinks()

void xAOD::TruthVertex_v1::clearIncomingParticleLinks ( )

Remove all incoming particles.

Definition at line 95 of file TruthVertex_v1.cxx.

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

◆ clearOutgoingParticleLinks()

void xAOD::TruthVertex_v1::clearOutgoingParticleLinks ( )

Remove all outgoing particles.

Definition at line 145 of file TruthVertex_v1.cxx.

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

◆ container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement & other )

privateinherited

Copy aux data from another object.

Parameters

other The object from which to copy.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 561 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("copyAux");
  
   const SG::AuxVectorData* ocont = other.container();
  
   if (!ocont || !ocont->hasStore()) {
     this->clearAux();
     return;
   }
  
   size_t oindex = other.index();
   SG::auxid_set_t other_ids = ocont->getAuxIDs();
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
     r.copy (auxid, cont, index(), *ocont, oindex, 1);
   }
  
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     if (!other_ids.test (auxid)) {
       r.clear (auxid, cont, index(), 1);
     }
   }
 }

◆ eta()

float xAOD::TruthVertex_v1::eta ( ) const

Vertex pseudorapidity.

Definition at line 172 of file TruthVertex_v1.cxx.

                                    {
  
       // This is not necessarily what Andy was thinking about...
       return genvecV4().Eta();
    }

◆ genvecV4()

TruthVertex_v1::GenVecFourVec_t xAOD::TruthVertex_v1::genvecV4 ( ) const

The full 4-vector of the particle : GenVector form.

Definition at line 190 of file TruthVertex_v1.cxx.

                                                                 {
       return GenVecFourVec_t(x(), y(), z(), t());
    }

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 335 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getAuxIDs();
   if (container())
     return container()->getAuxIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getAuxIDs();
 #endif
 }

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 284 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
     return m_container->getConstStore();
   }
   return 0;
 }

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 299 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
 #ifdef ATHCONTAINERS_R21_COMPAT
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
 #else
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
 #endif
     return container_nc->getStore();
   }
   return 0;
 }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 368 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasNonConstStore();
   return false;
 }

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 355 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasStore();
   return false;
 }

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ id()

int xAOD::TruthVertex_v1::id ( ) const

Obsolete function Vertex ID code HepMC2 id == HepMC3 status, i.e.

physical status.

◆ incomingParticle()

const TruthParticle * xAOD::TruthVertex_v1::incomingParticle ( size_t index ) const

Get one of the incoming particles.

Definition at line 71 of file TruthVertex_v1.cxx.

                                                                              {
  
       // Check that the variable exists, and that it has enough elements in it:
       if( ( ! incomingParticleLinksAcc.isAvailable( *this ) ) ||
           ( incomingParticleLinksAcc( *this ).size() <= index ) ) {
          return nullptr;
       }
  
       // Retrieve the link object and check its validity:
       const TPLink_t& ipl = incomingParticleLinksAcc( *this )[ index ];
       if( ! ipl.isValid() ) {
          return nullptr;
       }
  
       // Finally, de-reference the link:
       return *ipl;
    }

◆ incomingParticleLinks()

const TPLinks_t& xAOD::TruthVertex_v1::incomingParticleLinks ( ) const

Get all the incoming particles.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ isAvailable()

template<class T , class ALLOC = AuxAllocator_t<T>>

bool SG::AuxElement::isAvailable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inherited

Check if an aux variable is available for reading.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritable()

template<class T , class ALLOC = AuxAllocator_t<T>>

bool SG::AuxElement::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

bool SG::AuxElement::isAvailableWritableAsDecoration	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 172 of file AuxElement.cxx.

 {
   if (m_container) {
     throw SG::ExcBadPrivateStore ("store already exists");
   }
  
   m_container = new SG::AuxElementPrivateData;
   IAuxElement::setIndex (0);
   IAuxElement::setHavePrivateData();
 }

◆ makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 & other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 * other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement * other )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 521 of file AuxElement.cxx.

 {
   makePrivateStore();
   if (other)
     this->copyAux (*other);
 }

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

◆ nIncomingParticles()

size_t xAOD::TruthVertex_v1::nIncomingParticles ( ) const

Get the number of incoming particles.

Definition at line 49 of file TruthVertex_v1.cxx.

                                                    {
    
       // Check if the variable is available:
       if( ! incomingParticleLinksAcc.isAvailable( *this ) ) {
          // If not, just tell the user that there aren't any incoming particles:
          return 0;
       }
  
       // Return the size of the vector:
       return incomingParticleLinksAcc( *this ).size();
    }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nOutgoingParticles()

size_t xAOD::TruthVertex_v1::nOutgoingParticles ( ) const

Get the number of outgoing particles.

◆ outgoingParticle()

const TruthParticle * xAOD::TruthVertex_v1::outgoingParticle ( size_t index ) const

Get one of the outgoing particles.

Definition at line 121 of file TruthVertex_v1.cxx.

                                                                              {
  
       // Check that the variable exists, and that it has enough elements in it:
       if( ( ! outgoingParticleLinksAcc.isAvailable( *this ) ) ||
           ( outgoingParticleLinksAcc( *this ).size() <= index ) ) {
          return nullptr;
       }
  
       // Retrieve the link object and check its validity:
       const TPLink_t& opl = outgoingParticleLinksAcc( *this )[ index ];
       if( ! opl.isValid() ) {
          return nullptr;
       }
       
       // Finally, de-reference the link:
       return *opl;
    }

◆ outgoingParticleLinks()

const TPLinks_t& xAOD::TruthVertex_v1::outgoingParticleLinks ( ) const

Get all the outgoing particles.

◆ particles_in()

std::vector< const TruthParticle * > xAOD::TruthVertex_v1::particles_in ( ) const

Get the incoming particles.

Definition at line 61 of file TruthVertex_v1.cxx.

                                                                       {
      std::vector<const TruthParticle*> res;
      for (size_t i=0; i<nIncomingParticles();i++) res.push_back(incomingParticle(i)); 
      return res;
    }

◆ particles_out()

std::vector< const TruthParticle * > xAOD::TruthVertex_v1::particles_out ( ) const

Get the outgoing particles.

Definition at line 66 of file TruthVertex_v1.cxx.

                                                                        {
      std::vector<const TruthParticle*> res;
      for (size_t i=0; i<nOutgoingParticles();i++) res.push_back(outgoingParticle(i)); 
      return res;
    }

◆ perp()

float xAOD::TruthVertex_v1::perp ( ) const

Vertex transverse distance from the beam line.

Definition at line 165 of file TruthVertex_v1.cxx.

                                     {
  
       // Do the calculation by hand. Could make it faster than this even in a
       // future iteration...
       return std::sqrt( x() * x() + y() * y() );
    }

◆ phi()

float xAOD::TruthVertex_v1::phi ( ) const

Vertex azimuthal angle.

Definition at line 178 of file TruthVertex_v1.cxx.

                                    {
  
       // This is not necessarily what Andy was thinking about...
       return genvecV4().Phi();
    }

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 190 of file AuxElement.cxx.

 {
   if (hadPrivateData()) {
     // We had a private store, but it was released because this object
     // was added to a container.  Just forget about it.
     IAuxElement::setNoPrivateData();
     return;
   }
  
   if (!havePrivateData() ||
       !m_container ||
       typeid(*m_container) != typeid(AuxElementPrivateData))
   {
     throw SG::ExcBadPrivateStore ("no private store exists");
   }
  
   IAuxElement::setIndex (0);
   IAuxElement::setNoPrivateData();
   delete m_container;
   m_container = 0;
 }

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 398 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData()) {
     delete m_container;
   }
 #else
   ConstAuxElement::releasePrivateStoreForDtor();
 #endif
 }

◆ setBarcode()

void xAOD::TruthVertex_v1::setBarcode ( int value )

Set barcode.

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setId()

void xAOD::TruthVertex_v1::setId ( int value )

Obsolete function Set vertex ID code HepMC2 id == HepMC3 status, i.e.

physical status.

◆ setIncomingParticleLinks()

void xAOD::TruthVertex_v1::setIncomingParticleLinks ( const TPLinks_t & links )

Set all the incoming particles.

◆ setIndex()

void SG::AuxElement::setIndex	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 462 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (hadPrivateData()) {
     // We had a private store, but it was released because we were added
     // to a container.
  
     if (container == 0) {
       // We're being moved out of the container.  Make a new private
       // store, copy the data, and switch to it.
       auto privateData = new SG::AuxElementPrivateData;
       AuxElement to (privateData, 0);
       to.copyAux (*this);
       IAuxElement::setIndex (0);
       IAuxElement::setHavePrivateData();
       m_container = privateData;
       return true;
     }
   }
   else if (havePrivateData() &&
            typeid(*m_container) == typeid(AuxElementPrivateData))
   {
     // We currently have a private store.
  
     if (container != 0 && container != m_container) {
       // We're being added to a container.
       // Aux data has already been copied.
       // Release private store.
       IAuxElement::setIndex (index);
       IAuxElement::setHadPrivateData();
       delete m_container;
       m_container = container;
       return false;
     }
   }
   else {
     // We have a standalone store.
     throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                   "from a container.");
   }
  
   IAuxElement::setIndex (index);
   m_container = container;
   return false;
 #else
   return ConstAuxElement::setIndexPrivate (index, container);
 #endif
 }

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ setOutgoingParticleLinks()

void xAOD::TruthVertex_v1::setOutgoingParticleLinks ( const TPLinks_t & links )

Set all the outgoing particles.

◆ setStatus()

void xAOD::TruthVertex_v1::setStatus ( int value )

inline

New function Set vertex status HepMC2 id == HepMC3 status, i.e.

physical status.

Definition at line 63 of file TruthVertex_v1.h.

63 { setId(value); }

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store Link to the new store.

Definition at line 249 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 221 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 237 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 418 of file AuxElement.cxx.

 {
   if (store) {
     // Want this object be standalone.
     if (!m_container) {
       // Not in a container (and no private store).  Make a new object.
       AuxElementStandaloneData* data = new AuxElementStandaloneData;
       IAuxElement::setHavePrivateData();
       m_container = data;
       return data;
     }
     if (usingStandaloneStore()) {
       // Standalone --- return existing object.
       return static_cast<AuxElementStandaloneData*> (container());
     }
     // Otherwise, it's an error.
     throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                               "object in a container or with a private store.");
   }
  
   else {
     // Getting rid of a standalone store.
     if (usingStandaloneStore()) {
       IAuxElement::setNoPrivateData();
       delete m_container;
       m_container = 0;
     }
     else if (m_container != 0)
       throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                 "object in a container or with a private store.");
     return 0;
   }
 }

◆ setT()

void xAOD::TruthVertex_v1::setT ( float value )

Set the vertex time.

◆ setX()

void xAOD::TruthVertex_v1::setX ( float value )

Set the x displacement of the vertex.

◆ setY()

void xAOD::TruthVertex_v1::setY ( float value )

Set the y displacement of the vertex.

◆ setZ()

void xAOD::TruthVertex_v1::setZ ( float value )

Set the vertex's longitudinal distance from the origin.

◆ status()

int xAOD::TruthVertex_v1::status ( ) const

inline

New function Vertex status HepMC2 id == HepMC3 status, i.e.

physical status.

Definition at line 59 of file TruthVertex_v1.h.

59 { return id(); }

◆ t()

float xAOD::TruthVertex_v1::t ( ) const

Vertex time.

◆ toPersistent()

void xAOD::TruthVertex_v1::toPersistent ( )

Function making sure that the object is ready for persistification.

Definition at line 202 of file TruthVertex_v1.cxx.

                                      {
  
       // Prepare the incoming particle links for persistification:
       if( incomingParticleLinksAcc.isAvailableWritable( *this ) ) {
          TPLinks_t::iterator itr = incomingParticleLinksAcc( *this ).begin();
          TPLinks_t::iterator end = incomingParticleLinksAcc( *this ).end();
          for( ; itr != end; ++itr ) {
             itr->toPersistent();
          }
       }
  
       // Prepare the outgoing particle links for persistification:
       if( outgoingParticleLinksAcc.isAvailableWritable( *this ) ) {
          TPLinks_t::iterator itr = outgoingParticleLinksAcc( *this ).begin();
          TPLinks_t::iterator end = outgoingParticleLinksAcc( *this ).end();
          for( ; itr != end; ++itr ) {
             itr->toPersistent();
          }
       }
  
       return;
    }

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

◆ type()

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

The type of the object as a simple enumeration.

Definition at line 197 of file TruthVertex_v1.cxx.

                                              {
  
       return Type::TruthVertex;
    }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 260 of file AuxElement.cxx.

 {
   return havePrivateData() && 
     typeid(*m_container) == typeid(AuxElementPrivateData);
 }

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 270 of file AuxElement.cxx.

 {
   return havePrivateData() &&
     typeid(*m_container) == typeid(AuxElementStandaloneData);
 }

◆ v4()

TruthVertex_v1::FourVec_t xAOD::TruthVertex_v1::v4 ( ) const

The full 4-vector of the vertex.

Definition at line 186 of file TruthVertex_v1.cxx.

                                                     {
       return FourVec_t(x(), y(), z(), t());
    }

◆ x()

float xAOD::TruthVertex_v1::x ( ) const

Vertex x displacement.

◆ y()

float xAOD::TruthVertex_v1::y ( ) const

Vertex y displacement.

◆ z()

float xAOD::TruthVertex_v1::z ( ) const

Vertex longitudinal distance along the beam line form the origin.

Member Data Documentation

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 298 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 883 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Links to the particles associated with this vertex

Vertex position functions

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ FourVec_t

◆ GenVecFourVec_t

◆ TPLink_t

◆ TPLinks_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ TruthVertex_v1()

Member Function Documentation

◆ addIncomingParticleLink()

◆ addOutgoingParticleLink()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ barcode()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ clearIncomingParticleLinks()

◆ clearOutgoingParticleLinks()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ eta()

◆ genvecV4()

◆ getAuxIDs()

◆ getConstStore()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ id()

◆ incomingParticle()

◆ incomingParticleLinks()

◆ index() [1/2]

◆ index() [2/2]

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ nIncomingParticles()

◆ noPrivateData()

◆ nOutgoingParticles()

◆ outgoingParticle()

◆ outgoingParticleLinks()

◆ particles_in()

◆ particles_out()

◆ perp()

◆ phi()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()

◆ setBarcode()

◆ setConstStore()

◆ setHadPrivateData()

◆ setHavePrivateData()