xAOD::AuxContainerBase Class Reference

Common base class for the auxiliary containers. More...

#include <AuxContainerBase.h>

Inherits SG::IAuxStore, SG::IAuxStoreIO, SG::IAuxStoreHolder, and ILockable.

Inherited by DMTest::AllocTestAuxContainer_v1, DMTest::CAuxContainer_v1, DMTest::CLinksAuxContainer_v1, DMTest::GAuxContainer_v1, DMTest::HAuxContainer_v1, DMTest::HAuxContainer_v2, DMTest::JVecAuxContainer_v1, DMTest::PAuxContainer_v1, DMTest::PLinksAuxContainer_v1, TrigNavTest::TestAuxB, xAOD::AFPDataAuxContainer_v1, xAOD::AFPProtonAuxContainer_v1, xAOD::AFPSiHitAuxContainer_v1, xAOD::AFPSiHitAuxContainer_v2, xAOD::AFPSiHitsClusterAuxContainer_v1, xAOD::AFPToFHitAuxContainer_v1, xAOD::AFPToFTrackAuxContainer_v1, xAOD::AFPTrackAuxContainer_v1, xAOD::AFPTrackAuxContainer_v2, xAOD::AFPVertexAuxContainer_v1, xAOD::ALFADataAuxContainer_v1, xAOD::BCMRawDataAuxContainer_v1, xAOD::BTaggingAuxContainer_v1, xAOD::BTaggingAuxContainer_v2, xAOD::BTaggingTrigAuxContainer_v1, xAOD::BTagVertexAuxContainer_v1, xAOD::BunchConfAuxContainer_v1, xAOD::CaloClusterAuxContainer_v1, xAOD::CaloClusterAuxContainer_v2, xAOD::CaloClusterTrigAuxContainer_v1, xAOD::CaloRingsAuxContainer_v1, xAOD::CaloTowerAuxContainer_v1, xAOD::CMMCPHitsAuxContainer_v1, xAOD::CMMEtSumsAuxContainer_v1, xAOD::CMMJetHitsAuxContainer_v1, xAOD::CMXCPHitsAuxContainer_v1, xAOD::CMXCPTobAuxContainer_v1, xAOD::CMXEtSumsAuxContainer_v1, xAOD::CMXJetHitsAuxContainer_v1, xAOD::CMXJetTobAuxContainer_v1, xAOD::CMXRoIAuxContainer_v1, xAOD::CompositeParticleAuxContainer_v1, xAOD::CPMHitsAuxContainer_v1, xAOD::CPMRoIAuxContainer_v1, xAOD::CPMTobRoIAuxContainer_v1, xAOD::CPMTowerAuxContainer_v1, xAOD::CPMTowerAuxContainer_v2, xAOD::CutBookkeeperAuxContainer_v1, xAOD::DiTauJetAuxContainer_v1, xAOD::eFexEMRoIAuxContainer_v1, xAOD::eFexTauRoIAuxContainer_v1, xAOD::eFexTowerAuxContainer_v1, xAOD::EgammaAuxContainer_v1, xAOD::ElectronAuxContainer_v2, xAOD::ElectronAuxContainer_v3, xAOD::ElectronTrigAuxContainer_v1, xAOD::EmTauRoIAuxContainer_v1, xAOD::EmTauRoIAuxContainer_v2, xAOD::EventInfoAuxContainer_v1, xAOD::ExampleElectronAuxContainer_v1, xAOD::FlowElementAuxContainer_v1, xAOD::ForwardEventInfoAuxContainer_v1, xAOD::GBlockAuxContainer_v1, xAOD::gFexGlobalRoIAuxContainer_v1, xAOD::gFexJetRoIAuxContainer_v1, xAOD::gFexTowerAuxContainer_v1, xAOD::HGTDClusterAuxContainer_v1, xAOD::HIEventShapeAuxContainer_v1, xAOD::HIEventShapeAuxContainer_v2, xAOD::JEMEtSumsAuxContainer_v1, xAOD::JEMEtSumsAuxContainer_v2, xAOD::JEMHitsAuxContainer_v1, xAOD::JEMRoIAuxContainer_v1, xAOD::JEMTobRoIAuxContainer_v1, xAOD::JetAuxContainer_v1, xAOD::JetElementAuxContainer_v1, xAOD::JetElementAuxContainer_v2, xAOD::JetRoIAuxContainer_v1, xAOD::JetRoIAuxContainer_v2, xAOD::jFexFwdElRoIAuxContainer_v1, xAOD::jFexLRJetRoIAuxContainer_v1, xAOD::jFexMETRoIAuxContainer_v1, xAOD::jFexSRJetRoIAuxContainer_v1, xAOD::jFexSumETRoIAuxContainer_v1, xAOD::jFexTauRoIAuxContainer_v1, xAOD::jFexTowerAuxContainer_v1, xAOD::JGTowerAuxContainer_v1, xAOD::L1TopoRawDataAuxContainer_v1, xAOD::L1TopoSimResultsAuxContainer_v1, xAOD::L2CombinedMuonAuxContainer_v1, xAOD::L2IsoMuonAuxContainer_v1, xAOD::L2StandAloneMuonAuxContainer_v1, xAOD::L2StandAloneMuonAuxContainer_v2, xAOD::LumiBlockRangeAuxContainer_v1, xAOD::MBTSModuleAuxContainer_v1, xAOD::MdtDriftCircleAuxContainer_v1, xAOD::MdtTwinDriftCircleAuxContainer_v1, xAOD::MissingETAuxAssociationMap_v1, xAOD::MissingETAuxAssociationMap_v2, xAOD::MissingETAuxComponentMap_v1, xAOD::MissingETAuxContainer_v1, xAOD::MMClusterAuxContainer_v1, xAOD::MuonAuxContainer_v1, xAOD::MuonAuxContainer_v2, xAOD::MuonAuxContainer_v3, xAOD::MuonAuxContainer_v4, xAOD::MuonAuxContainer_v5, xAOD::MuonRoIAuxContainer_v1, xAOD::MuonSegmentAuxContainer_v1, xAOD::MuonSimHitAuxContainer_v1, xAOD::NeutralParticleAuxContainer_v1, xAOD::NRPCRDOAuxContainer_v1, xAOD::NSWMMTPRDOAuxContainer_v1, xAOD::NSWTPRDOAuxContainer_v1, xAOD::ParticleAuxContainer_v1, xAOD::PFOAuxContainer_v1, xAOD::PhotonAuxContainer_v2, xAOD::PhotonAuxContainer_v3, xAOD::PhotonTrigAuxContainer_v1, xAOD::PixelClusterAuxContainer_v1, xAOD::RingSetAuxContainer_v1, xAOD::RingSetConfAuxContainer_v1, xAOD::RODHeaderAuxContainer_v1, xAOD::RODHeaderAuxContainer_v2, xAOD::RpcStrip2DAuxContainer_v1, xAOD::RpcStripAuxContainer_v1, xAOD::SCTRawHitValidationAuxContainer_v1, xAOD::SlowMuonAuxContainer_v1, xAOD::SpacePointAuxContainer_v1, xAOD::sTgcPadAuxContainer_v1, xAOD::sTgcStripAuxContainer_v1, xAOD::sTgcWireAuxContainer_v1, xAOD::StripClusterAuxContainer_v1, xAOD::TauJetAuxContainer_v1, xAOD::TauJetAuxContainer_v2, xAOD::TauJetAuxContainer_v3, xAOD::TauTrackAuxContainer_v1, xAOD::TgcStripAuxContainer_v1, xAOD::TrackCaloClusterAuxContainer_v1, xAOD::TrackJacobianAuxContainer_v1, xAOD::TrackMeasurementAuxContainer_v1, xAOD::TrackMeasurementValidationAuxContainer_v1, xAOD::TrackParametersAuxContainer_v1, xAOD::TrackParticleAuxContainer_v1, xAOD::TrackParticleAuxContainer_v2, xAOD::TrackParticleAuxContainer_v3, xAOD::TrackParticleAuxContainer_v4, xAOD::TrackParticleAuxContainer_v5, xAOD::TrackParticleClusterAssociationAuxContainer_v1, xAOD::TrackStateAuxContainer_v1, xAOD::TrackStateValidationAuxContainer_v1, xAOD::TrackSummaryAuxContainer_v1, xAOD::TrackSurfaceAuxContainer_v1, xAOD::TrigBphysAuxContainer_v1, xAOD::TrigCaloClusterAuxContainer_v1, xAOD::TrigCompositeAuxContainer_v2, xAOD::TrigElectronAuxContainer_v1, xAOD::TrigEMClusterAuxContainer_v2, xAOD::TriggerMenuAuxContainer_v1, xAOD::TriggerMenuJsonAuxContainer_v1, xAOD::TriggerTowerAuxContainer_v1, xAOD::TriggerTowerAuxContainer_v2, xAOD::TrigHisto2DAuxContainer_v1, xAOD::TrigMissingETAuxContainer_v1, xAOD::TrigPassBitsAuxContainer_v1, xAOD::TrigPhotonAuxContainer_v1, xAOD::TrigRingerRingsAuxContainer_v1, xAOD::TrigRingerRingsAuxContainer_v2, xAOD::TrigRNNOutputAuxContainer_v1, xAOD::TrigRNNOutputAuxContainer_v2, xAOD::TrigSpacePointCountsAuxContainer_v1, xAOD::TrigT2MbtsBitsAuxContainer_v1, xAOD::TrigT2ZdcSignalsAuxContainer_v1, xAOD::TrigTrackCountsAuxContainer_v1, xAOD::TrigVertexCountsAuxContainer_v1, xAOD::TruthEventAuxContainer_v1, xAOD::TruthMetaDataAuxContainer_v1, xAOD::TruthParticleAuxContainer_v1, xAOD::TruthPileupEventAuxContainer_v1, xAOD::TruthVertexAuxContainer_v1, xAOD::VertexAuxContainer_v1, xAOD::ZdcModuleAuxContainer_v1, and xAOD::ZdcModuleAuxContainer_v2.

