Athena::ThinningCacheTool Class Reference

Create ThinningCache for a given stream. More...

#include <ThinningCacheTool.h>

Inheritance diagram for Athena::ThinningCacheTool:

Collaboration diagram for Athena::ThinningCacheTool:

Public Member Functions
virtual StatusCode	initialize () override
	Gaudi initialize method. More...
virtual StatusCode	postInitialize () override
	Called at the end of initialize. More...
virtual StatusCode	preExecute () override
	Called at the beginning of execute. More...
virtual StatusCode	preStream () override
	Called before actually streaming objects. More...
virtual StatusCode	postExecute () override
	Called at the end of execute. More...
virtual StatusCode	preFinalize () override
	Called at the beginning of finalize. More...

Private Member Functions
std::string	wantedKey (const std::string &key) const
	Test if a thinning decision object is for our stream. More...

Private Attributes
StringProperty	m_streamName { this, "StreamName", "", "Name of the stream being written." }
	Name of the stream for this tool. More...
ServiceHandle< ITrigNavigationThinningSvc >	m_trigNavigationThinningSvc { this, "TrigNavigationThinningSvc", "", "Service to use for TrigNavigation thinning (optional)." }
	Optional TrigNavigation thinning service to use. More...
SG::ThinningCache	m_cache
	Thinning cache instance for this stream. More...

Detailed Description

Create ThinningCache for a given stream.

Hooks in this class are called before and after output is written for a given stream. The preExecute hook will query the event store for any thinning to be done for the stream, build a ThinningCache object for all of these, and install it in the current EventContext. The postExecute hook will then clear the cache from the EventContext.

Definition at line 36 of file ThinningCacheTool.h.

Member Function Documentation

initialize()

StatusCode Athena::ThinningCacheTool::initialize ( )

overridevirtual

Gaudi initialize method.

Definition at line 27 of file ThinningCacheTool.cxx.

{
  if (!m_trigNavigationThinningSvc.empty()) {
    ATH_CHECK( m_trigNavigationThinningSvc.retrieve() );
  }
  return StatusCode::SUCCESS;
}

postExecute()

StatusCode Athena::ThinningCacheTool::postExecute ( )

overridevirtual

Called at the end of execute.

Remove ThinningCache from the EventContext and clear the cache instance.

Definition at line 140 of file ThinningCacheTool.cxx.

{
  if (!m_cache.empty() || m_cache.trigNavigationThinningSvc()) {
    EventContext ctx = Gaudi::Hive::currentContext();
    Atlas::getExtendedEventContext (ctx).setThinningCache (nullptr);
    Gaudi::Hive::setCurrentContext (ctx);
  }
 
  m_cache.clear();
  return StatusCode::SUCCESS;
}

postInitialize()

StatusCode Athena::ThinningCacheTool::postInitialize ( )

overridevirtual

Called at the end of initialize.

A no-op here.

Definition at line 39 of file ThinningCacheTool.cxx.

{
  return StatusCode::SUCCESS;
}

preExecute()

StatusCode Athena::ThinningCacheTool::preExecute ( )

overridevirtual

Called at the beginning of execute.

A no-op for now.

Definition at line 48 of file ThinningCacheTool.cxx.

{
  return StatusCode::SUCCESS;
}

preFinalize()

StatusCode Athena::ThinningCacheTool::preFinalize ( )

overridevirtual

Called at the beginning of finalize.

A no-op here.

Definition at line 156 of file ThinningCacheTool.cxx.

{
  return StatusCode::SUCCESS;
}

preStream()

StatusCode Athena::ThinningCacheTool::preStream ( )

overridevirtual

Called before actually streaming objects.

Find all thinning requests for this stream, build the ThinningCache, and install it in the current EventContext.

Definition at line 59 of file ThinningCacheTool.cxx.

