AuxElement.h File Reference

Base class for elements of a container that can have aux data. More...

#include "AthContainersInterfaces/IAuxElement.h"
#include "AthContainersInterfaces/IConstAuxStore.h"
#include "AthContainersInterfaces/IAuxStore.h"
#include "AthLinks/DataLink.h"
#include "AthContainers/AuxTypeRegistry.h"
#include "AthContainers/AuxVectorData.h"
#include "AthContainers/tools/AuxDataTraits.h"
#include "AthContainers/TypelessConstAccessor.h"
#include "AthContainers/ConstAccessor.h"
#include "AthContainers/Accessor.h"
#include "AthContainers/Decorator.h"
#include "AthContainers/exceptions.h"
#include "AthContainers/tools/likely.h"
#include "CxxUtils/span.h"
#include <cstddef>
#include "AthContainers/AuxElement.icc"

Go to the source code of this file.

Classes
class	SG::ConstAuxElement
	Const part of AuxElement. More...

Namespaces
namespace	SG
	Forward declaration.

Macros
#define	XAOD_DEPRECATE_AUXDATA   1
#define	XAOD_AUXDATA_DEPRECATED   [[deprecated("auxdata/auxdecor are deprecated in non-analysis builds. Use SG::ConstAccessor/SG::Accessor/SG::Decorator instead.")]]

Typedefs
using	SG::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
template<class T, class ALLOC = AuxAllocator_t<T>>
using	SG::ConstAccessor = SG::ConstAccessor<T, ALLOC>
template<class T, class ALLOC = AuxAllocator_t<T>>
using	SG::Accessor = SG::Accessor<T, ALLOC>
template<class T, class ALLOC = AuxAllocator_t<T>>
using	SG::Decorator = SG::Decorator<T, ALLOC>
	Helper class to provide type-safe access to aux data, specialized for JaggedVecElt.

Functions
	SG::AuxElement (SG::AuxVectorData *container, size_t index)
	Base class for elements of a container that can have aux data.
	SG::AuxElement (const AuxElement &other)
	Copy Constructor.
AuxElement &	SG::operator= (const AuxElement &other)
	Assignment.
void	SG::assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
	SG::~AuxElement ()
	Destructor.
const SG::AuxVectorData *	SG::container () const
	Return the container holding this element.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	SG::auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	SG::auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	SG::auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	SG::auxdata (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	SG::auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	SG::auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	SG::isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	SG::isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	SG::isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	SG::auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	SG::auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference.
void	SG::makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	SG::makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	SG::makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	SG::releasePrivateStore ()
	Release and free any private store associated with this object.
void	SG::setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	SG::setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	SG::setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	SG::setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore.
void	SG::setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore.
bool	SG::usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	SG::usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
const SG::IConstAuxStore *	SG::getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	SG::getStore () const
	Return the current store, as a non-const interface.
void	SG::clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	SG::getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	SG::getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	SG::hasStore () const
	Return true if this object has an associated store.
bool	SG::hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	SG::clearDecorations () const
	Clear all decorations.
bool	SG::trackIndices () const
	Return true if index tracking is enabled for this object.
void	SG::releasePrivateStoreForDtor ()
	Out-of-line portion of destructor.
void	SG::setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
bool	SG::setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
void	SG::makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
void	SG::makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
AuxElementStandaloneData *	SG::setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	SG::clearAux ()
	Clear all aux data associated with this element.
void	SG::copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object.
static void	SG::clearAuxHelper (AuxVectorData &container, size_t index)
	Clear all aux data associated with an element.
static void	SG::copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
	Copy aux data from another object.

Variables
static constexpr bool	SG::supportsThinning = true
	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.

Detailed Description

Base class for elements of a container that can have aux data.

Author

scott snyder snyde.nosp@m.r@bn.nosp@m.l.gov

Date

Jan, 2013

Definition in file AuxElement.h.

Macro Definition Documentation

XAOD_AUXDATA_DEPRECATED

#define XAOD_AUXDATA_DEPRECATED   [[deprecated("auxdata/auxdecor are deprecated in non-analysis builds. Use SG::ConstAccessor/SG::Accessor/SG::Decorator instead.")]]

Definition at line 45 of file AuxElement.h.

XAOD_DEPRECATE_AUXDATA

#define XAOD_DEPRECATE_AUXDATA   1

Definition at line 41 of file AuxElement.h.