Collaboration diagram for xAOD::AuxContainerBase:

Public Types
typedef SG::auxid_t	auxid_t
	The aux ID type definition. More...
typedef SG::auxid_set_t	auxid_set_t
	The aux ID set type definition. More...
template<class T , class ALLOC = std::allocator<T>>
using	AuxVariable_t = std::vector< T, ALLOC >
	Declare how to wrap variables for this sort of base. More...
template<class T , class ALLOC = std::allocator<T>>
using	LinkedVariable_t = AuxVariable_t< T, ALLOC >
enum	AuxStoreType { AST_ObjectStore = 0, AST_ContainerStore = 1 }
	Type of the auxiliary store. More...

Public Member Functions
	AuxContainerBase (bool allowDynamicVars=true)
	Default constructor. More...
	AuxContainerBase (std::pmr::memory_resource *memResource, bool allowDynamicVars=true)
	Passing in a memory resource. More...
	AuxContainerBase (const AuxContainerBase &parent)
	Copy constructor. More...
	AuxContainerBase (SG::IAuxStore *store, std::pmr::memory_resource *memResource=nullptr)
	Constructor receiving a "dynamic auxiliary store". More...
	~AuxContainerBase ()
	Destructor. More...
AuxContainerBase &	operator= (const AuxContainerBase &rhs)
	Assignment operator. More...
template<typename T , typename ALLOC >
auxid_t	getAuxID (const std::string &name, std::vector< T, ALLOC > &, SG::AuxVarFlags flags=SG::AuxVarFlags::None, const SG::auxid_t linkedVariable=SG::null_auxid)
	Get the auxiliary ID for one of the persistent variables. More...
