Class holding the RingSet configuration used for the Reconstruction. More...

#include <RingSetConf_v1.h>

Inheritance diagram for xAOD::RingSetConf_v1:

Collaboration diagram for xAOD::RingSetConf_v1:

Classes
struct	RawConf

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 >

RingSetConf_v1 nested types:

typedef std::vector< RawConf >	RawConfCollection
	typedef The raw configuration structure data holder More...

Public Member Functions
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>>
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>>
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>>
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>>
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>>
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>>
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>>
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>>
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>>
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>>
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>>
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...

RingSetConf_v1 ctors
	RingSetConf_v1 ()
	Empty ctor: More...

	RingSetConf_v1 (const RingSetConf_v1 &ringset)
	Copy constructor. More...

	RingSetConf_v1 (const unsigned nRings, const std::vector< CaloSampling::CaloSample > &rsLayers, const float etaWidth, const float phiWidth, const float cellMaxDEtaDist, const float cellMaxDPhiDist, const Ringer::CalJointLayer calJointLayer, const Ringer::CalJointSection calJointSection, const bool doEtaAxesDivision, const bool doPhiAxesDivision, const unsigned layerStartIdx, const unsigned layerEndIdx, const unsigned sectionStartIdx, const unsigned sectionEndIdx)
	Set each individual variable: More...

confStruct value:
Set each AuxVariable with
	RingSetConf_v1 (const RawConf &confStruct)

RingSetConf_v1 nRings interation
unsigned	nRings () const
	Get nRings. More...

void	setNRings (unsigned nRings)
	Set nRings. More...

RingSetConf_v1 layer interation
unsigned	nLayers () const
	RingSet layers size: More...

const std::vector< CaloSampling::CaloSample > &	layers () const
	get layers More...

void	setLayers (const std::vector< CaloSampling::CaloSample > &layers)
	set layers More...

CaloSampling::CaloSample	layerAt (const unsigned idx) const
	Get ith layer. More...

void	addLayer (const CaloSampling::CaloSample c)
	Add layer. More...

void	clearLayers ()
	Clear layers. More...

RingSetConf_v1 etaWidth,phiWidth get and set:
float	etaWidth () const
	Returns the etaWidth configuration step used for this RingSet. More...

float	phiWidth () const
	Returns the phiWidth configuration step used for this RingSet. More...

void	setEtaWidth (float etaWidth)
	Set etaWidth. More...

void	setPhiWidth (float phiWidth)
	Set phiWidth. More...

float	cellMaxDEtaDist () const
	Return the maximun cell distance in eta w.r.t seed. More...

float	cellMaxDPhiDist () const
	Return the maximun cell distance in phi w.r.t seed. More...

void	setCellMaxDEtaDist (float cellMaxDEtaDist)
	Set maxCellDEtaDist. More...

void	setCellMaxDPhiDist (float cellMaxDPhiDist)
	Set maxCellDPhiDist. More...

bool	doEtaAxesDivision () const
	Return the etaAxesDivision configuration. More...

void	setdoEtaAxesDivision (bool doEtaAxesDivision)
	Set doEtaAxesDivision. More...

bool	doPhiAxesDivision () const
	Return the phiAxesDivision configuration. More...

void	setdoPhiAxesDivision (bool doPhiAxesDivision)
	Set doPhiAxesDivision. More...

RingSetConf_v1 calJointLayer, calJoint
Ringer::CalJointLayer	calJointLayer () const
	Retrieve this RingSet conf CalJointLayer. More...

Ringer::CalJointSection	calJointSection () const
	Retrieve this RingSet conf CalJointSection. More...

void	setCalJointLayer (Ringer::CalJointLayer calJointLayer)
	Set this RingSet CalJointLayer. More...

void	setCalJointSection (Ringer::CalJointSection calJointSection)
	Set this RingSet CalJointSection. More...

RingSetConf_v1 layerStartIdx,layerEndIdx,sectionEndIdx,sectionEndIdx
interaction
unsigned	layerStartIdx () const
	Returns start of layer index for this RingSet Configuration when this configuration is concatened into a non segmented representation. More...

unsigned	sectionStartIdx () const
	Returns start of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation. More...

unsigned	layerEndIdx () const
	Returns end of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation. More...

unsigned	sectionEndIdx () const
	Returns end of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation. More...

void	setLayerStartIdx (unsigned layerStartIdx)
	Set start layer configuration index. More...

void	setSectionStartIdx (unsigned sectionEndIdx)
	Set start section configuration index. More...

void	setLayerEndIdx (unsigned layerEndIdx)
	Set end layer configuration index. More...

