#include <ChamberViewer.h>

Collaboration diagram for xAOD::ChamberViewer< HitObjContainer >:

Classes
struct	ref_trait
	Type trait to find the proper refernce type for the lambda function access. More...

Public Types
using	value_type = typename HitObjContainer::value_type

using	element_type = typename std::remove_pointer_t< value_type >

using	const_ref = ref_trait< value_type >::type

using	ViewMode = ChamberView::Mode

Public Member Functions
template<typename HitObjType >
	requires (std::is_pointer_v< HitObjType >) struct ref_trait< HitObjType >
	Branch if the input value type is a pointer. More...

template<typename HitObjType >
	requires (!std::is_pointer_v< HitObjType >) struct ref_trait< HitObjType >
	Branch if the input value is an object. More...

	ChamberViewer (const HitObjContainer &container) noexcept
	Standard constructor. More...

	ChamberViewer (const HitObjContainer &container, const Muon::IMuonIdHelperSvc *idHelperSvc, const ViewMode mode=ViewMode::DetElement) noexcept
	Standard constructor. More...

	ChamberViewer (const ChamberViewer &other)=delete
	Delete the copy constructor. More...

ChamberViewer &	operator= (const ChamberViewer &other)=delete
	Delete the copy assignment operator. More...

	ChamberViewer (ChamberViewer &&other)=default
	Standard move constructor. More...

ChamberViewer &	operator= (ChamberViewer &&other)=default
	Standard move operator. More...

HitObjContainer::const_iterator	begin () const noexcept
	Begin iterator of the current chamber view. More...

HitObjContainer::const_iterator	end () const noexcept
	End iterator of the current chamber view. More...

std::size_t	size () const noexcept
	Returns how many hits are in the current chamber. More...

HitObjContainer::const_iterator::reference	at (const std::size_t idx) const
	Returns the i-the measurement from the current chamber. More...

bool	next () noexcept
	Loads the hits from the next chamber. More...

bool	loadView (const Identifier &chamberId)
	Loads the view matching the parsed identifier. More...

bool	loadView (const IdentifierHash &idHash)
	Loads the view matching the parsed IdentifierHash. More...

bool	loadView (std::function< bool(const_ref)> selector)

Private Member Functions
IdentifierHash	idHash (const Identifier &id) const
	Returns the IdentifierHash from an Identifier. More...

Private Attributes
const HitObjContainer &	m_container

const Muon::IMuonIdHelperSvc *	m_idHelperSvc {nullptr}

const ViewMode	m_mode {ViewMode::DetElement}

DetectorIDHashType	m_currentHash {0}

HitObjContainer::const_iterator	m_end {m_container.begin()}

HitObjContainer::const_iterator	m_begin {m_container.begin()}

Detailed Description

template<ChamberViewConcepts::ContainerConcept HitObjContainer>
class xAOD::ChamberViewer< HitObjContainer >

Definition at line 65 of file ChamberViewer.h.

Member Typedef Documentation

◆ const_ref

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::const_ref = ref_trait<value_type>::type

Definition at line 87 of file ChamberViewer.h.

◆ element_type

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::element_type = typename std::remove_pointer_t<value_type>

Definition at line 68 of file ChamberViewer.h.

◆ value_type

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::value_type = typename HitObjContainer::value_type

Definition at line 67 of file ChamberViewer.h.

◆ ViewMode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::ViewMode = ChamberView::Mode

Definition at line 88 of file ChamberViewer.h.

Constructor & Destructor Documentation