template<typename T >
auxid_t	getAuxID (const std::string &name, SG::PackedContainer< T > &, SG::AuxVarFlags flags=SG::AuxVarFlags::None, const SG::auxid_t linkedVariable=SG::null_auxid)
	Get the auxiliary ID for one of the persistent variables. More...
template<typename T , typename ALLOC >
void	regAuxVar (auxid_t auxid, const std::string &name, std::vector< T, ALLOC > &vec)
	Register one of the persistent variables internally. More...
template<typename T >
void	regAuxVar (auxid_t auxid, const std::string &name, SG::PackedContainer< T > &vec)
	Register one of the persistent variables internally. More...
virtual const void *	getData (SG::auxid_t auxid) const=0
	Pick up the const version from the base class. More...
virtual bool	insertMove (size_t pos, IAuxStore &other, const SG::auxid_set_t &ignore=SG::auxid_set_t())=0
	Move all elements from other to this store. More...
virtual const IAuxTypeVector *	linkedVector (SG::auxid_t) const
	Return interface for a linked variable. More...

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

Private Types
typedef AthContainers_detail::mutex	mutex_t
	Mutex for multithread synchronization. More...
typedef AthContainers_detail::lock_guard< mutex_t >	guard_t

Private Member Functions
template<typename ELT , typename CONT >
void	regAuxVar1 (auxid_t auxid, const std::string &name, CONT &vec)
	Common code between regAuxVar cases. More...

Private Attributes
auxid_set_t	m_auxids
	Internal list of all available variables. More...
std::vector< SG::IAuxTypeVector * >	m_vecs
	Internal list of all managed variables. More...
SG::IAuxStore *	m_store
	Internal dynamic auxiliary store object. More...
SG::IAuxStoreIO *	m_storeIO
	The IO interface to the internal auxiliary store. More...
bool	m_ownsStore
	Flag deciding if the object owns the dynamic store or not. More...
bool	m_locked
	Has the container been locked? More...
mutex_t	m_mutex
std::string	m_name
	Name of the container in memory. Set externally. More...
CxxUtils::CachedPointer< std::pmr::memory_resource > m_memResource	ATLAS_THREAD_SAFE
	Memory resource to use for this container. More...

Friends
class	::xAODAuxContainerBaseCnv

Detailed Description

Common base class for the auxiliary containers.

To make the development of auxiliary containers simpler, they can all inherit from this one class. Then all they need to do is just to declare their data members, everything else is taken care of by this transient base class.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision

793737

Date

2017-01-24 21:11:10 +0100 (Tue, 24 Jan 2017)

Definition at line 53 of file AuxContainerBase.h.

Member Typedef Documentation

auxid_set_t

typedef SG::auxid_set_t xAOD::AuxContainerBase::auxid_set_t

The aux ID set type definition.

Definition at line 65 of file AuxContainerBase.h.

auxid_t

typedef SG::auxid_t xAOD::AuxContainerBase::auxid_t

The aux ID type definition.

Definition at line 63 of file AuxContainerBase.h.

AuxVariable_t

template<class T , class ALLOC = std::allocator<T>>

using xAOD::AuxContainerBase::AuxVariable_t = std::vector<T, ALLOC>

Declare how to wrap variables for this sort of base.

Definition at line 195 of file AuxContainerBase.h.

guard_t

typedef AthContainers_detail::lock_guard< mutex_t > xAOD::AuxContainerBase::guard_t

private

Definition at line 247 of file AuxContainerBase.h.

LinkedVariable_t

template<class T , class ALLOC = std::allocator<T>>

using xAOD::AuxContainerBase::LinkedVariable_t = AuxVariable_t<T, ALLOC>

Definition at line 197 of file AuxContainerBase.h.

mutex_t

typedef AthContainers_detail::mutex xAOD::AuxContainerBase::mutex_t

private

Mutex for multithread synchronization.

Definition at line 246 of file AuxContainerBase.h.

Member Enumeration Documentation

AuxStoreType

enum SG::IAuxStoreHolder::AuxStoreType

inherited

Type of the auxiliary store.

In the xAOD EDM we use auxiliary store objects in some cases to describe a single object, and in most cases to describe a container of objects. This enumeration declares which type the object implementing this interface is.

Enumerator
AST_ObjectStore	The store describes a single object.
AST_ContainerStore	The store describes a container.

Definition at line 66 of file IAuxStoreHolder.h.

                        {
         AST_ObjectStore    = 0, 
         AST_ContainerStore = 1  
      };

Constructor & Destructor Documentation

AuxContainerBase() [1/4]

xAOD::AuxContainerBase::AuxContainerBase

(

bool

allowDynamicVars = true

)

Default constructor.

Definition at line 31 of file AuxContainerBase.cxx.

      : AuxContainerBase( nullptr, allowDynamicVars ) {
   }

AuxContainerBase() [2/4]

xAOD::AuxContainerBase::AuxContainerBase	(	std::pmr::memory_resource *	memResource,
		bool	allowDynamicVars = true
	)

Passing in a memory resource.

Definition at line 35 of file AuxContainerBase.cxx.

      : SG::IAuxStore(),
        m_auxids(), m_vecs(), m_store( nullptr ), m_storeIO( nullptr ),
        m_ownsStore( true ),
        m_locked( false ),
        m_name( "UNKNOWN" ),
        m_memResource( memResource ){
 
      if( allowDynamicVars ) {
         m_store = new SG::AuxStoreInternal();
         m_storeIO = dynamic_cast< SG::IAuxStoreIO* >( m_store );
      }
   }

AuxContainerBase() [3/4]

xAOD::AuxContainerBase::AuxContainerBase

(

const AuxContainerBase &

parent

)

Copy constructor.

This is an interesting one.

The internal variables of AuxContainerBase are set up by the derived class(es) at construction. So, this internal state is not to be copied!

However, since the derived classes (the contents of their regular members) are allowed to be copied, let's not make this constructor private.

