MET component descriptor contains object links and corresponding parameters. More...

#include <MissingETComponent_v1.h>

Inheritance diagram for xAOD::MissingETComponent_v1:

Collaboration diagram for xAOD::MissingETComponent_v1:

Classes
class	Weight
	Kinematic weight descriptor. 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

MissingETComponent_v1 (bool createStore=false)

Default constructor. More...

MissingETComponent_v1 (const MissingET *pmetObj, MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Construct with a link to a MissingET object. More...

MissingETComponent_v1 (const MissingET *pmetObj, const IParticle *pPart, const Weight &wght=Weight(), MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Construct with a link to a MissingET and a link to an IParticle object, and a Weight. More...

MissingETComponent_v1 (const MissingET *pmetObj, const IParticle *pPart, double wpx, double wpy, double wet, MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Construct with a link to a MissingET and a link to an IParticle object, and indivdual numerical weight components. More...

MissingETComponent_v1 (const MissingETComponent_v1 &compDescr)

Copy constructor. More...

MissingETComponent_v1 (const MissingETComponent_v1 &compDescr, MissingETBase::Types::bitmask_t sw)

Copy constructor with new status word. More...

MissingETComponent_v1 & operator= (const MissingETComponent_v1 &compDescr)

virtual ~MissingETComponent_v1 ()

Assignment operator. 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>>

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

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

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

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

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

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

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

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

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

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

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

Set MET object

Base class destructor

bool setMET (const MissingET *pmetObj, MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Set MET object by object pointer reference. More...

bool setMET (const MissingETContainer_v1 *pmetCont, size_t pmedIdx, MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Set MET object by container pointer and index reference. More...

Adding data to the MET component description

bool addObject (const IParticle *pPart, const Weight &wght=Weight())

Add object (particle) from pointer reference with optional kinematic weight. More...

bool addObject (const IParticle *pPart, double wpx, double wpy, double wet)

Add object (particle) from pointer reference with individual kinematic weight components. More...

Conventional and dedicated getter and setters

const std::vector< double > & wpx () const

Get the vector of \( w_{x} \) weight components
More...

double wpx (const IParticle *pPart) const

Get the weight component \( w_{x} \) for a given object referenced by pointer. More...

double wpx (size_t pIdx) const

Get the weight component \( w_{x} \) for a given object referenced by index. More...

bool setWpx (const std::vector< double > &wcv)

Set the vector of \( w_{x} \) weight components
More...

bool setWpx (const IParticle *pPart, double wpx)

Set kinematic weight component \( w_{x} \) for a given contributing object referenced by pointer. More...

bool setWpx (size_t pIdx, double wpx)

Set kinematic weight component \( w_{x} \) for a given contributing object referenced by index. More...

const std::vector< double > & wpy () const

Get the vector of \( w_{y} \) weight components
More...

double wpy (const IParticle *pPart) const

Get the weight component \( w_{y} \) for a given object referenced by pointer. More...

double wpy (size_t pIdx) const

Get the weight component \( w_{y} \) for a given object referenced by index. More...

bool setWpy (const std::vector< double > &wpyVector)

Set the vector of \( w_{y} \) weight components
More...

bool setWpy (const IParticle *pPart, double wpy)

Set kinematic weight component \( w_{y} \) for a given contributing object referenced by pointer. More...

bool setWpy (size_t pIdx, double wpy)

Set kinematic weight component \( w_{y} \) for a given contributing object referenced by index. More...

const std::vector< double > & wet () const

Get the vector of \( w_{\rm T} \) weight components
More...

double wet (const IParticle *pPart) const

Get the weight component \( w_{\rm T} \) for a given object referenced by pointer. More...

double wet (size_t pIdx) const

Get the weight component \( w_{\rm T} \) for a given object referenced by index. More...

bool setWet (const std::vector< double > &wcv)

Set the vector of \( w_{\rm T} \) weight components
More...

bool setWet (const IParticle *pPart, double wet)

Set kinematic weight \( w_{\rm T} \) for a given contributing object referenced by pointer. More...

bool setWet (size_t pIdx, double wet)

Set kinematic weight \( w_{\rm T} \) for a given contributing object referenced by index. More...

bool setWeight (const IParticle *pPart, const Weight &wght=Weight())

Set the kinematic weight of an object contribution referenced by pointer. More...

bool setWeight (const IParticle *pPart, double wpx, double wpy, double wet)

Set the kinematic weight components of an object contribution referenced by pointer. More...

bool setWeight (size_t pIdx, const Weight &wght=Weight())

Set the kinematic weight of an object contribution referenced by index. More...

bool setWeight (size_t pIdx, double wpx, double wpy, double wet)

Set the kinematic weight components of an object contribution referenced by index. More...

const MissingETBase::Types::metlink_t & metLink () const

Get the link to the MET object. More...

bool setMetLink (const MissingETBase::Types::metlink_t &metLnk)

Set the link to the MET object. More...

const MissingETBase::Types::objlink_vector_t & objectLinks () const

Get the vector of links to the contributing physics or signal objects. More...

bool setObjectLinks (const MissingETBase::Types::objlink_vector_t &objLnks)

Set the vector of links to the contributing physics or signal objects. More...

MissingETBase::Types::bitmask_t statusWord () const

Get the statusword. More...

bool setStatusWord (MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

Set the statusword of a MET term. More...

Specific methods for manipulating the component description data

bool removeContrib (const IParticle *pPart)

Remove a contribution referenced by an object pointer. More...

bool removeContrib (size_t pIdx)

Remove a contribution referenced by an index. More...

bool removeContrib ()

Remove all contributions. More...

bool resetContrib (const IParticle *pPart)

Reset the contribution parameters of an object referenced by a pointer. More...

bool resetContrib (size_t pIdx)

Reset the contribution parameters of an object referenced by an index. More...

bool resetContrib ()

Reset all contribution parameters. More...

bool mergeStatusWord (MissingETBase::Types::bitmask_t sw)

Merge patterns into the MET term status. More...

bool clearStatusWord ()

Clear statusword. More...

Dedicated accessors for linked objects

const MissingET * metObject () const

Access MET object. More...

const MissingETContainer_v1 * metObjectContainer () const

Access MET object container holding MET object. More...

size_t metObjectIndex () const

Access index of MET object in its container. More...

std::vector< const IParticle * > objects () const

Access contributing objects. More...

std::vector< const IParticle * > objects (std::vector< Weight > &kinePars) const

Access contributing objects and retrieve kinematic weights. More...

std::vector< const IParticle * > objects (const std::vector< double > *&wpxPtr, const std::vector< double > *&wpyPtr, const std::vector< double > *&wetPtr) const

Access contributing objects and retrieve kinematic weight components. More...

Weight weight (const IParticle *pPart) const

Get kinematic weight for a given object. More...

Weight weight (size_t pIdx) const

Get kinematic weight for a given entry (index) in the contributing object list. More...

Allocating and accessing objects in the contribution

size_t findIndex (const IParticle *pPart) const

Find index of given object in contributing object store. More...

List management and information

size_t size () const

[Deprecated] Update all internally used ElementLink instances More...

bool empty () const

Empty list of contributing objects indicator. More...

Comparators

Parameters

[in] contrib reference to non-modifiable contribution object to compare to.

bool operator== (const MissingETComponent_v1 &contrib) const

bool operator!= (const MissingETComponent_v1 &contrib) const

Equality. More...

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

Protected Member Functions
void	createPrivateStore ()
	Function initialising the object to work in standalone mode. More...

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

Internal non-const accessors
The underlying data model uses the auxiliary store MissingETAuxComposition_v1, which only employs low level data structures and ElementLinks. The accessors forward their specific request to static accessors, which retrieve the data by internally used names.
MissingETBase::Types::objlink_vector_t &	f_objectLinks ()
	Non-const link reference. More...

MissingETBase::Types::metlink_t &	f_metLink ()
	Non-const link reference More...

std::vector< double > &	f_wpx ()

std::vector< double > &	f_wpy ()

std::vector< double > &	f_wet ()

MissingETBase::Types::bitmask_t &	f_statusWord ()

Helpers
bool	f_removeContrib (size_t pIdx)
	Copy the contribution data from a source. More...

void	copyData (const MissingETComponent_v1 &compDescr, MissingETBase::Types::bitmask_t sw=MissingETBase::Status::clearedStatus())

template<class POBJ , class LINK >
void	f_setObject (const POBJ *pObj, LINK &elemLink)
	Generalized link manager. More...

template<class LINK >
bool	f_setLink (LINK &elemLink)

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

Detailed Description

MET component descriptor contains object links and corresponding parameters.

Definition at line 23 of file MissingETComponent_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 548 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 545 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 551 of file AuxElement.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 542 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

◆ MissingETComponent_v1() [1/6]

MissingETComponent_v1::MissingETComponent_v1 ( bool createStore = false )

Default constructor.

Definition at line 56 of file MissingETComponent_v1.cxx.

    : SG::AuxElement(){
  
    if( createStore ) createPrivateStore();
 }

◆ MissingETComponent_v1() [2/6]

MissingETComponent_v1::MissingETComponent_v1	(	const MissingET *	pmetObj,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

Construct with a link to a MissingET object.

Definition at line 62 of file MissingETComponent_v1.cxx.

    : SG::AuxElement(){
  
    createPrivateStore();
    setMET( pmetObj );
    setStatusWord( sw );
 }

◆ MissingETComponent_v1() [3/6]

MissingETComponent_v1::MissingETComponent_v1	(	const MissingET *	pmetObj,
		const IParticle *	pPart,
		const Weight &	wght = `Weight()`,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

Construct with a link to a MissingET and a link to an IParticle object, and a Weight.

Definition at line 83 of file MissingETComponent_v1.cxx.

    : SG::AuxElement(){
  
    createPrivateStore();
    setMET( pmetObj );
    setStatusWord( sw );
    addObject( pPart, wght );
 }

◆ MissingETComponent_v1() [4/6]

MissingETComponent_v1::MissingETComponent_v1	(	const MissingET *	pmetObj,
		const IParticle *	pPart,
		double	wpx,
		double	wpy,
		double	wet,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

Construct with a link to a MissingET and a link to an IParticle object, and indivdual numerical weight components.

Definition at line 71 of file MissingETComponent_v1.cxx.

    : SG::AuxElement(){
  
    createPrivateStore();
    setMET( pmetObj );
    setStatusWord( sw );
    addObject( pPart, wpx, wpy, wet );
 }

◆ MissingETComponent_v1() [5/6]

MissingETComponent_v1::MissingETComponent_v1 ( const MissingETComponent_v1 & compDescr )

Copy constructor.

Definition at line 95 of file MissingETComponent_v1.cxx.

96 : SG::AuxElement(compDescr)

97 { this->makePrivateStore(&compDescr); }

◆ MissingETComponent_v1() [6/6]

MissingETComponent_v1::MissingETComponent_v1	(	const MissingETComponent_v1 &	compDescr,
		MissingETBase::Types::bitmask_t	sw
	)

Copy constructor with new status word.

Definition at line 99 of file MissingETComponent_v1.cxx.

100 : SG::AuxElement()

101 { this->makePrivateStore(compDescr); this->setStatusWord(sw); }

◆ ~MissingETComponent_v1()

MissingETComponent_v1::~MissingETComponent_v1 ( )

virtual

Assignment operator.

Definition at line 116 of file MissingETComponent_v1.cxx.

116 { }

Member Function Documentation

◆ addObject() [1/2]

bool xAOD::MissingETComponent_v1::addObject	(	const IParticle *	pPart,
		const Weight &	wght = `Weight()`
	)

Add object (particle) from pointer reference with optional kinematic weight.

◆ addObject() [2/2]

bool MissingETComponent_v1::addObject	(	const IParticle *	pPart,
		double	wpx,
		double	wpy,
		double	wet
	)

Add object (particle) from pointer reference with individual kinematic weight components.

Definition at line 122 of file MissingETComponent_v1.cxx.

 {
   // check if object is in store
   size_t idx(this->findIndex(pPart));
   // found - add weights
   if ( idx != MissingETBase::Numerical::invalidIndex() )
     { this->f_wpx()[idx] += wpx; this->f_wpy()[idx] += wpy; this->f_wet()[idx] += wet; return false; }
   // new object
   else
     {
       MissingETBase::Types::objlink_t oLnk; f_setObject<IParticle,MissingETBase::Types::objlink_t>(pPart,oLnk); 
       // add to stores
       this->f_objectLinks().push_back(oLnk);this->f_wpx().push_back(wpx);this->f_wpy().push_back(wpy);this->f_wet().push_back(wet);
       bool linkset = f_setLink<MissingETBase::Types::objlink_t>(oLnk);
       return linkset;
     }
 }

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

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

◆ clearStatusWord()

bool xAOD::MissingETComponent_v1::clearStatusWord ( )

Clear statusword.

◆ 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) {
     if (!r.isLinked (auxid)) {
       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);
     }
   }
 }

◆ copyData()

void xAOD::MissingETComponent_v1::copyData	(	const MissingETComponent_v1 &	compDescr,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

protected

◆ createPrivateStore()

void MissingETComponent_v1::createPrivateStore ( )

protected

Function initialising the object to work in standalone mode.

Definition at line 341 of file MissingETComponent_v1.cxx.

                                                {
  
    makePrivateStore();
    f_metLink()    = metlink_t();
    f_statusWord() = MissingETBase::Status::clearedStatus(); 
    f_wpx().clear();
    f_wpy().clear();
    f_wet().clear();
    f_objectLinks().clear();
  
    return;
 }

◆ empty()

bool xAOD::MissingETComponent_v1::empty ( ) const

Empty list of contributing objects indicator.

◆ f_metLink()

MissingETBase::Types::metlink_t& xAOD::MissingETComponent_v1::f_metLink ( )

protected

Non-const link reference

◆ f_objectLinks()

MissingETBase::Types::objlink_vector_t& xAOD::MissingETComponent_v1::f_objectLinks ( )

protected

Non-const link reference.

◆ f_removeContrib()

bool MissingETComponent_v1::f_removeContrib ( size_t pIdx )

protected

Copy the contribution data from a source.

Parameters

[in] contrib reference to non-modifiable contribution object (the source).

Definition at line 172 of file MissingETComponent_v1.cxx.

 {
   objlink_vector_t::iterator fCon(this->f_objectLinks().begin()); std::advance<objlink_vector_t::iterator>(fCon,pIdx);
   this->f_objectLinks().erase(fCon);
   std::vector<double>::iterator fWpx(this->f_wpx().begin()); std::advance<std::vector<double>::iterator>(fWpx,pIdx);
   this->f_wpx().erase(fWpx);
   std::vector<double>::iterator fWpy(this->f_wpy().begin()); std::advance<std::vector<double>::iterator>(fWpy,pIdx);
   this->f_wpy().erase(fWpy);
   std::vector<double>::iterator fWet(this->f_wet().begin()); std::advance<std::vector<double>::iterator>(fWet,pIdx);
   this->f_wet().erase(fWet);
   return true;
 }

◆ f_setLink()

template<class LINK >

bool xAOD::MissingETComponent_v1::f_setLink ( LINK & elemLink )

protected

◆ f_setObject()

template<class POBJ , class LINK >

void xAOD::MissingETComponent_v1::f_setObject	(	const POBJ *	pObj,
		LINK &	elemLink
	)

protected

Generalized link manager.

Inserts link data into ElementLink, even if incomplete. At least, the pointer of linked object will be set (except if NULL).

Template Parameters

POBJ	linked object type
LINK	specific ElementLink type

Parameters

[in]	pObj	pointer to non-modifiable object to be linked
[in]	elemLink	reference to modifiable ElementLink object. Initial data content of this object are overwritten.

Note: This is the generalized implementation for e.g. MissingETComponent_v1::setMET and MissingETComponent_v1::addObject

◆ f_statusWord()

MissingETBase::Types::bitmask_t& xAOD::MissingETComponent_v1::f_statusWord ( )

protected

◆ f_wet()

std::vector<double>& xAOD::MissingETComponent_v1::f_wet ( )

protected

◆ f_wpx()

std::vector<double>& xAOD::MissingETComponent_v1::f_wpx ( )

protected

◆ f_wpy()

std::vector<double>& xAOD::MissingETComponent_v1::f_wpy ( )

protected

◆ findIndex()

size_t MissingETComponent_v1::findIndex ( const IParticle * pPart ) const

Find index of given object in contributing object store.

The returned index is valid for the contributing object store and the parameter stores (index-parallel stores).

Returns: A valid index \( i \in \{ 0 \ldots N_{\rm objects} - 1 \} \), where \( N_{\rm objects} \) is the total number of contributing objects to the MET contribution. If the given object is not in the store with the requested status, MissingETBase::Numerical::invalidIndex() is returned.

This method makes use of a cache. If the pointer to the checked object is the same as the last one successfully searched for, the index is returned from a cached data word. If the pointer is not the same, xAOD::MissingETComponent::findIndex(const IParticle*) is invoked. If this method finds the referenced object, the cache is updated and the valid index is returned. In case the object is not found, MissingETBase::Nummerical::invalidIndex() is returned.

Returns: Valid object index \( i = 0 \ldots N_{\rm objects} - 1 \) if object found in list, else MissingETBase::Numerical::invalidIndex().

Parameters

[in]	pPart	pointer to non-modifiable object
[in]	pPart	pointer to non-modifiable object in the list of contributing objects

Definition at line 213 of file MissingETComponent_v1.cxx.

 {
   objlink_vector_t::const_iterator fLnk(this->objectLinks().begin());
   while(fLnk != this->objectLinks().end() && *(*fLnk) != pPart){ ++fLnk; }
   if(fLnk != this->objectLinks().end())
     return std::distance(this->objectLinks().begin(),fLnk);
   return MissingETBase::Numerical::invalidIndex();
 }

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

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

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

◆ mergeStatusWord()

bool xAOD::MissingETComponent_v1::mergeStatusWord ( MissingETBase::Types::bitmask_t sw )

Merge patterns into the MET term status.

◆ metLink()

const MissingETBase::Types::metlink_t& xAOD::MissingETComponent_v1::metLink ( ) const

Get the link to the MET object.

◆ metObject()

const MissingET* xAOD::MissingETComponent_v1::metObject ( ) const

Access MET object.

◆ metObjectContainer()

const MissingETContainer_v1* xAOD::MissingETComponent_v1::metObjectContainer ( ) const

Access MET object container holding MET object.

◆ metObjectIndex()

size_t xAOD::MissingETComponent_v1::metObjectIndex ( ) const

Access index of MET object in its container.

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ objectLinks()

const MissingETBase::Types::objlink_vector_t& xAOD::MissingETComponent_v1::objectLinks ( ) const

Get the vector of links to the contributing physics or signal objects.

◆ objects() [1/3]

std::vector< const IParticle * > MissingETComponent_v1::objects ( ) const

Access contributing objects.

Definition at line 295 of file MissingETComponent_v1.cxx.

 { 
   std::vector<const IParticle*> pVec;
   for ( objlink_vector_t::const_iterator fLnk(this->objectLinks().begin()); fLnk != this->objectLinks().end(); ++fLnk) { pVec.push_back(*(*fLnk)); }
   return pVec;
 }

◆ objects() [2/3]

std::vector< const IParticle * > MissingETComponent_v1::objects	(	const std::vector< double > *&	wpxPtr,
		const std::vector< double > *&	wpyPtr,
		const std::vector< double > *&	wetPtr
	)		const

Access contributing objects and retrieve kinematic weight components.

Definition at line 312 of file MissingETComponent_v1.cxx.

313 { wpxPtr = &(this->wpx()); wpyPtr = &(this->wpy()); wetPtr = &(this->wet()); return this->objects(); }

◆ objects() [3/3]

std::vector<const IParticle*> xAOD::MissingETComponent_v1::objects ( std::vector< Weight > & kinePars ) const

Access contributing objects and retrieve kinematic weights.

◆ operator!=()

bool xAOD::MissingETComponent_v1::operator!= ( const MissingETComponent_v1 & contrib ) const

Equality.

◆ operator=()

MissingETComponent_v1 & MissingETComponent_v1::operator= ( const MissingETComponent_v1 & compDescr )

Definition at line 103 of file MissingETComponent_v1.cxx.

 { 
   if((&compDescr) != this) {
     this->setStatusWord(compDescr.statusWord());
     this->setMetLink(compDescr.metLink());
     this->setObjectLinks(compDescr.objectLinks());
     this->setWpx(compDescr.wpx());
     this->setWpy(compDescr.wpy());
     this->setWet(compDescr.wet());  
   }
   return  *this;
 }

◆ operator==()

bool MissingETComponent_v1::operator== ( const MissingETComponent_v1 & contrib ) const

Definition at line 328 of file MissingETComponent_v1.cxx.

 {
   // FIXME compare only MET object link, statusword, and number of contributing particles 
   return 
     this->metLink()    == compDescr.metLink()    &&
     this->statusWord() == compDescr.statusWord() &&
     this->size()       == compDescr.size();
 }

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

◆ removeContrib() [1/3]

bool MissingETComponent_v1::removeContrib ( )

Remove all contributions.

Definition at line 165 of file MissingETComponent_v1.cxx.

 {
   if ( this->empty() ) { return false; }
   else 
     { size_t nEnt(this->size()); for  ( size_t pIdx(0); pIdx<nEnt; ++pIdx ) { this->f_removeContrib(pIdx); } return true; }
 }

◆ removeContrib() [2/3]

bool xAOD::MissingETComponent_v1::removeContrib ( const IParticle * pPart )

Remove a contribution referenced by an object pointer.

◆ removeContrib() [3/3]

bool xAOD::MissingETComponent_v1::removeContrib ( size_t pIdx )

Remove a contribution referenced by an index.

◆ resetContrib() [1/3]

bool MissingETComponent_v1::resetContrib ( )

Reset all contribution parameters.

Definition at line 197 of file MissingETComponent_v1.cxx.

 {
   if ( this->empty() ) { return false; }
   else
     {
       size_t nEnt(this->size());
       for ( size_t pIdx(0); pIdx < nEnt; ++pIdx)
     {
       this->f_wpx()[pIdx] = MissingETBase::Numerical::wpxDefault();
       this->f_wpy()[pIdx] = MissingETBase::Numerical::wpyDefault();
       this->f_wet()[pIdx] = MissingETBase::Numerical::wetDefault();
     } 
       return true;
     } 
 }

◆ resetContrib() [2/3]

bool xAOD::MissingETComponent_v1::resetContrib ( const IParticle * pPart )

Reset the contribution parameters of an object referenced by a pointer.

◆ resetContrib() [3/3]

bool MissingETComponent_v1::resetContrib ( size_t pIdx )

Reset the contribution parameters of an object referenced by an index.

Definition at line 185 of file MissingETComponent_v1.cxx.

 {
   if ( pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->size() )
     {
       this->f_wpx()[pIdx] = MissingETBase::Numerical::wpxDefault();
       this->f_wpy()[pIdx] = MissingETBase::Numerical::wpyDefault();
       this->f_wet()[pIdx] = MissingETBase::Numerical::wetDefault();
       return true;
     }
   return false;
 }

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

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

◆ setMET() [1/2]

bool MissingETComponent_v1::setMET	(	const MissingET *	pmetObj,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

Set MET object by object pointer reference.

Definition at line 249 of file MissingETComponent_v1.cxx.

 { 
   bool wasSet(this->f_metLink().getStorableObjectPointer() != nullptr);
   f_setObject<MissingET,MissingETBase::Types::metlink_t>(pmetObj,this->f_metLink());
   this->f_statusWord() = sw;
   return wasSet;
 }

◆ setMET() [2/2]

bool MissingETComponent_v1::setMET	(	const MissingETContainer_v1 *	pmetCont,
		size_t	pmedIdx,
		MissingETBase::Types::bitmask_t	sw = `MissingETBase::Status::clearedStatus()`
	)

Set MET object by container pointer and index reference.

Definition at line 257 of file MissingETComponent_v1.cxx.

 {
   bool wasSet(this->f_metLink().getStorableObjectPointer() != nullptr);
   this->f_metLink().toIndexedElement(*pmetCont,pmetIdx);
   this->f_statusWord() = sw;
   return wasSet; }

◆ setMetLink()

bool MissingETComponent_v1::setMetLink ( const MissingETBase::Types::metlink_t & metLnk )

Set the link to the MET object.

Definition at line 264 of file MissingETComponent_v1.cxx.

 {
   bool wasSet(this->f_metLink().getStorableObjectPointer() != nullptr);
   this->f_metLink() = metLnk;
   return wasSet; }

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

◆ setObjectLinks()

bool MissingETComponent_v1::setObjectLinks ( const MissingETBase::Types::objlink_vector_t & objLnks )

Set the vector of links to the contributing physics or signal objects.

Definition at line 270 of file MissingETComponent_v1.cxx.

 { 
   bool wasSet(!this->f_objectLinks().empty()); 
   if ( wasSet ) {
     this->f_objectLinks().clear(); this->f_objectLinks().insert(this->f_objectLinks().end(),objLnks.begin(),objLnks.end());
     for(MissingETBase::Types::objlink_vector_t::iterator iLink=this->f_objectLinks().begin();
     iLink!=this->f_objectLinks().end(); ++iLink) {
       this->f_setLink<MissingETBase::Types::objlink_t>(*iLink);
     }
   }
   return wasSet;
 }

◆ setStatusWord()

bool xAOD::MissingETComponent_v1::setStatusWord ( MissingETBase::Types::bitmask_t sw = MissingETBase::Status::clearedStatus() )

Set the statusword of a MET term.

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

◆ setWeight() [1/4]

bool xAOD::MissingETComponent_v1::setWeight	(	const IParticle *	pPart,
		const Weight &	wght = `Weight()`
	)

Set the kinematic weight of an object contribution referenced by pointer.

◆ setWeight() [2/4]

bool xAOD::MissingETComponent_v1::setWeight	(	const IParticle *	pPart,
		double	wpx,
		double	wpy,
		double	wet
	)

Set the kinematic weight components of an object contribution referenced by pointer.

◆ setWeight() [3/4]

bool xAOD::MissingETComponent_v1::setWeight	(	size_t	pIdx,
		const Weight &	wght = `Weight()`
	)

Set the kinematic weight of an object contribution referenced by index.

◆ setWeight() [4/4]

bool MissingETComponent_v1::setWeight	(	size_t	pIdx,
		double	wpx,
		double	wpy,
		double	wet
	)

Set the kinematic weight components of an object contribution referenced by index.

Definition at line 241 of file MissingETComponent_v1.cxx.

 { 
   if ( pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->f_wet().size() )  
     { this->f_wpx()[pIdx] = wpx;  this->f_wpy()[pIdx] = wpy;  this->f_wet()[pIdx] = wet; return true; }  
   else
     { return false; }
 }

◆ setWet() [1/3]

bool xAOD::MissingETComponent_v1::setWet	(	const IParticle *	pPart,
		double	wet
	)

Set kinematic weight \( w_{\rm T} \) for a given contributing object referenced by pointer.

◆ setWet() [2/3]

bool MissingETComponent_v1::setWet ( const std::vector< double > & wcv )

Set the vector of \( w_{\rm T} \) weight components

Definition at line 230 of file MissingETComponent_v1.cxx.

231 { this->f_wet().clear(); this->f_wet().insert(this->f_wet().end(),wcv.begin(),wcv.end()); return !this->f_wet().empty(); }

◆ setWet() [3/3]

bool MissingETComponent_v1::setWet	(	size_t	pIdx,
		double	wet
	)

Set kinematic weight \( w_{\rm T} \) for a given contributing object referenced by index.

Definition at line 239 of file MissingETComponent_v1.cxx.

240 { if ( pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->f_wet().size() ) { this->f_wet()[pIdx] = wet; return true; } else { return false; } }

◆ setWpx() [1/3]

bool xAOD::MissingETComponent_v1::setWpx	(	const IParticle *	pPart,
		double	wpx
	)

Set kinematic weight component \( w_{x} \) for a given contributing object referenced by pointer.

◆ setWpx() [2/3]

bool MissingETComponent_v1::setWpx ( const std::vector< double > & wcv )

Set the vector of \( w_{x} \) weight components

Definition at line 226 of file MissingETComponent_v1.cxx.

227 { this->f_wpx().clear(); this->f_wpx().insert(this->f_wpx().end(),wcv.begin(),wcv.end()); return !this->f_wpx().empty(); }

◆ setWpx() [3/3]

bool MissingETComponent_v1::setWpx	(	size_t	pIdx,
		double	wpx
	)

Set kinematic weight component \( w_{x} \) for a given contributing object referenced by index.

Definition at line 235 of file MissingETComponent_v1.cxx.

236 { if ( pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->f_wpx().size() ) { this->f_wpx()[pIdx] = wpx; return true; } else { return false; } }

◆ setWpy() [1/3]

bool xAOD::MissingETComponent_v1::setWpy	(	const IParticle *	pPart,
		double	wpy
	)

Set kinematic weight component \( w_{y} \) for a given contributing object referenced by pointer.

◆ setWpy() [2/3]

bool MissingETComponent_v1::setWpy ( const std::vector< double > & wpyVector )

Set the vector of \( w_{y} \) weight components

Definition at line 228 of file MissingETComponent_v1.cxx.

229 { this->f_wpy().clear(); this->f_wpy().insert(this->f_wpy().end(),wcv.begin(),wcv.end()); return !this->f_wpy().empty(); }

◆ setWpy() [3/3]

bool MissingETComponent_v1::setWpy	(	size_t	pIdx,
		double	wpy
	)

Set kinematic weight component \( w_{y} \) for a given contributing object referenced by index.

Definition at line 237 of file MissingETComponent_v1.cxx.

238 { if ( pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->f_wpy().size() ) { this->f_wpy()[pIdx] = wpy; return true; } else { return false; } }

◆ size()

size_t xAOD::MissingETComponent_v1::size ( ) const

[Deprecated] Update all internally used ElementLink instances

Note: This method scans the full list of contributing objects. It invokes MissingETComponent_v1::updateMETLink internally.

[Deprecated] Update link MissingET object only

◆ statusWord()

MissingETBase::Types::bitmask_t xAOD::MissingETComponent_v1::statusWord ( ) const

Get the statusword.

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

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

◆ weight() [1/2]

Weight xAOD::MissingETComponent_v1::weight ( const IParticle * pPart ) const

Get kinematic weight for a given object.

◆ weight() [2/2]

MissingETComponent_v1::Weight MissingETComponent_v1::weight ( size_t pIdx ) const

Get kinematic weight for a given entry (index) in the contributing object list.

Definition at line 319 of file MissingETComponent_v1.cxx.

 { return pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->size() 
     ? Weight(this->wpx().at(pIdx),this->wpy().at(pIdx),this->wet(pIdx)) 
     : Weight(MissingETBase::Numerical::wpxError(),MissingETBase::Numerical::wpyError(),MissingETBase::Numerical::wetError()); }

◆ wet() [1/3]

const std::vector<double>& xAOD::MissingETComponent_v1::wet ( ) const

Get the vector of \( w_{\rm T} \) weight components

◆ wet() [2/3]

double xAOD::MissingETComponent_v1::wet ( const IParticle * pPart ) const

Get the weight component \( w_{\rm T} \) for a given object referenced by pointer.

◆ wet() [3/3]

double MissingETComponent_v1::wet ( size_t pIdx ) const

Get the weight component \( w_{\rm T} \) for a given object referenced by index.

Definition at line 292 of file MissingETComponent_v1.cxx.

293 { return pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->size() ? this->wet()[pIdx] : MissingETBase::Numerical::wetError(); }

◆ wpx() [1/3]

const std::vector<double>& xAOD::MissingETComponent_v1::wpx ( ) const

Get the vector of \( w_{x} \) weight components

◆ wpx() [2/3]

double xAOD::MissingETComponent_v1::wpx ( const IParticle * pPart ) const

Get the weight component \( w_{x} \) for a given object referenced by pointer.

◆ wpx() [3/3]

double MissingETComponent_v1::wpx ( size_t pIdx ) const

Get the weight component \( w_{x} \) for a given object referenced by index.

Definition at line 288 of file MissingETComponent_v1.cxx.

289 { return pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->size() ? this->wpx()[pIdx] : MissingETBase::Numerical::wpxError(); }

◆ wpy() [1/3]

const std::vector<double>& xAOD::MissingETComponent_v1::wpy ( ) const

Get the vector of \( w_{y} \) weight components

◆ wpy() [2/3]

double xAOD::MissingETComponent_v1::wpy ( const IParticle * pPart ) const

Get the weight component \( w_{y} \) for a given object referenced by pointer.

◆ wpy() [3/3]

double MissingETComponent_v1::wpy ( size_t pIdx ) const

Get the weight component \( w_{y} \) for a given object referenced by index.

Definition at line 290 of file MissingETComponent_v1.cxx.

291 { return pIdx != MissingETBase::Numerical::invalidIndex() && pIdx < this->size() ? this->wpy()[pIdx] : MissingETBase::Numerical::wpyError(); }

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

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ MissingETComponent_v1() [1/6]

◆ MissingETComponent_v1() [2/6]

◆ MissingETComponent_v1() [3/6]

◆ MissingETComponent_v1() [4/6]

◆ MissingETComponent_v1() [5/6]

◆ MissingETComponent_v1() [6/6]

◆ ~MissingETComponent_v1()

Member Function Documentation

◆ addObject() [1/2]

◆ addObject() [2/2]

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ clearStatusWord()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ copyData()

◆ createPrivateStore()

◆ empty()

◆ f_metLink()

◆ f_objectLinks()

◆ f_removeContrib()

◆ f_setLink()

◆ f_setObject()

◆ f_statusWord()

◆ f_wet()

◆ f_wpx()

◆ f_wpy()

◆ findIndex()

◆ getAuxIDs()

◆ getConstStore()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ mergeStatusWord()

◆ metLink()

◆ metObject()

◆ metObjectContainer()

◆ metObjectIndex()

◆ noPrivateData()

◆ objectLinks()

◆ objects() [1/3]