xAOD::TruthEvent_v1 Class Reference

Class describing a signal truth event in the MC record. More...

#include <TruthEvent_v1.h>

Inheritance diagram for xAOD::TruthEvent_v1:

Collaboration diagram for xAOD::TruthEvent_v1:

Classes
struct	PdfInfo
	Helper struct holding a full set of PDF info values. More...

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
	TruthEvent_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.
void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
const SG::AuxVectorData *	container () const
	Return the container holding this element.
SG::AuxVectorData *	container ()
	Return the container holding this element.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED 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.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED 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.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference.
void	makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	releasePrivateStore ()
	Release and free any private store associated with this object.
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore.
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore.
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface.
void	clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	hasStore () const
	Return true if this object has an associated store.
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	clearDecorations () const
	Clear all decorations.
bool	trackIndices () const
	Return true if index tracking is enabled for this object.
size_t	index () const
	Return the index of this element within its container.
Simple event properties
const std::vector< float > &	weights () const
	Const access to the weights vector.
void	setWeights (const std::vector< float > &weights)
	Set the event weights.
float	crossSection () const
	Get the cross section.
void	setCrossSection (float value)
	Set the cross-section.
float	crossSectionError () const
	Get the cross section error.
void	setCrossSectionError (float value)
	Set the cross-section error.
void	setCrossSection (float value, float error)
	Set the cross-section and its error.

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

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data.
bool	havePrivateData () const
	True if this element currently has private data.
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container.

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

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor.
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	clearAux ()
	Clear all aux data associated with this element.
void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object.
void	setNoPrivateData ()
	Record that this element does not have private data.
void	setHavePrivateData ()
	Record that this element currently has private data.
void	setHadPrivateData ()
	Record that this element used to have private data.

Static Private Member Functions
static void	clearAuxHelper (AuxVectorData &container, size_t index)
	Clear all aux data associated with an element.
static void	copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
	Copy aux data from another object.

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element.
size_t	m_index
	The index of this element within its container.
PrivateStoreState	m_privateStoreState

Parton density info
Optional due to particle gun & NLO events where a single PDF info doesn't work.
enum	PdfParam {   PDGID1 = 0 , PDGID2 = 1 , PDFID1 = 2 , PDFID2 = 3 ,   X1 = 4 , X2 = 5 , SCALE = 6 , Q = 6 ,   PDF1 = 7 , PDF2 = 8 , XF1 = 7 , XF2 = 8 }
	Accessor enums for PDF info parameter lookup. More...
bool	pdfInfoParameter (int &value, PdfParam parameter) const
	Read an integer PDF info parameter.
bool	pdfInfoParameter (float &value, PdfParam parameter) const
	Read a floating point PDF info parameter.
bool	setPdfInfoParameter (int value, PdfParam parameter)
	Set an integer PDF info parameter.
bool	setPdfInfoParameter (float value, PdfParam parameter)
	Set a floating point PDF info parameter.
PdfInfo	pdfInfo () const
	Retrieve a full PdfInfo with a single call.

Heavy ion info
enum	HIParam {   NCOLLHARD = 0 , NPARTPROJ = 1 , NPARTTARG = 2 , NCOLL = 3 ,   SPECTATORNEUTRONS = 4 , SPECTATORPROTONS = 5 , NNWOUNDEDCOLLISIONS = 6 , NWOUNDEDNCOLLISIONS = 7 ,   NWOUNDEDNWOUNDEDCOLLISIONS = 8 , IMPACTPARAMETER = 9 , EVENTPLANEANGLE = 10 , ECCENTRICITY = 11 ,   SIGMAINELNN = 12 , CENTRALITY = 13 }
	Heavy ion parameter enum. More...
bool	heavyIonParameter (int &value, HIParam parameter) const
	Read an integer HI parameter.
bool	heavyIonParameter (float &value, HIParam parameter) const
	Read a floating point HI parameter.
bool	setHeavyIonParameter (int value, HIParam parameter)
	Set an integer HI parameter.
bool	setHeavyIonParameter (float value, HIParam parameter)
	Set a floating point HI parameter.