Definition at line 58 of file AuxContainerBase.cxx.

      : SG::IAuxStore(),
        m_auxids(), m_vecs(), m_store( nullptr ), m_storeIO( nullptr ),
        m_ownsStore( true ),
        m_locked( false ),
        m_memResource( parent.m_memResource )
   {
      // Keep the source unmutable during copy
      guard_t guard( parent.m_mutex );
      m_name = parent.m_name;
 
      // Unfortunately the dynamic variables can not be copied this easily...
      if( parent.m_store ) {
         m_ownsStore = false;
         // cppcheck-suppress copyCtorPointerCopying
         m_store = parent.m_store;
         m_storeIO = dynamic_cast< SG::IAuxStoreIO* >( m_store );
         m_auxids = m_store->getAuxIDs();
      }
   }

AuxContainerBase() [4/4]

xAOD::AuxContainerBase::AuxContainerBase	(	SG::IAuxStore *	store,
		std::pmr::memory_resource *	memResource = nullptr
	)

Constructor receiving a "dynamic auxiliary store".

This constructor is used to wrap another object that is stored in StoreGate, and hence we should not take ownership of.

Parameters

store

Another store that should be wrapped, but not owned

Definition at line 84 of file AuxContainerBase.cxx.

      : SG::IAuxStore(),
        m_auxids(), m_vecs(),
        m_store( store ),
        m_storeIO( nullptr ), m_ownsStore( false ),
        m_locked( false),
        m_name( "UNKNOWN" ),
        m_memResource( memResource ){
 
      m_storeIO = dynamic_cast< SG::IAuxStoreIO* >( m_store );
      if( m_store ) {
         m_auxids = m_store->getAuxIDs();
      }
   }

~AuxContainerBase()

xAOD::AuxContainerBase::~AuxContainerBase

(

)

Destructor.

Definition at line 100 of file AuxContainerBase.cxx.

                                       {
 
      std::vector< SG::IAuxTypeVector* >::iterator itr = m_vecs.begin();
      std::vector< SG::IAuxTypeVector* >::iterator end = m_vecs.end();
      for( ; itr != end; ++itr ) {
         if( ! *itr ) continue;
         delete *itr;
      }
 
      if( m_store && m_ownsStore ) delete m_store;
   }

Member Function Documentation

clearDecorations()

bool xAOD::AuxContainerBase::clearDecorations ( )

overridevirtual

Clear all decorations.

Implements SG::IConstAuxStore.

Definition at line 357 of file AuxContainerBase.cxx.

                                           {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // Clear the decorations from the dynamic store:
      bool anycleared = false;
      if( m_store ) {
         anycleared = m_store->clearDecorations();
      }
      // Early exit if there were no decorations.
      if (!anycleared) return false;
 
      // Construct the list of managed auxiliary variables from scratch after
      // the cleanup:
      auxid_set_t ids;
      for( auxid_t auxid = 0; auxid < m_vecs.size(); ++auxid ) {
         if( m_vecs[ auxid ] ) {
            ids.insert( auxid );
         }
      }
      if( m_store ) {
         ids.insert (m_store->getAuxIDs());
      }
      m_auxids = ids;
 
      return true;
   }

getAuxID() [1/2]

template<typename T >

auxid_t xAOD::AuxContainerBase::getAuxID	(	const std::string &	name,
		SG::PackedContainer< T > &	,
		SG::AuxVarFlags	flags = SG::AuxVarFlags::None,
		const SG::auxid_t	linkedVariable = SG::null_auxid
	)

Get the auxiliary ID for one of the persistent variables.

getAuxID() [2/2]

template<typename T , typename ALLOC >

auxid_t xAOD::AuxContainerBase::getAuxID	(	const std::string &	name,
		std::vector< T, ALLOC > &	,
		SG::AuxVarFlags	flags = SG::AuxVarFlags::None,
		const SG::auxid_t	linkedVariable = SG::null_auxid
	)

Get the auxiliary ID for one of the persistent variables.

getAuxIDs()

const AuxContainerBase::auxid_set_t & xAOD::AuxContainerBase::getAuxIDs ( ) const

overridevirtual

Get the types(names) of variables handled by this container.

Implements SG::IConstAuxStore.

Definition at line 275 of file AuxContainerBase.cxx.

                                     {
 
      // Return the full list of IDs:
      return getWritableAuxIDs();
   }

getData() [1/3]

const void * xAOD::AuxContainerBase::getData ( auxid_t  auxid ) const

overridevirtual

Get a pointer to a given array.

Implements SG::IConstAuxStore.

Definition at line 230 of file AuxContainerBase.cxx.

                                                              {
 
      const SG::IAuxTypeVector* v = getVector( auxid );
      if( v ) {
         return v->toPtr();
      }
      return nullptr;
   }

getData() [2/3]

void * xAOD::AuxContainerBase::getData ( auxid_t  auxid, size_t  size, size_t  capacity  )

overridevirtual

Get a pointer to a given array, creating the array if necessary.

Implements SG::IAuxStore.

Definition at line 462 of file AuxContainerBase.cxx.

                                                      {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      if( ( auxid >= m_vecs.size() ) || ( ! m_vecs[ auxid ] ) ) {
 
         if( m_store ) {
            void* result = m_store->getData( auxid, size, capacity );
            if( result ) {
               m_auxids.insert( auxid );
               const SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
               auxid_t linked_id = r.linkedVariable( auxid );
               if (linked_id != SG::null_auxid) {
                  m_auxids.insert( linked_id );
               }
            }
            return result;
         } else {
            std::cout << "ERROR xAOD::AuxContainerBase::getData "
                      << "Unknown variable ("
                      << SG::AuxTypeRegistry::instance().getName( auxid )
                      << ") requested" << std::endl;
            return nullptr;
         }
      }
      m_vecs[ auxid ]->reserve( capacity );
      if (m_vecs[ auxid ]->size() < size) {
         m_vecs[ auxid ]->resize( size );
      }
 
      return m_vecs[ auxid ]->toPtr();
   }

getData() [3/3]

