xAOD::CaloVertexedClusterBase Class Reference

Evaluate cluster kinematics with a different vertex / signal state. More...

#include <CaloVertexedClusterBase.h>

Inheritance diagram for xAOD::CaloVertexedClusterBase:

Collaboration diagram for xAOD::CaloVertexedClusterBase:

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
	CaloVertexedClusterBase (const CaloCluster &cl)
	Constructor. More...
	CaloVertexedClusterBase (const CaloCluster &cl, CaloCluster::State s)
	Constructor. More...
const CaloCluster &	clust () const
	Return the cluster being proxied,. More...
virtual Type::ObjectType	type () const final
	The type of the object as a simple enumeration. 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 >::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 bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. 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 >::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	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...
void	makePrivateStore ()
	Create a new (empty) private store for this object. More...
template<class U1 >
void	makePrivateStore (const U1 &other)
	Create a new private store for this object and copy aux data. More...
template<class U1 >
void	makePrivateStore (const U1 *other)
	Create a new private store for this object and copy aux data. More...
void	releasePrivateStore ()
	Release and free any private store associated with this object. More...
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore. More...
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore. More...
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...
void	clearCache ()
	Clear the cached aux data pointers. More...
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...
bool	hasStore () const
	Return true if this object has an associated store. More...
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...
bool	clearDecorations () const
	Clear all decorations. More...
bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...
size_t	index () const
	Return the index of this element within its container. More...
size_t	index () const
	Return the index of this element within its container. More...

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

Protected Member Functions
void	computeVertexCorr (const Amg::Vector3D &vx, double radius)
	Calculate cluster kinematics for a given vertex. More...
bool	noPrivateData () const
	True if this element has no private data. More...
bool	havePrivateData () const
	True if this element currently has private data. More...
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Protected Attributes
const CaloCluster *	m_cl
	The cluster being proxied. More...
double	m_eta
	The recalculated cluster eta. More...
double	m_phi
	The recalculated cluster phi. More...
FourMom_t	m_p4
	The recalculated cluster 4-momentum. 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

Evaluate cluster kinematics with a different vertex / signal state.

A base for classes acting as a proxy for a cluster object. Concrete classes are

• CaloVertexedCluster : vertex correction uses the EM layer information. Available only in athena, since geometry is required.
• CaloVertexedTopoCluster : vertex correction uses the "" It provides the same IParticle interface, except that the cluster kinematics are recalculated for a different vertex, and optionally a different signal state.

Definition at line 39 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

Member Typedef Documentation

Accessor

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

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 548 of file AuxElement.h.

ConstAccessor

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

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 545 of file AuxElement.h.

Decorator

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

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 551 of file AuxElement.h.

FourMom_t

typedef TLorentzVector xAOD::IParticle::FourMom_t

inherited

Definition of the 4-momentum type.

Definition at line 69 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

TypelessConstAccessor

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

inherited

Definition at line 542 of file AuxElement.h.

Member Enumeration Documentation

PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

  {
    NO_PRIVATE = 0,
    HAVE_PRIVATE = 1,
    HAD_PRIVATE = 2,
  };

Constructor & Destructor Documentation

CaloVertexedClusterBase() [1/2]

xAOD::CaloVertexedClusterBase::CaloVertexedClusterBase

(

const CaloCluster &

cl

)

Constructor.

Parameters

cl	The cluster to proxy.

In this case, we'll return unchanged the kinematics of the cluster for the default signal state.

Definition at line 33 of file CaloVertexedClusterBase.cxx.

  : m_cl (&cl),
    m_eta (cl.eta()),
    m_phi (cl.phi()),
    m_p4 (cl.p4())
{
}

CaloVertexedClusterBase() [2/2]

xAOD::CaloVertexedClusterBase::CaloVertexedClusterBase	(	const CaloCluster &	cl,
		CaloCluster::State	s
	)

Constructor.

Parameters

cl	The cluster to proxy.
s	The desired signal state.

In this case, we'll return unchanged the kinematics of the cluster for signal state S.

Definition at line 50 of file CaloVertexedClusterBase.cxx.

  : m_cl (&cl),
    m_eta (cl.eta(s)),
    m_phi (cl.phi(s)),
    m_p4 (cl.p4(s))
{
}

Member Function Documentation

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 >

XAOD_AUXDATA_DEPRECATED T& xAOD::IParticle::auxdata ( const std::string &  name, const std::string &  clsname = ""  )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                  {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

auxdata() [4/4]

template<class T >

XAOD_AUXDATA_DEPRECATED const T& xAOD::IParticle::auxdata ( const std::string &  name, const std::string &  clsname = ""  ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                              {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

auxdataConst() [1/2]

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

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdataConst() [2/2]

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

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdecor() [1/2]

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

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

auxdecor() [2/2]

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

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 535 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    r.clear (auxid, *container(), index(), 1);
  }
}

clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 319 of file AuxElement.cxx.

{
  if (container())
    container()->clearCache();
}

clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 385 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->clearDecorations();
  return false;
}

clust()

const CaloCluster& xAOD::CaloVertexedClusterBase::clust ( ) const

inline

Return the cluster being proxied,.

Definition at line 69 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return *m_cl; }

computeVertexCorr()

void xAOD::CaloVertexedClusterBase::computeVertexCorr ( const Amg::Vector3D &  vx, double  radius  )

protected

Calculate cluster kinematics for a given vertex.

Parameters

vx	The vertex to use for calculating cluster kinematics.

Definition at line 67 of file CaloVertexedClusterBase.cxx.

