#include <JEMEtSums_v1.h>

Inheritance diagram for xAOD::JEMEtSums_v1:

Collaboration diagram for xAOD::JEMEtSums_v1:

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

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

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

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

Public Member Functions
	JEMEtSums_v1 ()

int	crate () const
	get crate number More...

void	setCrate (int)
	set crate number More...

int	module () const
	get module More...

void	setModule (int)
	set module More...

int	peak () const
	get peak More...

void	setPeak (int)
	set peak More...

const std::vector< unsigned int > &	etVec () const
	Please note that in the context of JEMEtSums, et is total energy, not transverse energy For transverse energy, please use Pythagoras' theorem on ex and ey. More...

void	setEtVec (const std::vector< unsigned int > &)
	set etVec - et for all time slices More...

const std::vector< unsigned int > &	exVec () const
	get exVec - ex for all time slices More...

void	setExVec (const std::vector< unsigned int > &)
	set exVec - ex for all time slices More...

const std::vector< unsigned int > &	eyVec () const
	get eyVec - ey for all time slices More...

void	setEyVec (const std::vector< unsigned int > &)
	set eyVec - ey for all time slices More...

unsigned int	forward () const
	Is this JEMEtSums forward? More...

unsigned int	et () const
	get et for etVec[peak] - time slice that (hopefully) contains the collision More...

unsigned int	ex () const
	get ex for exVec[peak] - time slice that (hopefully) contains the collision More...

unsigned int	ey () const
	get ey for eyVec[peak] - time slice that (hopefully) contains the collision More...

void	addEt (const std::vector< unsigned int > &Et)
	Backwards Compatibility with Trigger/TrigT1/TrigT1CaloEvent Run1 EDM did not strictly follow camelCaseNotation See above for description. More...

void	addEx (const std::vector< unsigned int > &Ex)

void	addEy (const std::vector< unsigned int > &Ey)

unsigned int	Et () const

unsigned int	Ex () const

unsigned int	Ey () const

const std::vector< unsigned int > &	EtVec () const

const std::vector< unsigned int > &	ExVec () const

const std::vector< unsigned int > &	EyVec () const

void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment. 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, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	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...

const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations 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...

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

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

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

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

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

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

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

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

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

void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	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, bool warnUnlocked=false)
	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

Description of JEMEtSums_v1.

Author: John Morris john..nosp@m.morr.nosp@m.is@ce.nosp@m.rn.c.nosp@m.h

Revision: 631127

Date: 2014-11-26 10:54:48 +0100 (Wed, 26 Nov 2014)

Definition at line 23 of file JEMEtSums_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.

◆ TypelessConstAccessor

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

inherited

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

◆ JEMEtSums_v1()

xAOD::JEMEtSums_v1::JEMEtSums_v1 ( )

Definition at line 18 of file JEMEtSums_v1.cxx.

                              :
     SG::AuxElement()
   {        
   }

Member Function Documentation

◆ addEt()

void xAOD::JEMEtSums_v1::addEt ( const std::vector< unsigned int > & Et )

inline

Backwards Compatibility with Trigger/TrigT1/TrigT1CaloEvent Run1 EDM did not strictly follow camelCaseNotation See above for description.

Definition at line 74 of file JEMEtSums_v1.h.

74 {this->setEtVec( Et );}

◆ addEx()

void xAOD::JEMEtSums_v1::addEx ( const std::vector< unsigned int > & Ex )

inline

Definition at line 75 of file JEMEtSums_v1.h.

75 {this->setExVec( Ex );}

◆ addEy()

void xAOD::JEMEtSums_v1::addEy ( const std::vector< unsigned int > & Ey )

inline

Definition at line 76 of file JEMEtSums_v1.h.

76 {this->setEyVec( Ey );}

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

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

◆ 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 607 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();
 #ifndef XAOD_STANDALONE
   SG::auxid_set_t other_decors = ocont->getDecorIDs();
 #endif
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   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, cont, index(), *ocont, oindex, 1);
     }
   }
  
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     if (!other_ids.test (auxid)) {
       r.clear (auxid, cont, index(), 1);
     }
   }
 }

◆ crate()

int xAOD::JEMEtSums_v1::crate ( ) const

get crate number

◆ et()