Links to particles and vertices in the event
typedef ElementLink< TruthVertexContainer >	TruthVertexLink_t
	Type of the links pointing at truth vertices.
typedef ElementLink< TruthParticleContainer >	TruthParticleLink_t
	Type of the links pointing at truth particles.
const TruthVertex *	signalProcessVertex () const
	Pointer to a vertex representing the primary beam interaction point.
const TruthVertexLink_t &	signalProcessVertexLink () const
	Link to the vertex representing the primary beam interaction point.
void	setSignalProcessVertexLink (const TruthVertexLink_t &link)
	Set pointer to a vertex representing the primary beam interaction point.
std::pair< const TruthParticle *, const TruthParticle * >	beamParticles () const
	Pair of pointers to the two incoming beam particles.
void	setBeamParticleLinks (const TruthParticleLink_t &pcl1, const TruthParticleLink_t &pcl2)
	Set incoming beam particles.
const TruthParticleLink_t &	beamParticle1Link () const
	Get the link to the first incoming beam particle.
void	setBeamParticle1Link (const TruthParticleLink_t &pcl1)
	Set one incoming beam particle.
const TruthParticleLink_t &	beamParticle2Link () const
	Get the link to the second incoming beam particle.
void	setBeamParticle2Link (const TruthParticleLink_t &pcl2)
	Set one incoming beam particle.

Access to all the particles associated with the event
typedef std::vector< TruthParticleLink_t >	TruthParticleLinks_t
	Type of the truth particle links vector.
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.

Access to all the vertices associated with the event
typedef std::vector< TruthVertexLink_t >	TruthVertexLinks_t
	Type of the truth particle links vector.
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.

Detailed Description

Class describing a signal truth event in the MC record.

Author

Jovan Mitervski Jovan.nosp@m..Mit.nosp@m.revsk.nosp@m.i@ce.nosp@m.rn.ch

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

Revision

761796

Date

2016-07-14 10:06:02 +0200 (Thu, 14 Jul 2016)

Definition at line 35 of file TruthEvent_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 572 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 569 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 575 of file AuxElement.h.

TruthParticleLink_t

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

Type of the links pointing at truth particles.

Definition at line 177 of file TruthEvent_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::TruthEvent_v1::TruthVertexLink_t

Type of the links pointing at truth vertices.

Definition at line 163 of file TruthEvent_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.

TypelessConstAccessor

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

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

HIParam

enum xAOD::TruthEvent_v1::HIParam

Heavy ion parameter enum.

Enumerator
NCOLLHARD	[int]
NPARTPROJ	[int]
NPARTTARG	[int]
NCOLL	[int]
SPECTATORNEUTRONS	[int]
SPECTATORPROTONS	[int]
NNWOUNDEDCOLLISIONS	[int]
NWOUNDEDNCOLLISIONS	[int]
NWOUNDEDNWOUNDEDCOLLISIONS	[int]
IMPACTPARAMETER	[float]
EVENTPLANEANGLE	[float]
ECCENTRICITY	[float]
SIGMAINELNN	[float]
CENTRALITY	[float]

Definition at line 130 of file TruthEvent_v1.h.

                   {
         NCOLLHARD = 0,                  
         NPARTPROJ = 1,                  
         NPARTTARG = 2,                  
         NCOLL = 3,                      
         SPECTATORNEUTRONS = 4,          
         SPECTATORPROTONS = 5,           
         NNWOUNDEDCOLLISIONS = 6,        
         NWOUNDEDNCOLLISIONS = 7,        
         NWOUNDEDNWOUNDEDCOLLISIONS = 8, 
         IMPACTPARAMETER = 9,            
         EVENTPLANEANGLE = 10,           
         ECCENTRICITY = 11,              
         SIGMAINELNN = 12,               
         CENTRALITY = 13,                
      }; // enum HIParam

PdfParam

enum xAOD::TruthEvent_v1::PdfParam

Accessor enums for PDF info parameter lookup.