void	setSectionEndIdx (unsigned sectionEndIdx)
	Set end section configuration index. More...

RingSetConf_v1 using ostream:
Print
void	print (std::ostream &stream) const

CaloRingsConf_v1 utilities
const RingSetConf_v1::RawConf	getRawConf () const
	Retrieve raw RingSet Configuration struct. More...

RingSetConf_v1 operators overload:
RingSetConf_v1 &	operator= (const RingSetConf_v1 &clrings)
	Assignment Operator. More...

Static Public Member Functions
RingSetConf_v1 is at a specific calorimeter
Static methods Check if this section/layer
static bool	isEMSection (const std::vector< CaloSampling::CaloSample > &layers)
	Static methods: More...

static bool	isHADSection (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isPSLayer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isEM1Layer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isEM2Layer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isEM3Layer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isHAD1Layer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isHAD2Layer (const std::vector< CaloSampling::CaloSample > &layers)

static bool	isHAD3Layer (const std::vector< CaloSampling::CaloSample > &layers)

RingSetConf_v1
Returns the section/layer for this specific
static Ringer::CalJointSection	whichSection (const std::vector< CaloSampling::CaloSample > &layers)

static Ringer::CalJointLayer	whichLayer (const std::vector< CaloSampling::CaloSample > &layers)


static void	print (const RawConf &raw, std::ostream &stream)
	Prints rawConf. More...


static unsigned	totalNumberOfRings (const RawConfCollection &clRingsConf)
	Get the totalNumber of Rings contained in this configuration: More...

static void	getEdges (const RawConfCollection &clRingsConf, const Ringer::CalJointSection sec, unsigned &startEdge, unsigned &endEdge)
	Get CalJointSection start and end edges. More...

static void	getEdges (const RawConfCollection &clRingsConf, const Ringer::CalJointLayer layer, unsigned &startEdge, unsigned &endEdge)
	Get CalJointLayer start and end edges. More...

static void	addRawConfColBounderies (RawConfCollection &clRingsConf)
	Add to RawConfCollection its JointLayer/JointSection bounderies. More...

static void	fillRingSetConfContainer (const RawConfCollection &rawConfCol, RingSetConfContainer_v1 *container)
	Creates RingSetConfContainer from RawConfCollection. More...

static void	getRawConfCol (RawConfCollection &rawConfCol, const RingSetConfContainer_v1 *container)
	Retrieve RawConfCollection from RingSetConf container. More...


static void	print (const RawConfCollection &raw, std::ostream &stream)
	Prints RawConfCollection. 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 *)
	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

Class holding the RingSet configuration used for the Reconstruction.

Author: Werner Spolidoro Freund wsfre.nosp@m.und@.nosp@m.cern..nosp@m.ch

Definition at line 35 of file RingSetConf_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 522 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 519 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 525 of file AuxElement.h.

◆ RawConfCollection

typedef std::vector<RawConf> xAOD::RingSetConf_v1::RawConfCollection

typedef The raw configuration structure data holder

Definition at line 124 of file RingSetConf_v1.h.

◆ TypelessConstAccessor

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

inherited

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

◆ RingSetConf_v1() [1/4]

xAOD::RingSetConf_v1::RingSetConf_v1 ( )

inline

Empty ctor:

Ctors.

Definition at line 466 of file RingSetConf_v1.h.

466 {;}

◆ RingSetConf_v1() [2/4]

xAOD::RingSetConf_v1::RingSetConf_v1 ( const RingSetConf_v1 & ringset )

inline

Copy constructor.

Definition at line 470 of file RingSetConf_v1.h.

                                                                 : 
   SG::AuxElement(ringsetconf)
 {
   this->makePrivateStore(ringsetconf);
 }

◆ RingSetConf_v1() [3/4]

xAOD::RingSetConf_v1::RingSetConf_v1	(	const unsigned	nRings,
		const std::vector< CaloSampling::CaloSample > &	rsLayers,
		const float	etaWidth,
		const float	phiWidth,
		const float	cellMaxDEtaDist,
		const float	cellMaxDPhiDist,
		const Ringer::CalJointLayer	calJointLayer,
		const Ringer::CalJointSection	calJointSection,
		const bool	doEtaAxesDivision,
		const bool	doPhiAxesDivision,
		const unsigned	layerStartIdx,
		const unsigned	layerEndIdx,
		const unsigned	sectionStartIdx,
		const unsigned	sectionEndIdx
	)

Set each individual variable:

RingSetConf_v1 Ctors.

