HitCollectionMap Class Reference

Small wrapper around hit collection map to facilitate accessing the hit collection. More...

#include <HitCollectionMap.h>

Collaboration diagram for HitCollectionMap:

Public Types
using	Storage = std::unordered_map< std::string, std::unique_ptr< HitsVectorBase > >
using	StorageIterator = typename Storage::iterator

Public Member Functions
std::pair< StorageIterator, bool >	Insert (std::string const &hitCollectionName, std::unique_ptr< HitsVectorBase > hitCollection)
	Insert the hit collection for a given SDs. More...
template<class HitCollectionT , class... CollectionArgs>
std::pair< StorageIterator, bool >	Emplace (std::string const &hitCollectionName, CollectionArgs &&... args)
	Insert a container in the map with in-place construction. More...
template<class T >
T *	Find (std::string const &hitCollectionName)
	Get the hit collection for a given SDs. More...
template<class T >
std::unique_ptr< T >	Extract (std::string const &hitCollectionName)
	Extract the hit collection for a given SDs downcasted to the template parameter. More...
template<class T >
void	Record (std::string const &sgKey, std::string const &hitCollectionName, EventContext const &ctx)
	Record the hit collection hitCollectionName to the StoreGate sgKey. More...
template<class T >
void	Record (std::string const &hitCollectionName)
	Overload for Record with the same name for the SG key and hit collection name. More...
template<class T >
void	TransformAndRecord (std::string const &sgKey, std::string const &hitCollectionName, EventContext const &ctx, std::function< void(T &)> transform)
	Record the hit collection hitCollectionName to the StoreGate sgKey, applying a transformation function to the hit collection before recording it. More...
template<class T >
void	TransformAndRecord (std::string const &hitCollectionName, std::function< void(T &)> transform)
	Overload for TransformAndRecord with the same name for the SG key and hit collection name. More...

Private Attributes
Storage	m_outputCollections

Detailed Description

Small wrapper around hit collection map to facilitate accessing the hit collection.

Definition at line 20 of file HitCollectionMap.h.

Member Typedef Documentation

Storage

using HitCollectionMap::Storage = std::unordered_map<std::string, std::unique_ptr<HitsVectorBase> >

Definition at line 23 of file HitCollectionMap.h.

StorageIterator

using HitCollectionMap::StorageIterator = typename Storage::iterator

Definition at line 24 of file HitCollectionMap.h.

Member Function Documentation

Emplace()

template<class HitCollectionT , class... CollectionArgs>

std::pair<StorageIterator, bool> HitCollectionMap::Emplace ( std::string const &  hitCollectionName, CollectionArgs &&...  args  )

inline

Insert a container in the map with in-place construction.

Definition at line 38 of file HitCollectionMap.h.

                                                                                                       {
    static_assert(
        std::is_base_of_v<HitsVectorBase, HitCollectionT>,
        "HitCollectionT must be derived from HitsVectorBase");
        return m_outputCollections.emplace(
            hitCollectionName, std::make_unique<HitCollectionT>(std::forward<CollectionArgs>(args)...));
  }

Extract()

template<class T >

std::unique_ptr<T> HitCollectionMap::Extract ( std::string const &  hitCollectionName )

inline

Extract the hit collection for a given SDs downcasted to the template parameter.

Definition at line 66 of file HitCollectionMap.h.

                                                               {
    static_assert(
        std::is_base_of_v<HitsVectorBase, T>,
        "T must be derived from HitsVectorBase");
    if (auto handle = m_outputCollections.extract(hitCollectionName)) {
      // we can static cast, the caller must know the type of the hit collection
      // for a given key
      return std::unique_ptr<T>(static_cast<T*>(handle.mapped().release()));
    }
    return nullptr;
  }

Find()

template<class T >

T* HitCollectionMap::Find ( std::string const &  hitCollectionName )

inline

Get the hit collection for a given SDs.

Definition at line 50 of file HitCollectionMap.h.

                                              {
    static_assert(
        std::is_base_of_v<HitsVectorBase, T>,
        "T must be derived from HitsVectorBase");
    auto it = m_outputCollections.find(hitCollectionName);
    if (it != m_outputCollections.end()) {
      return static_cast<T*>(it->second.get());
    }
    return nullptr;
  }

Insert()

std::pair<StorageIterator, bool> HitCollectionMap::Insert ( std::string const &  hitCollectionName, std::unique_ptr< HitsVectorBase >  hitCollection  )

inline

Insert the hit collection for a given SDs.

Definition at line 29 of file HitCollectionMap.h.

                                                                                                                         {
    // Store the hit collection in a map, using the hitCollectionName as key.
    return m_outputCollections.insert({hitCollectionName, std::move(hitCollection)});
  }

Record() [1/2]

template<class T >

void HitCollectionMap::Record ( std::string const &  hitCollectionName )

inline

Overload for Record with the same name for the SG key and hit collection name.

Definition at line 91 of file HitCollectionMap.h.

                                                  {
    Record<T>(hitCollectionName, hitCollectionName, Gaudi::Hive::currentContext());
  }

Record() [2/2]

template<class T >

void HitCollectionMap::Record ( std::string const &  sgKey, std::string const &  hitCollectionName, EventContext const &  ctx  )

inline

Record the hit collection hitCollectionName to the StoreGate sgKey.

Definition at line 82 of file HitCollectionMap.h.

                                                                                                   {
    SG::WriteHandle<T> handle(sgKey, ctx);
    handle = Extract<T>(hitCollectionName);
  }

TransformAndRecord() [1/2]

template<class T >

void HitCollectionMap::TransformAndRecord ( std::string const &  hitCollectionName, std::function< void(T &)>  transform  )

inline

Overload for TransformAndRecord with the same name for the SG key and hit collection name.

Definition at line 115 of file HitCollectionMap.h.

                                                                                               {
    TransformAndRecord(hitCollectionName, hitCollectionName, Gaudi::Hive::currentContext(), transform);
  }

TransformAndRecord() [2/2]

template<class T >

void HitCollectionMap::TransformAndRecord ( std::string const &  sgKey, std::string const &  hitCollectionName, EventContext const &  ctx, std::function< void(T &)>  transform  )

inline

Record the hit collection hitCollectionName to the StoreGate sgKey, applying a transformation function to the hit collection before recording it.

Definition at line 100 of file HitCollectionMap.h.

                                       {
    auto hitColl = Extract<T>(hitCollectionName);
    transform(*hitColl);
    SG::WriteHandle<T> handle(sgKey, ctx);
    handle = std::move(hitColl);
  }

Member Data Documentation

m_outputCollections

Storage HitCollectionMap::m_outputCollections

private

Definition at line 121 of file HitCollectionMap.h.

---

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

• HitCollectionMap.h