virtual const void* SG::IConstAuxStore::getData

inherited

Pick up the const version from the base class.

getDecoration()

void * xAOD::AuxContainerBase::getDecoration ( auxid_t  auxid, size_t  size, size_t  capacity  )

overridevirtual

Get a pointer to a given array, as a decoration.

Implements SG::IConstAuxStore.

Reimplemented in xAOD::EventInfoAuxContainer_v1.

Definition at line 300 of file AuxContainerBase.cxx.

                                                            {
     {
       // Guard against multi-threaded execution:
       guard_t guard( m_mutex );
 
       // Check if we have it as a static variable:
       if( ( auxid >= m_vecs.size() ) || ( ! m_vecs[ auxid ] ) ) {
         // If not, but we have a dynamic store, push it in there:
         if( m_store ) {
           void* result = m_store->getDecoration( auxid, size, capacity );
           if( result ) {
              m_auxids.insert( auxid );
              const SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
              auxid_t linked_id = r.linkedVariable( auxid );
              if (linked_id != SG::null_auxid) {
                 m_auxids.insert( linked_id );
              }
           }
           return result;
         }
         // If we don't have a dynamic store, complain:
         else {
           std::cout << "ERROR xAOD::AuxContainerBase::getDecoration "
                     << "Can't provide variable "
                     << SG::AuxTypeRegistry::instance().getName( auxid )
                     << std::endl;
           return nullptr;
         }
       }
 
       // If the container is locked, static variables can't be accessed this
       // way:
       if( m_locked ) {
         throw SG::ExcStoreLocked( auxid );
       }
     }
 
     // If the container is not locked, then fall back on the normal accessor
     // function:
     return getData( auxid, size, capacity );
   }

getDecorIDs()

const AuxContainerBase::auxid_set_t & xAOD::AuxContainerBase::getDecorIDs ( ) const

overridevirtual

Get the types(names) of decorations handled by this container.

Implements SG::IConstAuxStore.

Definition at line 282 of file AuxContainerBase.cxx.

                                       {
 
      if( m_store ) {
         return m_store->getDecorIDs();
      }
      static const auxid_set_t empty;
      return empty;
   }

getDynamicAuxIDs()

const AuxContainerBase::auxid_set_t & xAOD::AuxContainerBase::getDynamicAuxIDs ( ) const

overridevirtual

Get the types(names) of variables created dynamically.

Implements SG::IAuxStoreIO.

Definition at line 701 of file AuxContainerBase.cxx.

                                            {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // All the variables handled by the internal store are dynamic
      // if such a store exists:
      if( m_storeIO ) {
         // I mean, all the variables. Not just the ones reported as dynamic
         // by the internal object. Because the internal object may be something
         // that was put into this one in order to achieve data slimming.
         return m_store->getAuxIDs();
      }
      // In case we don't use an internal store, there are no dynamic
      // variables:
      static const auxid_set_t dummy (0);
      return dummy;
   }

getIOData()

const void * xAOD::AuxContainerBase::getIOData ( auxid_t  auxid ) const

overridevirtual

Get a pointer to the data being stored for one aux data item.

Implements SG::IAuxStoreIO.

Definition at line 659 of file AuxContainerBase.cxx.

                                                                {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // If the variable is not static, look for it in the dynamic store:
      if( ( auxid >= m_vecs.size() ) || ( ! m_vecs[ auxid ] ) ) {
         if( m_storeIO ) {
            return m_storeIO->getIOData( auxid );
         } else {
            std::cout << "ERROR xAOD::AuxContainerBase::getIOData "
                      << "Unknown variable ("
                      << SG::AuxTypeRegistry::instance().getName( auxid )
                      << ") requested" << std::endl;
            return nullptr;
         }
      }
 
      // Update the statistics for this variable. The dynamic store registers
      // its own variable accesses.
      IOStats::instance().stats().readBranch( m_name, auxid );
 
      return m_vecs[ auxid ]->toVector();
   }

getIOType()

const std::type_info * xAOD::AuxContainerBase::getIOType ( auxid_t  auxid ) const

overridevirtual

Return the type of the data to be stored for one aux data item.

Implements SG::IAuxStoreIO.

Definition at line 684 of file AuxContainerBase.cxx.

                                                                        {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // If the variable is not static, ask the dynamic store:
      if( ( auxid >= m_vecs.size() ) || ( ! m_vecs[ auxid ] ) ) {
         if( m_storeIO ) {
            return m_storeIO->getIOType( auxid );
         }
      }
 
      // Fall back on getting the information from the registry:
      return SG::AuxTypeRegistry::instance().getVecType( auxid );
   }

getSelectedAuxIDs()

AuxContainerBase::auxid_set_t xAOD::AuxContainerBase::getSelectedAuxIDs ( ) const

overridevirtual

Get the IDs of the selected dynamic Aux variables (for writing)

Reimplemented from SG::IAuxStoreIO.

Definition at line 721 of file AuxContainerBase.cxx.

                                             {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // All the variables handled by the internal store are dynamic
      // if such a store exists:
      if( m_storeIO ) {
         // I mean, all the variables. Not just the ones reported as dynamic
         // by the internal object. Because the internal object may be something
         // that was put into this one in order to achieve data slimming.
         return m_store->getAuxIDs();
      }
 
      // In case we don't use an internal store, there are no dynamic
      // variables:
      return auxid_set_t();
   }

getStore() [1/2]

const SG::IAuxStore * xAOD::AuxContainerBase::getStore ( ) const

overridevirtual

Implements SG::IAuxStoreHolder.

Definition at line 181 of file AuxContainerBase.cxx.

   {
      return m_store;
   }

getStore() [2/2]

SG::IAuxStore * xAOD::AuxContainerBase::getStore ( )

overridevirtual

Get the currently used internal store object.

Implements SG::IAuxStoreHolder.

Definition at line 154 of file AuxContainerBase.cxx.

   {
      return m_store;
   }

getStoreType()