Definition at line 402 of file RingSetConf_v1.cxx.

                                                                  {
   makePrivateStore();
   setNRings(nRings);
   setLayers(layers);
   setEtaWidth(etaWidth);
   setPhiWidth(phiWidth);
   setCellMaxDEtaDist(cellMaxDEtaDist);
   setCellMaxDPhiDist(cellMaxDPhiDist);
   setCalJointLayer(calJointLayer);
   setCalJointSection(calJointSection);
   setdoEtaAxesDivision(doEtaAxesDivision);
   setdoPhiAxesDivision(doPhiAxesDivision);
   setLayerStartIdx(layerStartIdx);
   setLayerEndIdx(layerEndIdx);
   setSectionStartIdx(sectionStartIdx);
   setSectionEndIdx(sectionEndIdx);
 }

◆ RingSetConf_v1() [4/4]

xAOD::RingSetConf_v1::RingSetConf_v1 ( const RawConf & confStruct )

Definition at line 429 of file RingSetConf_v1.cxx.

 {
   makePrivateStore();
   setNRings(confStruct.nRings);
   setLayers(confStruct.layers);
   setEtaWidth(confStruct.etaWidth);
   setPhiWidth(confStruct.phiWidth);
   setCellMaxDEtaDist(confStruct.cellMaxDEtaDist);
   setCellMaxDPhiDist(confStruct.cellMaxDPhiDist);
   setCalJointLayer(confStruct.calJointLayer);
   setCalJointSection(confStruct.calJointSection);
   setdoEtaAxesDivision(confStruct.doEtaAxesDivision);
   setdoPhiAxesDivision(confStruct.doPhiAxesDivision);
   setLayerStartIdx(confStruct.layerStartIdx);
   setLayerEndIdx(confStruct.layerEndIdx);
   setSectionStartIdx(confStruct.sectionStartIdx);
   setSectionEndIdx(confStruct.sectionEndIdx);
 }

Member Function Documentation

◆ addLayer()

void xAOD::RingSetConf_v1::addLayer ( const CaloSampling::CaloSample c )

Add layer.

Definition at line 561 of file RingSetConf_v1.cxx.

                                                            {
   static const SG::AuxElement::Accessor< std::vector<unsigned> > acc("layers");
   acc( *this ).push_back(c);
 }

◆ addRawConfColBounderies()

void xAOD::RingSetConf_v1::addRawConfColBounderies ( RawConfCollection & clRingsConf )

static

Add to RawConfCollection its JointLayer/JointSection bounderies.

Definition at line 239 of file RingSetConf_v1.cxx.

 {
   if ( clRingsConf.empty() ) {
     throw std::runtime_error(std::string(
           "Cannot add the JointLayer/JointSection bounderies "
           "into an empty RawConfCollection."));
   }
  
   unsigned startOfEMJointSection(0),
            endOfEMJointSection(0),
            startOfHADJointSection(0),
            endOfHADJointSection(0),
            currentRingIdx(0);
  
   bool isWithinEMJointSection(false), 
        isWithinHADJointSection(false);
  
   // Get the section start, end indexes:
   for ( const auto &rawConf : clRingsConf ){
     Ringer::CalJointSection secType = rawConf.calJointSection;
     bool isEM = secType == Ringer::CalJointSection::EM;
     bool isHAD = secType == Ringer::CalJointSection::HAD;
     // Check if we are entering a new section:
     if ( !isWithinEMJointSection && isEM ) {
       startOfEMJointSection = currentRingIdx;
       isWithinEMJointSection = true;
     }
     if ( !isWithinHADJointSection && isHAD ) {
       startOfHADJointSection = currentRingIdx;
       isWithinHADJointSection = true;
     }
     // Check if we left a section:
     if ( isWithinEMJointSection && !isEM ) {
       endOfEMJointSection = currentRingIdx;
       isWithinEMJointSection = false;
     }
     if ( isWithinHADJointSection && !isHAD ) {
       endOfHADJointSection = currentRingIdx;
       isWithinHADJointSection = false;
     }
     // Increment current index by the layer size:
     currentRingIdx += rawConf.nRings;
   }
   // We finished looping, close the contained section boundery with the last
   // ring index:
   if ( isWithinEMJointSection ) {
     endOfEMJointSection = currentRingIdx;
   } else if ( isWithinHADJointSection ) {
     endOfHADJointSection = currentRingIdx;
   }
  
   currentRingIdx = 0;
   // Now fill the indexes:
   for ( auto &rawConf : clRingsConf ){
     // Fill the layer indexes:
     rawConf.layerStartIdx = currentRingIdx;
     currentRingIdx += rawConf.nRings;
     rawConf.layerEndIdx   = currentRingIdx;
     // Fill the section indexes:
     switch (rawConf.calJointSection) {
       case Ringer::CalJointSection::EM:
       {
         rawConf.sectionStartIdx = startOfEMJointSection;
         rawConf.sectionEndIdx = endOfEMJointSection;
         break;
       }
       case Ringer::CalJointSection::HAD:
       {
         rawConf.sectionStartIdx = startOfHADJointSection;
         rawConf.sectionEndIdx = endOfHADJointSection;
         break;
       }
       default:
         throw std::runtime_error(std::string(
               "Found unknown JointSection type."));
     }
   }
 }