{
 
  if (radius<1.) return;
 
  double eta = m_eta;
  double phi = m_phi;
 
  if (std::fabs(eta)>10. || std::fabs(phi)>10.) return;
 
  CxxUtils::sincos sc (phi);
  double iradius = 1 / radius;
  m_eta += (-vx[2]/cosh(m_eta) + sc.apply (vx[1], vx[0])*tanh(m_eta)) * iradius;
  m_phi += sc.apply (vx[0], -vx[1]) * iradius;
  m_phi = CxxUtils::wrapToPi(m_phi);
 
  double pt = m_p4.P() / cosh (m_eta);
  m_p4.SetPtEtaPhiE (pt, m_eta, m_phi, m_p4.E());
}

container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement &  other )

privateinherited

Copy aux data from another object.

Parameters

other

The object from which to copy.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 561 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    this->clearAux();
    return;
  }
 
  size_t oindex = other.index();
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  SG::AuxVectorData& cont = *container();
  for (SG::auxid_t auxid : other_ids) {
    if (!r.isLinked (auxid)) {
      r.copy (auxid, cont, index(), *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, cont, index(), 1);
    }
  }
}

e()

virtual double xAOD::CaloVertexedClusterBase::e ( ) const

inlinefinalvirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 83 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_p4.E(); }

eta()

virtual double xAOD::CaloVertexedClusterBase::eta ( ) const

inlinefinalvirtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 77 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_eta; }

getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 335 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getAuxIDs();
  if (container())
    return container()->getAuxIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getAuxIDs();
#endif
}

getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 284 of file AuxElement.cxx.

{
  if (havePrivateData()) {
    return m_container->getConstStore();
  }
  return 0;
}

getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 299 of file AuxElement.cxx.

{
  if (havePrivateData()) {
#ifdef ATHCONTAINERS_R21_COMPAT
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
#else
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
#endif
    return container_nc->getStore();
  }
  return 0;
}

hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 368 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasNonConstStore();
  return false;
}

hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 355 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasStore();
  return false;
}

havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

isAvailable()

template<class T >

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable ( const std::string &  name, const std::string &  clsname = ""  ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                              {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

isAvailableWritable() [1/2]

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.

isAvailableWritable() [2/2]

template<class T >

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable ( const std::string &  name, const std::string &  clsname = ""  ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                      {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

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.

m()

virtual double xAOD::CaloVertexedClusterBase::m ( ) const

inlinefinalvirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 81 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_p4.M(); }

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.

noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

p4()

virtual FourMom_t xAOD::CaloVertexedClusterBase::p4 ( ) const

inlinefinalvirtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 88 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_p4; }

phi()

virtual double xAOD::CaloVertexedClusterBase::phi ( ) const

inlinefinalvirtual

The azimuthal angle ( \(\phi\)) of the particle.

Implements xAOD::IParticle.

Definition at line 79 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_phi; }

pt()

virtual double xAOD::CaloVertexedClusterBase::pt ( ) const

inlinefinalvirtual

The transverse momentum ( \(p_T\)) of the particle.

Implements xAOD::IParticle.

Definition at line 75 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_p4.Pt(); }

rapidity()

virtual double xAOD::CaloVertexedClusterBase::rapidity ( ) const

inlinefinalvirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 85 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_p4.Rapidity(); }

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
}

setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store

The new store.

setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

setIndex()

void SG::AuxElement::setIndex ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

setIndexPrivate()

bool SG::AuxElement::setIndexPrivate ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 462 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (hadPrivateData()) {
    // We had a private store, but it was released because we were added
    // to a container.
 
    if (container == 0) {
      // We're being moved out of the container.  Make a new private
      // store, copy the data, and switch to it.
      auto privateData = new SG::AuxElementPrivateData;
      AuxElement to (privateData, 0);
      to.copyAux (*this);
      IAuxElement::setIndex (0);
      IAuxElement::setHavePrivateData();
      m_container = privateData;
      return true;
    }
  }
  else if (havePrivateData() &&
           typeid(*m_container) == typeid(AuxElementPrivateData))
  {
    // We currently have a private store.
 
    if (container != 0 && container != m_container) {
      // We're being added to a container.
      // Aux data has already been copied.
      // Release private store.
      IAuxElement::setIndex (index);
      IAuxElement::setHadPrivateData();
      delete m_container;
      m_container = container;
      return false;
    }
  }
  else {
    // We have a standalone store.
    throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                  "from a container.");
  }
 
  IAuxElement::setIndex (index);
  m_container = container;
  return false;
#else
  return ConstAuxElement::setIndexPrivate (index, container);
#endif
}

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.

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

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.

type()

virtual Type::ObjectType xAOD::CaloVertexedClusterBase::type ( ) const

inlinefinalvirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 93 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

{ return m_cl->type(); }

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

Member Data Documentation

m_cl

const CaloCluster* xAOD::CaloVertexedClusterBase::m_cl

protected

The cluster being proxied.

Definition at line 105 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 324 of file AuxElement.h.

m_eta

double xAOD::CaloVertexedClusterBase::m_eta

protected

The recalculated cluster eta.

Definition at line 109 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.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_p4

FourMom_t xAOD::CaloVertexedClusterBase::m_p4

protected

The recalculated cluster 4-momentum.

Definition at line 117 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

m_phi

double xAOD::CaloVertexedClusterBase::m_phi

protected

The recalculated cluster phi.

Definition at line 113 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 920 of file AuxElement.h.

---

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

• Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h
• CaloVertexedClusterBase.cxx