virtual AuxStoreType xAOD::AuxContainerBase::getStoreType ( ) const

inlineoverridevirtual

Return the type of the store object.

Implements SG::IAuxStoreHolder.

Definition at line 92 of file AuxContainerBase.h.

{ return AST_ContainerStore; }

getVector()

const SG::IAuxTypeVector * xAOD::AuxContainerBase::getVector ( SG::auxid_t  auxid ) const

finaloverridevirtual

Return vector interface for one aux data item.

Implements SG::IConstAuxStore.

Definition at line 239 of file AuxContainerBase.cxx.

                                                                            {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      if( ( auxid >= m_vecs.size() ) || ( ! m_vecs[ auxid ] ) ) {
         if( m_store ) {
            const SG::IAuxTypeVector* result = m_store->getVector( auxid );
            if( result ) {
              auxid_set_t& auxids_nc ATLAS_THREAD_SAFE =
                const_cast<auxid_set_t&> (m_auxids);
              auxids_nc.insert( auxid );
              const SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
              auxid_t linked_id = r.linkedVariable( auxid );
              if (linked_id != SG::null_auxid) {
                 auxids_nc.insert( linked_id );
              }
            }
            return result;
         } else {
            std::cout << "ERROR xAOD::AuxContainerBase::getData "
                      << "Unknown variable ("
                      << SG::AuxTypeRegistry::instance().getName( auxid )
                      << ") requested" << std::endl;
            return nullptr;
         }
      }
 
      // Update the statistics for this variable. The dynamic store registers
      // its own variable accesses.
      IOStats::instance().stats().readBranch( m_name, auxid );
 
      return m_vecs[ auxid ];
   }

getWritableAuxIDs()

const AuxContainerBase::auxid_set_t & xAOD::AuxContainerBase::getWritableAuxIDs ( ) const

overridevirtual

Return a set of writable data identifiers.

Implements SG::IAuxStore.

Definition at line 498 of file AuxContainerBase.cxx.

                                             {
 
      // Return the full list of known IDs. The constness of this object's
      // members comes from the object being const or not.
      return m_auxids;
   }

insertMove() [1/2]

bool xAOD::AuxContainerBase::insertMove ( size_t  pos, IAuxStore &  other, const SG::auxid_set_t &  ignore  )

overridevirtual

Insert contents of another store via move.

Definition at line 584 of file AuxContainerBase.cxx.

                                                                       {
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // This operation is not allowed on a locked container:
      if( m_locked ) {
         throw SG::ExcStoreLocked( "insertMove" );
      }
 
      bool nomove = true;
      size_t other_size = other.size();
 
      SG::auxid_set_t ignore = ignore_in;
      
      // Do the operation on the static variables:
      for (SG::auxid_t id : m_auxids) {
        SG::IAuxTypeVector* v_dst = nullptr;
        if (id < m_vecs.size())
          v_dst = m_vecs[id];
        // Skip linked vars --- they should be taken care of by the parent var.
        if (v_dst && !v_dst->isLinked()) {
          ignore.insert (id);
          if (other.getData (id)) {
            void* src_ptr = other.getData (id, other_size, other_size);
            if (src_ptr) {
              if (!v_dst->insertMove (pos, src_ptr, 0, other_size,
                                      other))
                nomove = false;
            }
          }
          else {
            const void* orig = v_dst->toPtr();
            v_dst->shift (pos, other_size);
            if (orig != v_dst->toPtr())
              nomove = false;
          }
        }
      }
 
      // Do the operation on the dynamic variables:
      if( m_store ) {
        if (!m_store->insertMove( pos, other, ignore ))
          nomove = false;
 
        // Notice any new variables added as a result of this.
        m_auxids.insert (m_store->getAuxIDs());
      }
 
      return nomove;
   }

insertMove() [2/2]

virtual bool SG::IAuxStore::insertMove ( size_t  pos, IAuxStore &  other, const SG::auxid_set_t &  ignore = SG::auxid_set_t()  )

pure virtualinherited

Move all elements from other to this store.

Parameters

pos	The starting index of the insertion.
other	Store from which to do the move.
ignore	Set of variables that should not be added to the store.

Let len be the size of other. The store will be increased in size by len elements, with the elements at pos being copied to pos+len. Then, for each auxiliary variable, the entire contents of that variable for other will be moved to this store at index pos. This will be done via move semantics if possible; otherwise, it will be done with a copy. Variables present in this store but not in other will have the corresponding elements default-initialized. Variables in other but not in this store will be added unless they are in ignore.

Returns true if it is known that none of the vectors' memory moved, false otherwise.

Implemented in SG::AuxStoreInternal.

isDecoration()

bool xAOD::AuxContainerBase::isDecoration ( auxid_t  auxid ) const

overridevirtual

Test if a variable is a decoration.

Implements SG::IConstAuxStore.

Reimplemented in xAOD::EventInfoAuxContainer_v1.

Definition at line 291 of file AuxContainerBase.cxx.

   {
     guard_t guard( m_mutex );
     if (m_store) {
       return m_store->isDecoration (auxid);
     }
     return false;
   }

linkedVector() [1/3]

const SG::IAuxTypeVector * xAOD::AuxContainerBase::linkedVector ( SG::auxid_t  auxid ) const

overridevirtual

Return interface for a linked variable.

Reimplemented from SG::IConstAuxStore.

Definition at line 396 of file AuxContainerBase.cxx.

   {
      const SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
      auxid_t linked_id = r.linkedVariable( auxid );
      if (linked_id != SG::null_auxid) {
         guard_t guard( m_mutex );
         if (linked_id < m_vecs.size() && m_vecs[ linked_id ]) {
            return m_vecs[ linked_id ];
         }
         if (m_store) {
            return CxxUtils::as_const_ptr(m_store)->linkedVector( auxid );
         }
      }
      return nullptr;
   }

linkedVector() [2/3]

SG::IAuxTypeVector * xAOD::AuxContainerBase::linkedVector ( SG::auxid_t  auxid )