◆ auxdata() [1/4]

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

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

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

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

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

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

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

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

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.

◆ calJointLayer()

Ringer::CalJointLayer xAOD::RingSetConf_v1::calJointLayer ( ) const

Retrieve this RingSet conf CalJointLayer.

RingSetConf_v1 calJointLayer,calJointSection get and set:

Definition at line 576 of file RingSetConf_v1.cxx.

                                                         {
   static const SG::AuxElement::ConstAccessor< unsigned > acc("calJointLayer");
   return static_cast<Ringer::CalJointLayer>( acc( *this ) );
 }

◆ calJointSection()

Ringer::CalJointSection xAOD::RingSetConf_v1::calJointSection ( ) const

Retrieve this RingSet conf CalJointSection.

Definition at line 588 of file RingSetConf_v1.cxx.

                                                             {
   static const SG::AuxElement::ConstAccessor< unsigned > acc("calJointSection");
   return static_cast<Ringer::CalJointSection>( acc( *this ) );
 }

◆ cellMaxDEtaDist()

float xAOD::RingSetConf_v1::cellMaxDEtaDist ( ) const

Return the maximun cell distance in eta w.r.t seed.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ cellMaxDPhiDist()

float xAOD::RingSetConf_v1::cellMaxDPhiDist ( ) const

Return the maximun cell distance in phi w.r.t seed.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

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

◆ clearLayers()

void xAOD::RingSetConf_v1::clearLayers ( )

Clear layers.

Definition at line 567 of file RingSetConf_v1.cxx.

                                 {
   static const SG::AuxElement::Accessor< std::vector<unsigned> > acc("layers");
   acc( *this ).clear();
 }

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

◆ doEtaAxesDivision()

setPhiWidth setCellMaxDPhiDist bool xAOD::RingSetConf_v1::doEtaAxesDivision ( ) const

Return the etaAxesDivision configuration.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

Definition at line 628 of file RingSetConf_v1.cxx.

                                              {
   static const SG::AuxElement::ConstAccessor< char > acc("doEtaAxesDivision");
   return static_cast<bool>( acc( *this) );
 }

◆ doPhiAxesDivision()

bool xAOD::RingSetConf_v1::doPhiAxesDivision ( ) const

Return the phiAxesDivision configuration.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

Definition at line 640 of file RingSetConf_v1.cxx.

                                              {
   static const SG::AuxElement::ConstAccessor< char > acc("doPhiAxesDivision");
   return static_cast<bool>( acc( *this ) );
 }

◆ etaWidth()

float xAOD::RingSetConf_v1::etaWidth ( ) const

Returns the etaWidth configuration step used for this RingSet.

This parameter is used to determine which Ring index the cell is within, for eta coordinate.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ fillRingSetConfContainer()

void xAOD::RingSetConf_v1::fillRingSetConfContainer	(	const RawConfCollection &	rawConfCol,
		RingSetConfContainer_v1 *	container
	)

static

Creates RingSetConfContainer from RawConfCollection.

Definition at line 360 of file RingSetConf_v1.cxx.

 {
  
   // Protect against bad pointers:
   if ( container == nullptr ) {
     container = new RingSetConfContainer_v1();
   }
  
   // Loop through RawConfCollection and build true RingSetConf_v1 objects from
   // them:
   for ( const auto& rsRawConf : rawConfCol ) {
     RingSetConf_v1 *rsConf =  new RingSetConf_v1( rsRawConf );
     container->push_back(rsConf);
   }
  
 }

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

◆ getEdges() [1/2]

void xAOD::RingSetConf_v1::getEdges	(	const RawConfCollection &	clRingsConf,
		const Ringer::CalJointLayer	layer,
		unsigned &	startEdge,
		unsigned &	endEdge
	)

static

Get CalJointLayer start and end edges.