{
  m_cache.clear();
 
  // Nothing to do if we don't have an extended event context.
  EventContext ctx = Gaudi::Hive::currentContext();
  if (!Atlas::hasExtendedEventContext (ctx)) {
    return StatusCode::SUCCESS;
  }
 
  // Examine all ThinningDecision objects in the store.
  SG::ConstIterator<SG::ThinningDecision> beg;
  SG::ConstIterator<SG::ThinningDecision> end;
  // Will return FAILURE if no matches, so ignore.
  evtStore()->retrieve<SG::ThinningDecision>(beg, end).ignore();
  for (; beg != end; ++beg)
  {
    // See if this is for this stream.
    std::string key = wantedKey (beg.key());
    if (!key.empty()) {
 
      // Get the set of hashed SG keys for this object.
      std::vector<SG::sgkey_t> sgkeys;
      SG::DataProxy* proxy = beg->link().proxy (true);
      if (proxy) {
        sgkeys.push_back (proxy->sgkey());
        CLID pCLID = proxy->clID();
        IProxyDict* store = proxy->store();
        for (CLID clid : proxy->transientID()) {
          if (clid != pCLID) {
            sgkeys.push_back (store->stringToKey (key, clid));
          }
        }
      }
 
      // Add it to the cache.
      m_cache.addThinning (key, sgkeys, &*beg);
    }
  }
 
  // Look for any selection vetoes.
  const std::string selVetoesKey = "SelectionVetoes_" + m_streamName;
  const SG::SelectionVetoes* vetoes = nullptr;
  if (evtStore()->contains<SG::SelectionVetoes> (selVetoesKey)) {
    ATH_CHECK( evtStore()->retrieve (vetoes, selVetoesKey) );
    for (const auto& p : *vetoes) {
      m_cache.setVetoed (p.first, p.second);
    }
  }
 
  // Look for any compression info
  const std::string compInfoKey = "CompressionInfo_" + m_streamName;
  const SG::CompressionInfo* compInfo = nullptr;
  if (evtStore()->contains<SG::CompressionInfo> (compInfoKey)) {
    ATH_CHECK( evtStore()->retrieve (compInfo, compInfoKey) );
    for (const auto& p : *compInfo) {
      m_cache.setCompression (p.first, p.second);
    }
  }
 
  // Set the TrigNavigation thinning tool if needed.
  if (!m_trigNavigationThinningSvc.empty()) {
    m_cache.setTrigNavigationThinningSvc (m_trigNavigationThinningSvc.get());
  }
 
  // If there was any thinning for this stream, then install the cache
  // in the EventContext.
  if (!m_cache.empty() || m_cache.trigNavigationThinningSvc()) {
    m_cache.lockOwned();
    Atlas::getExtendedEventContext (ctx).setThinningCache (&m_cache);
    Gaudi::Hive::setCurrentContext (ctx);
  }
 
  return StatusCode::SUCCESS;
}

wantedKey()

std::string Athena::ThinningCacheTool::wantedKey ( const std::string &  key ) const

private

Test if a thinning decision object is for our stream.

Parameters

key	The SG key of the ThinningDecision object.

If this thinning decision is for our stream, then return the SG key of the object being thinned. Otherwise, return an empty string.

Definition at line 169 of file ThinningCacheTool.cxx.

{
  std::string suffix = "_THINNED_" + m_streamName;
  std::string::size_type spos = key.find (suffix);
  if (spos != std::string::npos &&
      (spos + suffix.size() == key.size() ||
       key[spos + suffix.size()] == '.'))
  {
    return key.substr (0, spos);
  }
  return "";
}

Member Data Documentation

m_cache

SG::ThinningCache Athena::ThinningCacheTool::m_cache

private

Thinning cache instance for this stream.

Definition at line 103 of file ThinningCacheTool.h.

m_streamName

StringProperty Athena::ThinningCacheTool::m_streamName { this, "StreamName", "", "Name of the stream being written." }

private

Name of the stream for this tool.

Definition at line 93 of file ThinningCacheTool.h.

m_trigNavigationThinningSvc

ServiceHandle<ITrigNavigationThinningSvc> Athena::ThinningCacheTool::m_trigNavigationThinningSvc { this, "TrigNavigationThinningSvc", "", "Service to use for TrigNavigation thinning (optional)." }

private

Optional TrigNavigation thinning service to use.

Definition at line 98 of file ThinningCacheTool.h.

---

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

• ThinningCacheTool.h
• ThinningCacheTool.cxx