unsigned int xAOD::JEMEtSums_v1::et ( ) const

get et for etVec[peak] - time slice that (hopefully) contains the collision

Definition at line 40 of file JEMEtSums_v1.cxx.

   {
     return etVec()[ peak() ];  
   }

◆ Et()

unsigned int xAOD::JEMEtSums_v1::Et ( ) const

inline

Definition at line 77 of file JEMEtSums_v1.h.

77 {return this->et();}

◆ etVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::etVec ( ) const

Please note that in the context of JEMEtSums, et is total energy, not transverse energy For transverse energy, please use Pythagoras' theorem on ex and ey.

get etVec - et for all time slices

◆ EtVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::EtVec ( ) const

inline

Definition at line 80 of file JEMEtSums_v1.h.

80 {return this->etVec();}

◆ ex()

unsigned int xAOD::JEMEtSums_v1::ex ( ) const

get ex for exVec[peak] - time slice that (hopefully) contains the collision

Definition at line 45 of file JEMEtSums_v1.cxx.

   {
     return exVec()[ peak() ]; 
   }

◆ Ex()

unsigned int xAOD::JEMEtSums_v1::Ex ( ) const

inline

Definition at line 78 of file JEMEtSums_v1.h.

78 {return this->ex();}

◆ exVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::exVec ( ) const

get exVec - ex for all time slices

◆ ExVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::ExVec ( ) const

inline

Definition at line 81 of file JEMEtSums_v1.h.

81 {return this->exVec();}

◆ ey()

unsigned int xAOD::JEMEtSums_v1::ey ( ) const

get ey for eyVec[peak] - time slice that (hopefully) contains the collision

Definition at line 50 of file JEMEtSums_v1.cxx.

   {
     return eyVec()[ peak() ]; 
   }

◆ Ey()

unsigned int xAOD::JEMEtSums_v1::Ey ( ) const

inline

Definition at line 79 of file JEMEtSums_v1.h.

79 {return this->ey();}

◆ eyVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::eyVec ( ) const

get eyVec - ey for all time slices

◆ EyVec()

const std::vector<unsigned int>& xAOD::JEMEtSums_v1::EyVec ( ) const

inline

Definition at line 82 of file JEMEtSums_v1.h.

82 {return this->eyVec();}

◆ forward()

unsigned int xAOD::JEMEtSums_v1::forward ( ) const

Is this JEMEtSums forward?

Definition at line 30 of file JEMEtSums_v1.cxx.

   {
     unsigned int result(0);
     int mod = module();
     if( ((mod%8) == 0)  || ((mod%8) == 7) ){
       result = 1;
     }
     return result;
   }

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

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

◆ module()

int xAOD::JEMEtSums_v1::module ( ) const

get module

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ peak()

int xAOD::JEMEtSums_v1::peak ( ) const

get peak

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

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setCrate()

void xAOD::JEMEtSums_v1::setCrate ( int )

set crate number

◆ setEtVec()

void xAOD::JEMEtSums_v1::setEtVec ( const std::vector< unsigned int > & )

set etVec - et for all time slices

◆ setExVec()

void xAOD::JEMEtSums_v1::setExVec ( const std::vector< unsigned int > & )

set exVec - ex for all time slices

◆ setEyVec()

void xAOD::JEMEtSums_v1::setEyVec ( const std::vector< unsigned int > & )

set eyVec - ey for all time slices

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

◆ setModule()

void xAOD::JEMEtSums_v1::setModule ( int )

set module

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

◆ setPeak()

void xAOD::JEMEtSums_v1::setPeak ( int )

set peak

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

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

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

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ JEMEtSums_v1()

Member Function Documentation

◆ addEt()

◆ addEx()

◆ addEy()

◆ assign()

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

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ crate()

◆ et()

◆ Et()

◆ etVec()

◆ EtVec()

◆ ex()

◆ Ex()

◆ exVec()

◆ ExVec()

◆ ey()

◆ Ey()

◆ eyVec()

◆ EyVec()

◆ forward()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

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

◆ module()

◆ noPrivateData()

◆ peak()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()

◆ setConstStore()

◆ setCrate()

◆ setEtVec()

◆ setExVec()

◆ setEyVec()

◆ setHadPrivateData()

◆ setHavePrivateData()