Definition at line 345 of file RingSetConf_v1.cxx.

 {
   for( const auto &rsConf : clRingsConf ) {
     if ( rsConf.calJointLayer == layer ) {
       startEdge = rsConf.layerStartIdx;
       endEdge = rsConf.layerEndIdx;
       return;
     }
   }
 }

◆ getEdges() [2/2]

void xAOD::RingSetConf_v1::getEdges	(	const RawConfCollection &	clRingsConf,
		const Ringer::CalJointSection	sec,
		unsigned &	startEdge,
		unsigned &	endEdge
	)

static

Get CalJointSection start and end edges.

Definition at line 330 of file RingSetConf_v1.cxx.

 {
   for( const auto &rsConf : clRingsConf ) {
     if ( rsConf.calJointSection == sec ) {
       startEdge = rsConf.sectionStartIdx;
       endEdge = rsConf.sectionEndIdx;
       return;
     }
   }
 }

◆ getRawConf()

const RingSetConf_v1::RawConf xAOD::RingSetConf_v1::getRawConf ( ) const

Retrieve raw RingSet Configuration struct.

Definition at line 682 of file RingSetConf_v1.cxx.

                                                              {
   return RawConf( *this );
 }

◆ getRawConfCol()

void xAOD::RingSetConf_v1::getRawConfCol	(	RawConfCollection &	rawConfCol,
		const RingSetConfContainer_v1 *	container
	)

static

Retrieve RawConfCollection from RingSetConf container.

Definition at line 380 of file RingSetConf_v1.cxx.

 {
   // Protect against bad pointers:
   if ( container == nullptr ) {
     throw std::runtime_error(std::string("Retrieved nullptr when trying to create"
                                          " RawConfCollection."));
   }
  
   // Clear previous collection
   rawConfCol.clear();
   // Push back new configuration
   for ( const auto *const rsConf : *container ) {
     rawConfCol.push_back( rsConf->getRawConf() );
   }
 }

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

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

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

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.

◆ isEM1Layer()

bool xAOD::RingSetConf_v1::isEM1Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 80 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const CaloSampling::CaloSample layer : layers){
     if ( (layer != CaloSampling::CaloSample::EMB1        ) &&
          (layer != CaloSampling::CaloSample::EME1        ) ){
       return false;
     }
   }
   return true;
 }

◆ isEM2Layer()

bool xAOD::RingSetConf_v1::isEM2Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 94 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::EMB2        ) &&
          (layer != CaloSampling::CaloSample::EME2        ) ){
       return false;
     }
   }
   return true;
 }

◆ isEM3Layer()

bool xAOD::RingSetConf_v1::isEM3Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 108 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::EMB3        ) &&
          (layer != CaloSampling::CaloSample::EME3        ) ){
       return false;
     }
   }
   return true;
 }

◆ isEMSection()

bool xAOD::RingSetConf_v1::isEMSection ( const std::vector< CaloSampling::CaloSample > & layers )

static

Static methods:

Layer determination

Definition at line 21 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::PreSamplerB ) &&
          (layer != CaloSampling::CaloSample::PreSamplerE ) &&
          (layer != CaloSampling::CaloSample::EMB1        ) &&
          (layer != CaloSampling::CaloSample::EMB2        ) &&
          (layer != CaloSampling::CaloSample::EMB3        ) &&
          (layer != CaloSampling::CaloSample::EME1        ) &&
          (layer != CaloSampling::CaloSample::EME2        ) &&
          (layer != CaloSampling::CaloSample::EME3        ) ){
       return false;
     }
   }
   return true;
 }

◆ isHAD1Layer()

bool xAOD::RingSetConf_v1::isHAD1Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 122 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::HEC0        ) &&
          (layer != CaloSampling::CaloSample::HEC1        ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileBar0    ) &&
          (layer != CaloSampling::CaloSample::TileGap1    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileGap2    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileGap3    ) &&
          (layer != CaloSampling::CaloSample::TileExt0    ) ){
       return false;
     }
   }
   return true;
 }

◆ isHAD2Layer()

bool xAOD::RingSetConf_v1::isHAD2Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 141 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::HEC1        ) &&
          (layer != CaloSampling::CaloSample::HEC2        ) &&
          (layer != CaloSampling::CaloSample::TileBar1    ) &&
          (layer != CaloSampling::CaloSample::TileGap1    ) &&
          (layer != CaloSampling::CaloSample::TileGap2    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileGap3    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileExt1    ) ){
       return false;
     }
   }
   return true;
 }

◆ isHAD3Layer()

