TBranchAuxDynStore Class Reference

#include <TBranchAuxDynStore.h>

Inheritance diagram for TBranchAuxDynStore:

Collaboration diagram for TBranchAuxDynStore:

Public Member Functions
	TBranchAuxDynStore (TBranchAuxDynReader &reader, long long entry, bool standalone, std::recursive_mutex *iomtx=nullptr)
virtual	~TBranchAuxDynStore ()
virtual const void *	getData (SG::auxid_t auxid) const override
	implementation of the IAuxStore interface
virtual void *	getData (SG::auxid_t auxid, size_t size, size_t capacity) override
virtual const SG::IAuxTypeVector *	getVector (SG::auxid_t auxid) const override
virtual const void *	getIOData (SG::auxid_t auxid) const override
	implementation of the IAuxStoreIO interface
virtual void *	getDecoration (SG::auxid_t auxid, size_t size, size_t capacity) override
	Return the data vector for one aux data decoration item.
virtual bool	isDecoration (SG::auxid_t auxid) const override
	Test if a particular variable is tagged as a decoration.
virtual size_t	size () const override
	Return the number of elements in the store.

Protected Types
typedef AthContainers_detail::mutex	mutex_t
	Mutex used to synchronize modifications to the cache vector.
typedef AthContainers_detail::lock_guard< mutex_t >	guard_t

Protected Member Functions
virtual bool	readData (SG::auxid_t auxid) override final
	read data from ROOT and store it in m_vecs. Returns False on error

Protected Attributes
TBranchAuxDynReader &	m_reader
long long	m_entry
mutex_t	m_mutex
std::recursive_mutex *	m_iomutex
	Optional mutex used to serialize I/O with RootStorageSvc (not owned).

Detailed Description

Definition at line 20 of file TBranchAuxDynStore.h.

Member Typedef Documentation

guard_t

typedef AthContainers_detail::lock_guard<mutex_t> RootAuxDynStore::guard_t

protectedinherited

Definition at line 67 of file RootAuxDynStore.h.

mutex_t

typedef AthContainers_detail::mutex RootAuxDynStore::mutex_t

protectedinherited

Mutex used to synchronize modifications to the cache vector.

Definition at line 66 of file RootAuxDynStore.h.

Constructor & Destructor Documentation

TBranchAuxDynStore()

TBranchAuxDynStore::TBranchAuxDynStore	(	TBranchAuxDynReader &	reader,
		long long	entry,
		bool	standalone,
		std::recursive_mutex *	iomtx = nullptr )

Definition at line 17 of file TBranchAuxDynStore.cxx.

   : RootAuxDynStore( reader, entry, standalone, iomtx ),
     m_reader(reader)
{
}

~TBranchAuxDynStore()

virtual TBranchAuxDynStore::~TBranchAuxDynStore ( )

inlinevirtual

Definition at line 26 of file TBranchAuxDynStore.h.

{}

Member Function Documentation

getData() [1/2]

const void * RootAuxDynStore::getData ( SG::auxid_t auxid ) const

overridevirtualinherited

implementation of the IAuxStore interface

Definition at line 25 of file RootAuxDynStore.cxx.

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

getData() [2/2]

void * RootAuxDynStore::getData ( SG::auxid_t auxid, size_t size, size_t capacity )

overridevirtualinherited

Definition at line 50 of file RootAuxDynStore.cxx.

{
  // MN: how do we add new attributes to this store?  A:for now we don't
  throw("Non-const access to RootAuxDynStore is not supported");
}

getDecoration()

void * RootAuxDynStore::getDecoration ( SG::auxid_t auxid, size_t size, size_t capacity )

overridevirtualinherited

Return the data vector for one aux data decoration item.

Parameters

auxid	The identifier of the desired aux data item.
size	The current size of the container (in case the data item does not already exist).
capacity	The current capacity of the container (in case the data item does not already exist).
auxid	The identifier of the desired aux data item.
size	The current size of the container (in case the data item does not already exist).
capacity	The current capacity of the container (in case the data item does not already exist).

Each aux data item is stored as a vector, with one entry per entry in the owning container. This returns a pointer to the start of the vector.

The base class implementation works except for the case where we have not yet created a vector for an item in the root file. We need to detect that case and raise an exception.

Definition at line 87 of file RootAuxDynStore.cxx.

{
  guard_t guard (m_mutex);
  if (SG::AuxStoreInternal::getIODataInternal (auxid, true) == 0 &&
      SG::AuxStoreInternal::getAuxIDs().count (auxid) > 0)
  {
    throw SG::ExcStoreLocked (auxid);
  }
  return SG::AuxStoreInternal::getDecoration (auxid, size, capacity);
}

getIOData()

const void * RootAuxDynStore::getIOData ( SG::auxid_t auxid ) const

overridevirtualinherited

implementation of the IAuxStoreIO interface

Definition at line 57 of file RootAuxDynStore.cxx.

{
  guard_t guard (m_mutex);
  const void* ret = SG::AuxStoreInternal::getIODataInternal (auxid, true);
  if (!ret) {
    auto this_nc ATLAS_THREAD_SAFE = const_cast<RootAuxDynStore*>(this); // locked above
    if( this_nc->readData(auxid) ) {
       ret = SG::AuxStoreInternal::getIOData (auxid);
    }
  }
  return ret;
}

