Decorator.h File Reference

Helper class to provide type-safe access to aux data. More...

#include "AthContainersInterfaces/AuxTypes.h"
#include "AthContainersInterfaces/IAuxElement.h"
#include "AthContainers/AuxVectorData.h"
#include "AthContainers/AuxTypeRegistry.h"
#include "AthContainers/tools/AuxElementConcepts.h"
#include <string>
#include <typeinfo>
#include "AthContainers/Decorator.icc"

Include dependency graph for Decorator.h:

Go to the source code of this file.

Namespaces
namespace	SG
	Forward declaration.

Functions
	SG::Decorator (const std::string &name)
	Helper class to provide type-safe access to aux data.
	SG::Decorator (const std::string &name, const std::string &clsname)
	Constructor.
	SG::Decorator (const SG::auxid_t auxid)
	Constructor taking an auxid directly.
template<IsConstAuxElement ELT>
reference_type	SG::operator() (const ELT &e) const
	Fetch the variable for one element, as a non-const reference.
reference_type	SG::operator() (const AuxVectorData &container, size_t index) const
	Fetch the variable for one element, as a non-const reference.
template<IsConstAuxElement ELT>
void	SG::set (const ELT &e, const element_type &x) const
	Set the variable for one element.
const_container_pointer_type	SG::getDataArray (const AuxVectorData &container) const
	Get a pointer to the start of the auxiliary data array.
container_pointer_type	SG::getDecorationArray (const AuxVectorData &container) const
	Get a pointer to the start of the auxiliary data array.
const_span	SG::getDataSpan (const AuxVectorData &container) const
	Get a span over the auxiliary data array.
span	SG::getDecorationSpan (const AuxVectorData &container) const
	Get a span over the auxiliary data array.
template<IsConstAuxElement ELT>
bool	SG::isAvailable (const ELT &e) const
	Test to see if this variable exists in the store.
template<IsConstAuxElement ELT>
bool	SG::isAvailableWritable (const ELT &e) const
	Test to see if this variable exists in the store and is writable.
bool	SG::isAvailable (const AuxVectorData &c) const
	Test to see if this variable exists in the store.
bool	SG::isAvailableWritable (const AuxVectorData &c) const
	Test to see if this variable exists in the store and is writable.
SG::auxid_t	SG::auxid () const
	Return the aux id for this variable.
	SG::Decorator (const std::string &name, const std::string &clsname, const SG::AuxVarFlags flags)
	Constructor.
	SG::Decorator (const SG::auxid_t auxid, const SG::AuxVarFlags flags)
	Constructor taking an auxid directly.

Variables
SG::auxid_t	SG::m_auxid
	The cached auxid.

Detailed Description

Helper class to provide type-safe access to aux data.

Author

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

Date

Oct, 2023

To avoid circularities, this file must not include AuxElement.h. Methods which would normally take ConstAuxElement arguments are instead templated.

Definition in file Decorator.h.