bool xAOD::RingSetConf_v1::isHAD3Layer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 160 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::HEC2        ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::HEC3        ) &&
          (layer != CaloSampling::CaloSample::TileBar2    ) &&
          (layer != CaloSampling::CaloSample::TileGap1    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileGap2    ) && 
          (layer != CaloSampling::CaloSample::TileGap3    ) && // Added for flexibility
          (layer != CaloSampling::CaloSample::TileExt2    ) ){
       return false;
     }
   }
   return true;
 }

◆ isHADSection()

bool xAOD::RingSetConf_v1::isHADSection ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 41 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const auto &layer : layers){
     if ( (layer != CaloSampling::CaloSample::HEC0 ) &&
          (layer != CaloSampling::CaloSample::HEC1 ) &&
          (layer != CaloSampling::CaloSample::HEC2 ) &&
          (layer != CaloSampling::CaloSample::HEC3 ) &&
          (layer != CaloSampling::CaloSample::TileBar0 ) &&
          (layer != CaloSampling::CaloSample::TileBar1 ) &&
          (layer != CaloSampling::CaloSample::TileBar2 ) &&
          (layer != CaloSampling::CaloSample::TileGap1 ) &&
          (layer != CaloSampling::CaloSample::TileGap2 ) &&
          (layer != CaloSampling::CaloSample::TileGap3 ) &&
          (layer != CaloSampling::CaloSample::TileExt0 ) &&
          (layer != CaloSampling::CaloSample::TileExt1 ) &&
          (layer != CaloSampling::CaloSample::TileExt2 ) ){
       return false;
     }
   }
   return true;
 }

◆ isPSLayer()

bool xAOD::RingSetConf_v1::isPSLayer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 66 of file RingSetConf_v1.cxx.

 {
   if (layers.empty()) return false;
   for (const CaloSampling::CaloSample &layer : layers){
     if ( (layer != CaloSampling::CaloSample::PreSamplerB ) &&
          (layer != CaloSampling::CaloSample::PreSamplerE ) ){
       return false;
     }
   }
   return true;
 }

◆ layerAt()

CaloSampling::CaloSample xAOD::RingSetConf_v1::layerAt ( const unsigned idx ) const

Get ith layer.

Definition at line 555 of file RingSetConf_v1.cxx.

                                                                        {
   static const SG::AuxElement::ConstAccessor< std::vector<unsigned> > acc("layers");
   return static_cast<CaloSampling::CaloSample>( acc( *this ).at(idx) );
 }

◆ layerEndIdx()

unsigned xAOD::RingSetConf_v1::layerEndIdx ( ) const

Returns end of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ layers()

const std::vector< CaloSampling::CaloSample >& xAOD::RingSetConf_v1::layers ( ) const

get layers

Defined via AUXSTORE_OBJECT_SETTER_AND_GETTER macro

◆ layerStartIdx()

unsigned xAOD::RingSetConf_v1::layerStartIdx ( ) const

Returns start of layer index for this RingSet Configuration when this configuration is concatened into a non segmented representation.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

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

◆ nLayers()

unsigned xAOD::RingSetConf_v1::nLayers ( ) const

RingSet layers size:

Definition at line 549 of file RingSetConf_v1.cxx.

                                        {
   static const SG::AuxElement::ConstAccessor<std::vector<unsigned> > acc("layers");
   return acc( *this ).size();
 }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nRings()

unsigned xAOD::RingSetConf_v1::nRings ( ) const

Get nRings.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ operator=()

RingSetConf_v1 & xAOD::RingSetConf_v1::operator= ( const RingSetConf_v1 & clrings )

Assignment Operator.

Using the assignment of SG::AuxElement.

Definition at line 688 of file RingSetConf_v1.cxx.

                                                                       {
   if (this != &rsConf ){ // protect against invalid self-assignment
     if (!this->container() && !this->hasStore() ) {
       makePrivateStore();
     }
     this->SG::AuxElement::operator=( rsConf );
   }
   // by convention, always return *this
   return *this;
 }

◆ phiWidth()

float xAOD::RingSetConf_v1::phiWidth ( ) const

Returns the phiWidth configuration step used for this RingSet.

This parameter is used to determine which Ring index the cell is within, for phi coordinate.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ print() [1/3]

void xAOD::RingSetConf_v1::print	(	const RawConf &	raw,
		std::ostream &	stream
	)

static

Prints rawConf.

RawConf methods.