getVector()

const SG::IAuxTypeVector * RootAuxDynStore::getVector ( SG::auxid_t auxid ) const

overridevirtualinherited

Definition at line 35 of file RootAuxDynStore.cxx.

{
  guard_t guard (m_mutex);
  // lock
  const SG::IAuxTypeVector* ret = SG::AuxStoreInternal::getVector (auxid);
  if (!ret) {
    auto this_nc ATLAS_THREAD_SAFE = const_cast<RootAuxDynStore*>(this); // locked above
    if( this_nc->readData(auxid) ) {
       ret = SG::AuxStoreInternal::getVector (auxid);
    }
  }
  return ret;
}

isDecoration()

bool RootAuxDynStore::isDecoration ( SG::auxid_t auxid ) const

overridevirtualinherited

Test if a particular variable is tagged as a decoration.

Parameters

auxid	The identifier of the desired aux data item.
auxid	The identifier of the desired aux data item.

See getDecoration() above.

Definition at line 105 of file RootAuxDynStore.cxx.

{
  guard_t guard( m_mutex );
  if (SG::AuxStoreInternal::getIODataInternal (auxid, true) == 0 &&
      SG::AuxStoreInternal::getAuxIDs().count (auxid) > 0)
  {
    return false;
  }
  return SG::AuxStoreInternal::isDecoration (auxid);
}

readData()

bool TBranchAuxDynStore::readData ( SG::auxid_t auxid )

finaloverrideprotectedvirtual

read data from ROOT and store it in m_vecs. Returns False on error

Implements RootAuxDynStore.

Definition at line 25 of file TBranchAuxDynStore.cxx.

{
   try {
      auto& brInfo = m_reader.getBranchInfo(auxid, *this);
      if( !brInfo.branch ) return false; 
 
      // Make a 1-element vector.
      SG::AuxStoreInternal::getDataInternal(auxid, 1, 1, true);
      if( brInfo.isPackedContainer ) {
         setOption (auxid, SG::AuxDataOption ("nbits", 32));
      }
 
      // get memory location where to write data from the branch entry
      // const_cast because TTree::SetBranchAddress requires void*
      void *       vector ATLAS_THREAD_SAFE = const_cast<void*>(SG::AuxStoreInternal::getIOData (auxid));
      void *       data = &vector;
      if( standalone() && !brInfo.tclass ) {
         // reading fundamental type - ROOT expects a direct pointer
         data = vector;
      }
   
      // if have mutex, lock to prevent potential concurrent I/O from elsewhere
      auto io_lock = m_iomutex? std::unique_lock<std::recursive_mutex>(*m_iomutex)
         : std::unique_lock<std::recursive_mutex>();
      // read branch
      brInfo.setAddress(data);
      int  nbytes = brInfo.branch->GetEntry(m_entry);
      if( nbytes <= 0 )
         throw std::string("Error reading branch ") + brInfo.branch->GetName();
      // read OK
      m_reader.addBytes(nbytes);
      TTree::TClusterIterator clusterIterator = brInfo.branch->GetTree()->GetClusterIterator(m_entry);
      clusterIterator.Next();
      if (m_entry == clusterIterator.GetStartEntry() && brInfo.branch->GetTree()->GetMaxVirtualSize() != 0) {
         for (int i = brInfo.branch->GetReadBasket(); i < brInfo.branch->GetMaxBaskets()
             && brInfo.branch->GetBasketEntry()[i] < clusterIterator.GetNextEntry(); i++) {
            brInfo.branch->GetBasket(i);
         }
      }
   }
   catch(const std::string& e_str) {
      ATHCONTAINERS_ERROR("TBranchAuxDynStore::getData", e_str);
      return false;
   }
 
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
   SG::auxid_t linked_auxid = r.linkedVariable (auxid);
   if (linked_auxid != SG::null_auxid) {
     return readData (linked_auxid);
   }
   return true;
}

size()

size_t RootAuxDynStore::size ( ) const

overridevirtualinherited

Return the number of elements in the store.

May return 0 for a store with no aux data.

NOTE: this method will attempt to read data if size unknown (0) May return 0 for a store with no aux data.

Definition at line 121 of file RootAuxDynStore.cxx.

{
  const std::size_t s = SG::AuxStoreInternal::size();
  if( s != 0 ) {
    return s;
  }
 
  for( SG::auxid_t id : getAuxIDs() ) {
    if( getData( id ) != nullptr ) {
      return SG::AuxStoreInternal::size();
    }
  }
 
  return 0;
}

Member Data Documentation

m_entry

long long RootAuxDynStore::m_entry

protectedinherited

Definition at line 63 of file RootAuxDynStore.h.

m_iomutex

std::recursive_mutex* RootAuxDynStore::m_iomutex

protectedinherited

Optional mutex used to serialize I/O with RootStorageSvc (not owned).

Definition at line 71 of file RootAuxDynStore.h.

m_mutex

mutex_t RootAuxDynStore::m_mutex

mutableprotectedinherited

Definition at line 68 of file RootAuxDynStore.h.

m_reader

TBranchAuxDynReader& TBranchAuxDynStore::m_reader

protected

Definition at line 32 of file TBranchAuxDynStore.h.

---

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

• TBranchAuxDynStore.h
• TBranchAuxDynStore.cxx