◆ ChamberViewer() [1/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( const HitObjContainer & container )

inlinenoexcept

Standard constructor.

Parameters

container UncalibratedMeasurementContainer from which the views per chamber shall be generated

Definition at line 92 of file ChamberViewer.h.

                                                                         :
                     m_container{container} {
                     static_assert(ChamberViewConcepts::hasIdentifyHash<element_type>::value, "Object needs to provide identifierHash" );
                     next();
                 }

◆ ChamberViewer() [2/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer	(	const HitObjContainer &	container,
		const Muon::IMuonIdHelperSvc *	idHelperSvc,
		const ViewMode	mode = `ViewMode::DetElement`
	)

inlinenoexcept

Standard constructor.

Parameters

container UncalibratedMeasurementContainer from which the views per chamber shall be generated

Definition at line 99 of file ChamberViewer.h.

                                                                                :
                     m_container{container},
                     m_idHelperSvc{idHelperSvc},
                     m_mode{mode} {
                     static_assert(ChamberViewConcepts::hasIdentify<element_type>::value, "Object needs to provide identify()" );
                     next();
                 }

◆ ChamberViewer() [3/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( const ChamberViewer< HitObjContainer > & other )

delete

Delete the copy constructor.

◆ ChamberViewer() [4/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( ChamberViewer< HitObjContainer > && other )

default

Standard move constructor.

Member Function Documentation

◆ at()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

HitObjContainer::const_iterator::reference xAOD::ChamberViewer< HitObjContainer >::at ( const std::size_t idx ) const

inline

Returns the i-the measurement from the current chamber.

Definition at line 129 of file ChamberViewer.h.

                                                                                      {
                     if (idx >= size()) {
                         THROW_EXCEPTION("Invalid index given "<<typeid(value_type).name()<<" Size: "<<size()<<", requested: "<<idx);
                     }
                     return (*m_begin +idx);
                 }

◆ begin()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

HitObjContainer::const_iterator xAOD::ChamberViewer< HitObjContainer >::begin ( ) const

inlinenoexcept

Begin iterator of the current chamber view.

Definition at line 117 of file ChamberViewer.h.

                                                                     {
                     return m_begin;
                 }

◆ end()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

HitObjContainer::const_iterator xAOD::ChamberViewer< HitObjContainer >::end ( ) const

inlinenoexcept

End iterator of the current chamber view.

Definition at line 121 of file ChamberViewer.h.

                                                                    {
                     return m_end;
                 }

◆ idHash()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

IdentifierHash xAOD::ChamberViewer< HitObjContainer >::idHash ( const Identifier & id ) const

inlineprivate

Returns the IdentifierHash from an Identifier.

Definition at line 198 of file ChamberViewer.h.

                                                                   {
                     return m_mode == ViewMode::DetElement ? m_idHelperSvc->detElementHash(id)
                                                           : m_idHelperSvc->moduleHash(id);
                 }

◆ loadView() [1/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( const Identifier & chamberId )

inline

Loads the view matching the parsed identifier.

I.e. the collection of hits sharing the same IdentifierHash. Returns whether the view is empty or not

Parameters

chamberId Identifier from the chamber / detElement to consider

Definition at line 162 of file ChamberViewer.h.

                                                            {
                     static_assert(ChamberViewConcepts::hasIdentify<element_type>::value, "Object needs to provide identify()" );
                     const IdentifierHash detId = idHash(chamberId);
                     m_begin = std::ranges::find_if(m_container,[this,&detId](const_ref meas) {
                                                         return idHash(meas->identify()) == detId;
                                                    });
                     m_end = std::find_if(m_begin, m_container.end(),[this,&detId](const_ref meas) {
                                                         return idHash(meas->identify()) != detId;
                                                    });
                     return m_begin != m_end;
                 }

◆ loadView() [2/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( const IdentifierHash & idHash )

inline

Loads the view matching the parsed IdentifierHash.

I.e. either the detector element hash or the chamber module hash. There's no cross-check whether the interpretion of both hashes is the same

Parameters

idHash IdentifierHash to search

Definition at line 176 of file ChamberViewer.h.

                                                             {
                     static_assert(ChamberViewConcepts::hasIdentifyHash<element_type>::value, "Object needs to provide identify()" );
                     m_begin = std::ranges::find_if(m_container,[&idHash](const_ref meas) {
                                                         return meas->identifierHash() == idHash;
                                                    });
                     m_end = std::find_if(m_begin, m_container.end(),[&idHash](const_ref meas) {
                                                         return meas->identifierHash() != idHash;
                                                    });
                      return m_begin != m_end;
                 }

◆ loadView() [3/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( std::function< bool(const_ref)> selector )

inline

Definition at line 187 of file ChamberViewer.h.

                                                                      {
                     m_begin = std::ranges::find_if(m_container, selector);
                     m_end = std::find_if(m_begin, m_container.end(),
                                          [&selector](const_ref meas) {
                                             return !selector(meas);
                                         });
                     return m_begin != m_end;
                 }

◆ next()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::next ( )

inlinenoexcept

Loads the hits from the next chamber.

Returns false if all chambers have been traversed.

Definition at line 137 of file ChamberViewer.h.

                                      {
                     if (m_end == m_container.end()) {
                         return false;
                     }
                     m_begin = m_end;
                     if constexpr (ChamberViewConcepts::hasIdentifyHash<element_type>::value) {
                         m_currentHash = (*m_end)->identifierHash();
                         m_end = std::find_if(m_begin, m_container.end(),
                                          [this](const_ref meas){
                                             return meas->identifierHash() != m_currentHash;
                                         });
                     } else {
                          m_currentHash = idHash((*m_end)->identify());
                          m_end = std::find_if(m_begin, m_container.end(),
                                          [this](const_ref meas){
                                             return idHash(meas->identify()) != m_currentHash;
                                         });                       
                     }
                     if (m_begin == m_end) return next(); // veto empty views
                     return true;
                 }

◆ operator=() [1/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

ChamberViewer& xAOD::ChamberViewer< HitObjContainer >::operator= ( ChamberViewer< HitObjContainer > && other )

default

Standard move operator.

◆ operator=() [2/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

ChamberViewer& xAOD::ChamberViewer< HitObjContainer >::operator= ( const ChamberViewer< HitObjContainer > & other )

delete

Delete the copy assignment operator.

◆ requires() [1/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

template<typename HitObjType >

xAOD::ChamberViewer< HitObjContainer >::requires ( !std::is_pointer_v< HitObjType > )

inline

Branch if the input value is an object.

Const type

Const reference type

Definition at line 81 of file ChamberViewer.h.

                                                                                                                   {
                     using const_type = typename std::add_const_t<HitObjType>;
                     using type = typename std::add_lvalue_reference<const_type>::type;
                 };

◆ requires() [2/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

template<typename HitObjType >

xAOD::ChamberViewer< HitObjContainer >::requires ( std::is_pointer_v< HitObjType > )

inline

Branch if the input value type is a pointer.

Convert to the underlying object itself

Make the object to be const

Declare the type to be a const pointer

Definition at line 72 of file ChamberViewer.h.

                                                                                                                   {
                     using element_type = typename std::remove_pointer_t<HitObjType>;
                     using const_type = typename std::add_const_t<element_type>;
                     using type = std::add_pointer_t<const_type>; 
                 };

◆ size()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

std::size_t xAOD::ChamberViewer< HitObjContainer >::size ( ) const

inlinenoexcept

Returns how many hits are in the current chamber.

Definition at line 125 of file ChamberViewer.h.

                                                {
                     return std::distance(m_begin, m_end);
                 }

Member Data Documentation

◆ m_begin

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

HitObjContainer::const_iterator xAOD::ChamberViewer< HitObjContainer >::m_begin {m_container.begin()}

private

Definition at line 207 of file ChamberViewer.h.

◆ m_container

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const HitObjContainer& xAOD::ChamberViewer< HitObjContainer >::m_container

private

Definition at line 202 of file ChamberViewer.h.

◆ m_currentHash

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

DetectorIDHashType xAOD::ChamberViewer< HitObjContainer >::m_currentHash {0}

private

Definition at line 205 of file ChamberViewer.h.

◆ m_end

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

HitObjContainer::const_iterator xAOD::ChamberViewer< HitObjContainer >::m_end {m_container.begin()}

private

Definition at line 206 of file ChamberViewer.h.

◆ m_idHelperSvc

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const Muon::IMuonIdHelperSvc* xAOD::ChamberViewer< HitObjContainer >::m_idHelperSvc {nullptr}

private

Definition at line 203 of file ChamberViewer.h.

◆ m_mode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const ViewMode xAOD::ChamberViewer< HitObjContainer >::m_mode {ViewMode::DetElement}

private

Definition at line 204 of file ChamberViewer.h.

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

ChamberViewer.h

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<ChamberViewConcepts::ContainerConcept HitObjContainer> class xAOD::ChamberViewer< HitObjContainer >

Member Typedef Documentation

◆ const_ref

◆ element_type

◆ value_type

◆ ViewMode

Constructor & Destructor Documentation

◆ ChamberViewer() [1/4]

◆ ChamberViewer() [2/4]

◆ ChamberViewer() [3/4]

◆ ChamberViewer() [4/4]

Member Function Documentation

◆ at()

◆ begin()

◆ end()

◆ idHash()

◆ loadView() [1/3]

◆ loadView() [2/3]

◆ loadView() [3/3]

◆ next()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ requires() [1/2]

◆ requires() [2/2]

◆ size()

Member Data Documentation

◆ m_begin

◆ m_container

◆ m_currentHash

◆ m_end

◆ m_idHelperSvc

◆ m_mode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>
class xAOD::ChamberViewer< HitObjContainer >