Definition at line 206 of file RingSetConf_v1.cxx.

 {
   stream << "| "; 
  
   stream << raw.nRings << " Rings, Layer: " << raw.calJointLayer <<
     " (" << raw.layerStartIdx << " -> " << raw.layerEndIdx <<
     ") Section: " << raw.calJointSection << 
     " (" << raw.sectionStartIdx << " -> " << raw.sectionEndIdx <<
     "), etaWidth = " << raw.etaWidth << ", phiWidth = " << raw.phiWidth <<
       ", cellMaxDEtaDist = " << raw.cellMaxDEtaDist <<
       ", cellMaxDPhiDist = " << raw.cellMaxDPhiDist <<
     ", doEtaAxesDivision = " << raw.doEtaAxesDivision <<
     ", doPhiAxesDivision = " << raw.doPhiAxesDivision;
  
   stream << "|" << std::endl;
 }

◆ print() [2/3]

void xAOD::RingSetConf_v1::print	(	const RawConfCollection &	raw,
		std::ostream &	stream
	)

static

Prints RawConfCollection.

Definition at line 319 of file RingSetConf_v1.cxx.

 {
   stream << "RawConfCollection is : " << std::endl;
   for (unsigned rsIdx = 0; rsIdx < rawCol.size(); ++rsIdx) {
     stream << "RawConf #" << rsIdx << " : ";
     RingSetConf_v1::print(rawCol.at(rsIdx),stream);
   }
 }

◆ print() [3/3]

void xAOD::RingSetConf_v1::print ( std::ostream & stream ) const

Definition at line 700 of file RingSetConf_v1.cxx.

                                                      {
   stream << "| "; 
  
   stream << nRings() << " Rings, Layer: " << calJointLayer() <<
     " (" << layerStartIdx() << " -> " << layerEndIdx() <<
     ") Section: " << calJointSection() << 
     " (" << sectionStartIdx() << " -> " << sectionEndIdx() <<
     "), etaWidth = " << etaWidth() << ", phiWidth = " << phiWidth() <<
     ", cellMaxDEtaDist = " << cellMaxDEtaDist() <<
     ", cellMaxDPhiDist = " << cellMaxDPhiDist() <<
     ", doEtaAxesDivision = " << doEtaAxesDivision() << 
     ", doPhiAxesDivision = " << doPhiAxesDivision();
  
   stream << "|" << std::endl;
 }

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

◆ sectionEndIdx()

unsigned xAOD::RingSetConf_v1::sectionEndIdx ( ) const

Returns end of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ sectionStartIdx()

unsigned xAOD::RingSetConf_v1::sectionStartIdx ( ) const

Returns start of section index for this RingSet Configuration when this configuration is concatened into a non segmented representation.

◆ setCalJointLayer()

void xAOD::RingSetConf_v1::setCalJointLayer ( Ringer::CalJointLayer calJointLayer )

Set this RingSet CalJointLayer.

Definition at line 582 of file RingSetConf_v1.cxx.

                                                                             {
   static const SG::AuxElement::Accessor< unsigned > acc("calJointLayer");
   acc.set( *this , calJointLayer );
 }

◆ setCalJointSection()

void xAOD::RingSetConf_v1::setCalJointSection ( Ringer::CalJointSection calJointSection )

Set this RingSet CalJointSection.

Definition at line 594 of file RingSetConf_v1.cxx.

                                                  {
   static const SG::AuxElement::Accessor< unsigned > acc("calJointSection");
   acc.set( *this , calJointSection );
 }

◆ setCellMaxDEtaDist()

void xAOD::RingSetConf_v1::setCellMaxDEtaDist ( float cellMaxDEtaDist )

Set maxCellDEtaDist.

For more details, see maxCellDEtaDist()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setCellMaxDPhiDist()

void xAOD::RingSetConf_v1::setCellMaxDPhiDist ( float cellMaxDPhiDist )

Set maxCellDPhiDist.

For more details, see maxCellDPhiDist()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setdoEtaAxesDivision()

void xAOD::RingSetConf_v1::setdoEtaAxesDivision ( bool doEtaAxesDivision )

Set doEtaAxesDivision.

For more details, see doEtaAxesDivision()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

Definition at line 634 of file RingSetConf_v1.cxx.

                                                                {
   static const SG::AuxElement::Accessor< char > acc("doEtaAxesDivision");
   acc( *this) = static_cast<char>(doEtaAxesDivision);
 }

◆ setdoPhiAxesDivision()

void xAOD::RingSetConf_v1::setdoPhiAxesDivision ( bool doPhiAxesDivision )

Set doPhiAxesDivision.

For more details, see doPhiAxesDivision()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

Definition at line 646 of file RingSetConf_v1.cxx.

                                                                {
   static const SG::AuxElement::Accessor< char > acc("doPhiAxesDivision");
   acc( *this ) = static_cast<char>(doPhiAxesDivision);
 }