Enumerator
PDGID1	[int]
PDGID2	[int]
PDFID1	[int]
PDFID2	[int]
X1	[float]
X2	[float]
SCALE	Not implemented!!!
Q	[float]
PDF1	Not implemented!!!
PDF2	Not implemented!!!
XF1	[float]
XF2	[float]

Definition at line 74 of file TruthEvent_v1.h.

                    {
         PDGID1 = 0, 
         PDGID2 = 1, 
         PDFID1 = 2, 
         PDFID2 = 3, 
         X1 = 4,     
         X2 = 5,     
         SCALE = 6,  
         Q = 6,      
         PDF1 = 7,   
         PDF2 = 8,   
         XF1 = 7,    
         XF2 = 8     
      }; // enum PdfParam

PrivateStoreState

enum class 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

TruthEvent_v1()

xAOD::TruthEvent_v1::TruthEvent_v1

(

)

Default constructor.

Definition at line 20 of file TruthEvent_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;
   }

assign()

void SG::AuxElement::assign ( const AuxElement & other, bool warnUnlocked = false )

inherited

Assignment.

Parameters

other	The object from which we're assigning.
warnUnlocked	If true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

auxdata() [1/4]

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

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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.

beamParticle1Link()

const TruthParticleLink_t & xAOD::TruthEvent_v1::beamParticle1Link

(

)

const

Get the link to the first incoming beam particle.

beamParticle2Link()

const TruthParticleLink_t & xAOD::TruthEvent_v1::beamParticle2Link

(

)

const

Get the link to the second incoming beam particle.

beamParticles()

std::pair< const TruthParticle *, const TruthParticle * > xAOD::TruthEvent_v1::beamParticles

(

)

const

Pair of pointers to the two incoming beam particles.

Definition at line 226 of file TruthEvent_v1.cxx.

                                      {
 
      // Get the pointer to the first beam particle:
      const TruthParticle* p1 = nullptr;
      if( beamParticle1LinkAcc.isAvailable( *this ) ) {
         const TruthParticleLink_t& link = beamParticle1LinkAcc( *this );
         if( link.isValid() ) {
            p1 = *link;
         }
      }
 
      // Get the pointer to the second beam particle:
      const TruthParticle* p2 = nullptr;
      if( beamParticle2LinkAcc.isAvailable( *this ) ) {
         const TruthParticleLink_t& link = beamParticle2LinkAcc( *this );
         if( link.isValid() ) {
            p2 = *link;
         }
      }
 
      // Construct the returned object:
      return std::make_pair( p1, p2 );
   }

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 580 of file AuxElement.cxx.

{
  if (!m_container) return;
  clearAuxHelper (*container(), index());
}

clearAuxHelper()

void SG::AuxElement::clearAuxHelper ( AuxVectorData & container, size_t index )

staticprivateinherited

Clear all aux data associated with an element.

Parameters

container	Container of the element.
index	Index of this element within the container.

If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 639 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore()) {
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  }
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : 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 339 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 428 of file AuxElement.cxx.

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

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;
   }

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, bool warnUnlocked = false )

privateinherited

Copy aux data from another object.

Parameters

other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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 600 of file AuxElement.cxx.

{
  if (!m_container) return;
  copyAuxHelper (*container(), index(), other, warnUnlocked);
}

copyAuxHelper()

void SG::AuxElement::copyAuxHelper ( AuxVectorData & container, size_t index, const ConstAuxElement & other, bool warnUnlocked )

staticprivateinherited

Copy aux data from another object.

Parameters

container	Container of the element.
index	Index of this element within the container.
other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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 667 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    AuxElement::clearAuxHelper (container, index);
    return;
  }
 
#ifndef XAOD_STANDALONE
  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
#endif
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  size_t oindex = other.index();
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  for (SG::auxid_t auxid : other_ids) {
#ifndef XAOD_STANDALONE
    if (other_decors.test (auxid)) {
      // Don't copy decorations --- another thread may be modifying them.
      other_ids.reset (auxid);
      // Warn if we skip a decoration (except for mcEventWeights,
      // for which this is expected).
      if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
        std::ostringstream ss;
        ss << "skipped unlocked decoration " << r.getName(auxid)
           << " (" << auxid << ")";
        ATHCONTAINERS_WARNING("copyAux", ss.str());
      }
    }
    else