overridevirtual

Return interface for a linked variable.

Reimplemented from SG::IAuxStore.

Definition at line 413 of file AuxContainerBase.cxx.

   {
      const SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
      auxid_t linked_id = r.linkedVariable( auxid );
      if (linked_id != SG::null_auxid) {
         guard_t guard( m_mutex );
         if (linked_id < m_vecs.size() && m_vecs[ linked_id ]) {
            return m_vecs[ linked_id ];
         }
         if (m_store) {
            return m_store->linkedVector( auxid );
         }
      }
      return nullptr;
   }

linkedVector() [3/3]

virtual const IAuxTypeVector* SG::IConstAuxStore::linkedVector

inlineinherited

Return interface for a linked variable.

Parameters

auxid

The ID of the parent variable.

If auxid has a linked variable, then return the IAuxTypeVector describing it. Otherwise, return nullptr. May return nullptr unconditionally if this store does not support linked variables.

Definition at line 189 of file IConstAuxStore.h.

  { return nullptr; }

lock()

void xAOD::AuxContainerBase::lock ( )

overridevirtual

Lock the container.

Implements ILockable.

Definition at line 343 of file AuxContainerBase.cxx.

                               {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // Lock the object and its dynamic store:
      m_locked = true;
      if( m_store ) {
         m_store->lock();
      }
 
      return;
   }

lockDecoration()

void xAOD::AuxContainerBase::lockDecoration ( SG::auxid_t  auxid )

overridevirtual

Lock a decoration.

Implements SG::IConstAuxStore.

Reimplemented in xAOD::EventInfoAuxContainer_v1.

Definition at line 387 of file AuxContainerBase.cxx.

   { 
     guard_t guard (m_mutex);
     if (m_store) {
       m_store->lockDecoration (auxid);
     }
   }

memResource()

std::pmr::memory_resource * xAOD::AuxContainerBase::memResource

(

)

Return the memory resource to use.

Definition at line 159 of file AuxContainerBase.cxx.

   {
      const std::pmr::memory_resource* cptr = m_memResource.get();
      std::pmr::memory_resource* ptr ATLAS_THREAD_SAFE  = const_cast<std::pmr::memory_resource*>( cptr );
      if( !ptr ) {
#ifndef XAOD_STANDALONE
         const EventContext& ctx = Gaudi::Hive::currentContext();
         if( Atlas::hasExtendedEventContext( ctx ) ) {
            ptr = Atlas::getExtendedEventContext( ctx ).memResource();
         }
         if( !ptr )
#endif
         {
            ptr = std::pmr::get_default_resource();
         }
         if( ptr ) {
           m_memResource.set( ptr );
         }
      }
      return ptr;
   }

name()

const char * xAOD::AuxContainerBase::name

(

)

const

Get the name of the container instance.

Definition at line 743 of file AuxContainerBase.cxx.

                                            {
 
      return m_name.c_str();
   }

operator=()

AuxContainerBase & xAOD::AuxContainerBase::operator=

(

const AuxContainerBase &

rhs

)

Assignment operator.

Just like the copy constructor, this operator doesn't actually copy anything either.

It's just here to make it clear to C++ that the internal state of these objects is not to be messed with.

Returns

A reference to this same object

Definition at line 119 of file AuxContainerBase.cxx.

                                                            {
 
      // Protect against self-assignment:
      if( this == &rhs ) return *this;
 
      // Keep the objects locked during copy
      std::scoped_lock  lck{m_mutex, rhs.m_mutex};
 
      // Clean up after the old dynamic store:
      if( m_store && m_ownsStore ) {
         m_auxids -= m_store->getAuxIDs();
         delete m_store;
      }
      m_store = nullptr;
      m_storeIO = nullptr;
      m_ownsStore = true;
 
      // Take posession of the new dynamic store:
      if( rhs.m_store ) {
         m_store = rhs.m_store;
         m_ownsStore = false;
         m_storeIO = dynamic_cast< SG::IAuxStoreIO* >( m_store );
         m_auxids.insert (m_store->getAuxIDs());
      }
 
      m_name = rhs.m_name;
 
      return *this;
   }

regAuxVar() [1/2]

template<typename T >

void xAOD::AuxContainerBase::regAuxVar	(	auxid_t	auxid,
		const std::string &	name,
		SG::PackedContainer< T > &	vec
	)

Register one of the persistent variables internally.

regAuxVar() [2/2]

template<typename T , typename ALLOC >

void xAOD::AuxContainerBase::regAuxVar	(	auxid_t	auxid,
		const std::string &	name,
		std::vector< T, ALLOC > &	vec
	)

Register one of the persistent variables internally.

regAuxVar1()

template<typename ELT , typename CONT >

void xAOD::AuxContainerBase::regAuxVar1 ( auxid_t  auxid, const std::string &  name, CONT &  vec  )

private

Common code between regAuxVar cases.

reserve()

void xAOD::AuxContainerBase::reserve ( size_t  size )

overridevirtual

Reserve a given size for the arrays.

Implements SG::IAuxStore.

Definition at line 533 of file AuxContainerBase.cxx.

                                               {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // This operation is not allowed on a locked container:
      if( m_locked ) {
         throw SG::ExcStoreLocked( "reserve" );
      }
 
      // Do the operation on the static variables:
      for (SG::IAuxTypeVector* v : m_vecs) {
         if(v && !v->isLinked()) {
            v->reserve( size );
         }
      }
 
      // Do the operation on the dynamic variables:
      if( m_store ) {
         m_store->reserve( size );
      }
 
      return;
   }

resize()

bool xAOD::AuxContainerBase::resize ( size_t  size )

overridevirtual

Resize the arrays to a given size.

Implements SG::IAuxStore.