◆ setEtaWidth()

void xAOD::RingSetConf_v1::setEtaWidth ( float etaWidth )

Set etaWidth.

For more details, see phiWidth()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

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

◆ setLayerEndIdx()

void xAOD::RingSetConf_v1::setLayerEndIdx ( unsigned layerEndIdx )

Set end layer configuration index.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setLayers()

void xAOD::RingSetConf_v1::setLayers ( const std::vector< CaloSampling::CaloSample > & layers )

set layers

Defined via AUXSTORE_OBJECT_SETTER_AND_GETTER macro

◆ setLayerStartIdx()

void xAOD::RingSetConf_v1::setLayerStartIdx ( unsigned layerStartIdx )

Set start layer configuration index.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

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

◆ setNRings()

void xAOD::RingSetConf_v1::setNRings ( unsigned nRings )

Set nRings.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setPhiWidth()

void xAOD::RingSetConf_v1::setPhiWidth ( float phiWidth )

Set phiWidth.

For more details, see phiWidth()

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setSectionEndIdx()

void xAOD::RingSetConf_v1::setSectionEndIdx ( unsigned sectionEndIdx )

Set end section configuration index.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

◆ setSectionStartIdx()

void xAOD::RingSetConf_v1::setSectionStartIdx ( unsigned sectionEndIdx )

Set start section configuration index.

Defined via AUXSTORE_PRIMITIVE_SETTER_AND_GETTER macro

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

◆ totalNumberOfRings()

unsigned xAOD::RingSetConf_v1::totalNumberOfRings ( const RawConfCollection & clRingsConf )

static

Get the totalNumber of Rings contained in this configuration:

RawConfCollection Methods.

Definition at line 227 of file RingSetConf_v1.cxx.

 {
   unsigned totalNumberOfRings(0);
   for ( const auto &rsRawConfCol : rawConfCol )
   {
     totalNumberOfRings += rsRawConfCol.nRings;
   }
   return totalNumberOfRings;
 }

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

◆ whichLayer()

Ringer::CalJointLayer xAOD::RingSetConf_v1::whichLayer ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 188 of file RingSetConf_v1.cxx.

 {
   if       (isPSLayer  (layers)) return Ringer::CalJointLayer::PS;
   else if  (isEM1Layer (layers)) return Ringer::CalJointLayer::EM1;
   else if  (isEM2Layer (layers)) return Ringer::CalJointLayer::EM2;
   else if  (isEM3Layer (layers)) return Ringer::CalJointLayer::EM3;
   else if  (isHAD1Layer(layers)) return Ringer::CalJointLayer::HAD1;
   else if  (isHAD2Layer(layers)) return Ringer::CalJointLayer::HAD2;
   else if  (isHAD3Layer(layers)) return Ringer::CalJointLayer::HAD3;
   else return Ringer::CalJointLayer::UnknownJointLayer;
 }

◆ whichSection()

Ringer::CalJointSection xAOD::RingSetConf_v1::whichSection ( const std::vector< CaloSampling::CaloSample > & layers )

static

Definition at line 179 of file RingSetConf_v1.cxx.

 {
   if       (isEMSection (layers))  return Ringer::CalJointSection::EM;
   else if  (isHADSection(layers))  return Ringer::CalJointSection::HAD;
   else return Ringer::CalJointSection::UnknownJointSection;
 }

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ RawConfCollection

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ RingSetConf_v1() [1/4]

◆ RingSetConf_v1() [2/4]

◆ RingSetConf_v1() [3/4]

◆ RingSetConf_v1() [4/4]

Member Function Documentation

◆ addLayer()

◆ addRawConfColBounderies()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ calJointLayer()

◆ calJointSection()

◆ cellMaxDEtaDist()

◆ cellMaxDPhiDist()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ clearLayers()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ doEtaAxesDivision()

◆ doPhiAxesDivision()

◆ etaWidth()

◆ fillRingSetConfContainer()

◆ getAuxIDs()

◆ getConstStore()

◆ getEdges() [1/2]

◆ getEdges() [2/2]

◆ getRawConf()

◆ getRawConfCol()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ isEM1Layer()

◆ isEM2Layer()

◆ isEM3Layer()

◆ isEMSection()

◆ isHAD1Layer()

◆ isHAD2Layer()

◆ isHAD3Layer()

◆ isHADSection()

◆ isPSLayer()

◆ layerAt()

◆ layerEndIdx()

◆ layers()

◆ layerStartIdx()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]