#endif
    if (!r.isLinked (auxid)) {
      r.copy (auxid, container, index, *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, container, index, 1);
    }
  }
}

crossSection()

float xAOD::TruthEvent_v1::crossSection

(

)

const

Get the cross section.

crossSectionError()

float xAOD::TruthEvent_v1::crossSectionError

(

)

const

Get the cross section error.

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 355 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 304 of file AuxElement.cxx.

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

getDecorIDs()

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

inherited

Return a set of identifiers for decorations 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 378 of file AuxElement.cxx.

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

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 319 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 411 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 398 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.

heavyIonParameter() [1/2]

bool xAOD::TruthEvent_v1::heavyIonParameter	(	float &	value,
		HIParam	parameter ) const

Read a floating point HI parameter.

Definition at line 150 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

heavyIonParameter() [2/2]

bool xAOD::TruthEvent_v1::heavyIonParameter	(	int &	value,
		HIParam	parameter ) const

Read an integer HI parameter.

Definition at line 138 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

index()

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

isAvailable()

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

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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>>

XAOD_AUXDATA_DEPRECATED 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 192 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, bool warnUnlocked = false )

inherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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, bool warnUnlocked = false )

inherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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, bool warnUnlocked )

privateinherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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 565 of file AuxElement.cxx.

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

makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * other, bool warnUnlocked )

privateinherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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.

noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

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.

pdfInfo()

TruthEvent_v1::PdfInfo xAOD::TruthEvent_v1::pdfInfo

(

)

const

Retrieve a full PdfInfo with a single call.

Note

May have invalid values – use valid() to check.

Definition at line 114 of file TruthEvent_v1.cxx.

                                                     {
 
      // The result object:
      PdfInfo rtn;
 
      // Retrieve all of its elements:
      pdfInfoParameter( rtn.pdgId1, PDGID1 );
      pdfInfoParameter( rtn.pdgId2, PDGID2 );
      pdfInfoParameter( rtn.pdfId1, PDFID1 );
      pdfInfoParameter( rtn.pdfId2, PDFID2 );
      pdfInfoParameter( rtn.x1,     X1 );
      pdfInfoParameter( rtn.x2,     X2 );
      pdfInfoParameter( rtn.Q,      Q );
      pdfInfoParameter( rtn.xf1,    XF1 );
      pdfInfoParameter( rtn.xf2,    XF2 );
 
      return rtn;
   }

pdfInfoParameter() [1/2]

bool xAOD::TruthEvent_v1::pdfInfoParameter	(	float &	value,
		PdfParam	parameter ) const

Read a floating point PDF info parameter.

Definition at line 63 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

pdfInfoParameter() [2/2]

bool xAOD::TruthEvent_v1::pdfInfoParameter	(	int &	value,
		PdfParam	parameter ) const

Read an integer PDF info parameter.

Definition at line 51 of file TruthEvent_v1.cxx.

                                                                      {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Get the value:
      value = ( *acc )( *this );
      return true;
   }

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 210 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 441 of file AuxElement.cxx.

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

setBeamParticle1Link()

void xAOD::TruthEvent_v1::setBeamParticle1Link

(

const TruthParticleLink_t &

pcl1

)

Set one incoming beam particle.

setBeamParticle2Link()

void xAOD::TruthEvent_v1::setBeamParticle2Link

(

const TruthParticleLink_t &

pcl2

)

Set one incoming beam particle.

setBeamParticleLinks()

void xAOD::TruthEvent_v1::setBeamParticleLinks	(	const TruthParticleLink_t &	pcl1,
		const TruthParticleLink_t &	pcl2 )

Set incoming beam particles.

Definition at line 250 of file TruthEvent_v1.cxx.

                                                                               {
 
      setBeamParticle1Link( pcl1 );
      setBeamParticle2Link( pcl2 );
      return;
   }

setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store

The new store.

setCrossSection() [1/2]

void xAOD::TruthEvent_v1::setCrossSection

(

float

value

)

Set the cross-section.