Definition at line 505 of file AuxContainerBase.cxx.

                                              {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // This operation is not allowed on a locked container:
      if( m_locked ) {
         throw SG::ExcStoreLocked( "resize" );
      }
 
      // Do the operation on the static variables:
      bool nomoves = true;
      for (SG::IAuxTypeVector* v : m_vecs) {
         if(v && !v->isLinked()) {
           if (!v->resize( size ))
             nomoves = false;
         }
      }
 
      // Do the operation on the dynamic variables:
      if( m_store ) {
        if (!m_store->resize( size ))
          nomoves = false;
      }
 
      return nomoves;
   }

setName()

void xAOD::AuxContainerBase::setName

(

const char *

name

)

Set the name of the container instance.

Definition at line 748 of file AuxContainerBase.cxx.

                                                    {
 
      m_name = name;
      return;
   }

setOption()

bool xAOD::AuxContainerBase::setOption ( auxid_t  id, const SG::AuxDataOption &  option  )

overridevirtual

Make an option setting on an aux variable.

Reimplemented from SG::IAuxStore.

Definition at line 638 of file AuxContainerBase.cxx.

                                                                     {
 
      guard_t guard (m_mutex);
      if (id < m_vecs.size() && m_vecs[id] != nullptr)
         return m_vecs[id]->setOption (option);
 
      if (m_store)
         return m_store->setOption (id, option);
      return false;
   }

setStore()

void xAOD::AuxContainerBase::setStore ( SG::IAuxStore *  store )

overridevirtual

Set a different internal store object.

This function is used by the I/O infrastructure to possibly put a store object into this one, which can interact with dynamic variables directly.

Note that the object takes ownership of the received store.

Parameters

store

The store that should be used for dynamic variable handling inside the object from now on

Implements SG::IAuxStoreHolder.

Definition at line 195 of file AuxContainerBase.cxx.

                                                       {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // Check that no funny business is going on:
      if( m_store == store ) return;
 
      // Clean up the current store object:
      if( m_store && m_ownsStore ) {
         m_auxids -= m_store->getAuxIDs();
         delete m_store;
      }
      m_store = nullptr;
      m_storeIO = nullptr;
 
      // Take posession of the new object:
      m_store = store;
      m_storeIO = dynamic_cast< SG::IAuxStoreIO* >( m_store );
      m_ownsStore = true;
      if( m_store ) {
         m_auxids.insert (m_store->getAuxIDs());
      }
 
      return;
   }

shift()

void xAOD::AuxContainerBase::shift ( size_t  pos, ptrdiff_t  offs  )

overridevirtual

Shift the contents of the stored arrays.

Implements SG::IAuxStore.

Definition at line 558 of file AuxContainerBase.cxx.

                                                            {
 
      // Guard against multi-threaded execution:
      guard_t guard( m_mutex );
 
      // This operation is not allowed on a locked container:
      if( m_locked ) {
         throw SG::ExcStoreLocked( "shift" );
      }
 
      // Do the operation on the static variables:
      for (SG::IAuxTypeVector* v : m_vecs) {
         if(v && !v->isLinked()) {
            v->shift( pos, offs );
         }
      }
 
      // Do the operation on the dynamic variables:
      if( m_store ) {
         m_store->shift( pos, offs );
      }
 
      return;
   }

size()

size_t xAOD::AuxContainerBase::size ( ) const

overridevirtual

Get the size of the container.

Implements SG::IConstAuxStore.

Definition at line 430 of file AuxContainerBase.cxx.

                                       {
 
      // Guard against multi-threaded execution:
      guard_t guard (m_mutex);
 
      // Try to find a variable:
      for (SG::auxid_t i : m_auxids) {
         if( ( i < m_vecs.size() ) && m_vecs[ i ] && !m_vecs[ i ]->isLinked()) {
            size_t sz = m_vecs[ i ]->size();
            if( sz > 0 ) {
               return sz;
            }
         }
      }
 
      // If we didn't find any, let's ask the dynamic store:
      if( m_store ) {
         return m_store->size();
      }
 
      // If we don't have any variables, then the size must be null:
      return 0;
   }

Friends And Related Function Documentation

::xAODAuxContainerBaseCnv

friend class ::xAODAuxContainerBaseCnv

friend

Definition at line 224 of file AuxContainerBase.h.

Member Data Documentation

ATLAS_THREAD_SAFE

CxxUtils::CachedPointer<std::pmr::memory_resource> m_memResource xAOD::AuxContainerBase::ATLAS_THREAD_SAFE

mutableprivate

Memory resource to use for this container.

Definition at line 254 of file AuxContainerBase.h.

m_auxids

auxid_set_t xAOD::AuxContainerBase::m_auxids

private

Internal list of all available variables.

Definition at line 232 of file AuxContainerBase.h.

m_locked

bool xAOD::AuxContainerBase::m_locked

private

Has the container been locked?

Definition at line 243 of file AuxContainerBase.h.

m_mutex

mutex_t xAOD::AuxContainerBase::m_mutex

mutableprivate

Definition at line 248 of file AuxContainerBase.h.

m_name

std::string xAOD::AuxContainerBase::m_name

private

Name of the container in memory. Set externally.

Definition at line 251 of file AuxContainerBase.h.

m_ownsStore

bool xAOD::AuxContainerBase::m_ownsStore

private

Flag deciding if the object owns the dynamic store or not.

Definition at line 241 of file AuxContainerBase.h.

m_store

SG::IAuxStore* xAOD::AuxContainerBase::m_store

private

Internal dynamic auxiliary store object.

Definition at line 237 of file AuxContainerBase.h.

m_storeIO

SG::IAuxStoreIO* xAOD::AuxContainerBase::m_storeIO

private

The IO interface to the internal auxiliary store.

Definition at line 239 of file AuxContainerBase.h.

m_vecs

std::vector< SG::IAuxTypeVector* > xAOD::AuxContainerBase::m_vecs

private

Internal list of all managed variables.

Definition at line 234 of file AuxContainerBase.h.

supportsThinning

constexpr bool SG::IAuxStore::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 199 of file IAuxStore.h.

---

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

• AuxContainerBase.h
• AuxContainerBase.cxx