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.
template<AthHitVec::isHitVectorBase HitCollectionT, class... CollectionArgs>
std::pair< StorageIterator, bool >	Emplace (std::string const &hitCollectionName, CollectionArgs &&... args)
	Insert a container in the map with in-place construction.
template<AthHitVec::isHitVectorBase T>
T *	Find (std::string const &hitCollectionName)
	Get the hit collection for a given SDs.
template<AthHitVec::isHitVectorBase T>
std::unique_ptr< T >	Extract (std::string const &hitCollectionName)
	Extract the hit collection for a given SDs downcasted to the template parameter.
template<AthHitVec::isHitVectorBase T>
StatusCode	Record (std::string const &sgKey, std::string const &hitCollectionName, EventContext const &ctx)
	Record the hit collection hitCollectionName to the StoreGate sgKey.
template<AthHitVec::isHitVectorBase T>
StatusCode	Record (std::string const &hitCollectionName)
	Overload for Record with the same name for the SG key and hit collection name.
template<AthHitVec::isHitVectorBase T>
StatusCode	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.
template<AthHitVec::isHitVectorBase T>
StatusCode	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.

Private Member Functions
template<AthHitVec::isHitVectorBase T>
StatusCode	recordExtracted (std::string const &sgKey, EventContext const &ctx, std::unique_ptr< T > hitColl)

Private Attributes
Storage	m_outputCollections

Detailed Description

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

Definition at line 22 of file HitCollectionMap.h.

Member Typedef Documentation

Storage

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

Definition at line 25 of file HitCollectionMap.h.

StorageIterator

using HitCollectionMap::StorageIterator = typename Storage::iterator

Definition at line 26 of file HitCollectionMap.h.

Member Function Documentation

Emplace()

template<AthHitVec::isHitVectorBase 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 40 of file HitCollectionMap.h.

                                                                                                       {
      return m_outputCollections.emplace(
            hitCollectionName, std::make_unique<HitCollectionT>(std::forward<CollectionArgs>(args)...));
  }

Extract()

template<AthHitVec::isHitVectorBase 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 62 of file HitCollectionMap.h.

                                                               {
    auto it = m_outputCollections.find(hitCollectionName);
    if (it == m_outputCollections.end()) {
      return nullptr;
    }
 
    auto* baseCollection = it->second.release();
    auto* collection = dynamic_cast<T*>(baseCollection);
    if (!collection) {
      it->second.reset(baseCollection);
      return nullptr;
    }
 
    m_outputCollections.erase(it);
    return std::unique_ptr<T>{collection};
  }

Find()

template<AthHitVec::isHitVectorBase T>

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

inline

Get the hit collection for a given SDs.

Definition at line 49 of file HitCollectionMap.h.

                                              {
    auto it = m_outputCollections.find(hitCollectionName);
    if (it != m_outputCollections.end()) {
      return dynamic_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 31 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<AthHitVec::isHitVectorBase T>

StatusCode 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 92 of file HitCollectionMap.h.

                                                        {
    auto hitColl = Extract<T>(hitCollectionName);
    return recordExtracted<T>(hitCollectionName, Gaudi::Hive::currentContext(), std::move(hitColl));
  }

Record() [2/2]

template<AthHitVec::isHitVectorBase T>

StatusCode 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 83 of file HitCollectionMap.h.

                                                                                                         {
    auto hitColl = Extract<T>(hitCollectionName);
    return recordExtracted<T>(sgKey, ctx, std::move(hitColl));
  }

recordExtracted()

template<AthHitVec::isHitVectorBase T>

StatusCode HitCollectionMap::recordExtracted ( std::string const & sgKey, EventContext const & ctx, std::unique_ptr< T > hitColl )

inlineprivate

Definition at line 125 of file HitCollectionMap.h.

                                                                                                        {
    if (!hitColl) {
      return StatusCode::FAILURE;
    }
 
    if constexpr (AthHitVec::isAuxStoreHitCollection<T>) {
      SG::WriteHandle<typename T::container_type> handle{sgKey, ctx};
      return handle.record(std::move(hitColl->container), std::move(hitColl->auxContainer));
    } else {
      SG::WriteHandle<T> handle{sgKey, ctx};
      return handle.record(std::move(hitColl));
    }
  }

TransformAndRecord() [1/2]

template<AthHitVec::isHitVectorBase T>

StatusCode 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 119 of file HitCollectionMap.h.

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

TransformAndRecord() [2/2]

template<AthHitVec::isHitVectorBase T>

StatusCode 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 102 of file HitCollectionMap.h.

                                       {
    auto hitColl = Extract<T>(hitCollectionName);
    if (!hitColl) {
      return StatusCode::FAILURE;
    }
    transform(*hitColl);
    return recordExtracted<T>(sgKey, ctx, std::move(hitColl));
  }

Member Data Documentation

m_outputCollections

Storage HitCollectionMap::m_outputCollections

private

Definition at line 140 of file HitCollectionMap.h.

---

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

• HitCollectionMap.h