setCrossSection() [2/2]

void xAOD::TruthEvent_v1::setCrossSection	(	float	value,
		float	error )

Set the cross-section and its error.

setCrossSectionError()

void xAOD::TruthEvent_v1::setCrossSectionError

(

float

value

)

Set the cross-section error.

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.

setHeavyIonParameter() [1/2]

bool xAOD::TruthEvent_v1::setHeavyIonParameter	(	float	value,
		HIParam	parameter )

Set a floating point HI parameter.

Definition at line 174 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setHeavyIonParameter() [2/2]

bool xAOD::TruthEvent_v1::setHeavyIonParameter	(	int	value,
		HIParam	parameter )

Set an integer HI parameter.

Definition at line 162 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = heavyIonAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

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 505 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.

setPdfInfoParameter() [1/2]

bool xAOD::TruthEvent_v1::setPdfInfoParameter	(	float	value,
		PdfParam	parameter )

Set a floating point PDF info parameter.

Definition at line 87 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Float( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setPdfInfoParameter() [2/2]

bool xAOD::TruthEvent_v1::setPdfInfoParameter	(	int	value,
		PdfParam	parameter )

Set an integer PDF info parameter.

Definition at line 75 of file TruthEvent_v1.cxx.

                                                                   {
 
      // Look for the accessor object:
      const auto * acc = pdfInfoAccessorV1Int( information );
      if( ! acc ) return false;
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

setSignalProcessVertexLink()

void xAOD::TruthEvent_v1::setSignalProcessVertexLink

(

const TruthVertexLink_t &

link

)

Set pointer to a vertex representing the primary beam interaction point.

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 269 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 241 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 257 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 461 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;
  }
}

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.

setWeights()

void xAOD::TruthEvent_v1::setWeights

(

const std::vector< float > &

weights

)

Set the event weights.

Todo

Need to add named weight access: vector<string>

signalProcessVertex()

const TruthVertex * xAOD::TruthEvent_v1::signalProcessVertex

(

)

const

Pointer to a vertex representing the primary beam interaction point.

The naming of the function is a bit misleading. The returned vertex can only be interpreted as an interaction position.

Definition at line 195 of file TruthEvent_v1.cxx.

                                                               {
 
      // Check if the link variable is available:
      if( ! signalProcessVertexLinkAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Get the link:
      const TruthVertexLink_t& vertLink = signalProcessVertexLinkAcc( *this );
 
      // Check if it's valid:
      if( ! vertLink.isValid() ) {
         return nullptr;
      }
 
      // Return the de-referenced link:
      return *vertLink;
   }

signalProcessVertexLink()

const TruthVertexLink_t & xAOD::TruthEvent_v1::signalProcessVertexLink

(

)

const

Link to the vertex representing the primary beam interaction point.

toPersistent()

void xAOD::TruthEvent_v1::toPersistent

(

)

Function making sure that the object is ready for persistification.

Definition at line 274 of file TruthEvent_v1.cxx.

                                    {
 
      if( beamParticle1LinkAcc.isAvailableWritable( *this ) ) {
         beamParticle1LinkAcc( *this ).toPersistent();
      }
      if( beamParticle2LinkAcc.isAvailableWritable( *this ) ) {
         beamParticle2LinkAcc( *this ).toPersistent();
      }
      if( signalProcessVertexLinkAcc.isAvailableWritable( *this ) ) {
         signalProcessVertexLinkAcc( *this ).toPersistent();
      }
 
      TruthEventBase_v1::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.

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()

setBeamParticle2Link Type::ObjectType xAOD::TruthEvent_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::TruthEventBase_v1.

Definition at line 269 of file TruthEvent_v1.cxx.

                                            {
 
      return Type::TruthEvent;
   }

usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 280 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 290 of file AuxElement.cxx.

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

weights()

const std::vector< float > & xAOD::TruthEvent_v1::weights

(

)

const

Const access to the weights vector.

Todo

Need to add the map-like interface for the weights: very important!

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 335 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

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 959 of file AuxElement.h.

---

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

• TruthEvent_v1.h
• TruthEvent_v1.cxx