ATLAS Offline Software
Loading...
Searching...
No Matches
PhaseII::RawDataProxyBase< T_RawDataContainer > Class Template Reference

Base class for an RDO proxy. More...

#include <PhaseIIInDetRawDataContainer.h>

Inheritance diagram for PhaseII::RawDataProxyBase< T_RawDataContainer >:
Collaboration diagram for PhaseII::RawDataProxyBase< T_RawDataContainer >:

Public Types

using BASE = Utils::ElementProxyBase<T_RawDataContainer, unsigned int>
using index_t
using ContainerNonConst
using ContainerPtr

Public Member Functions

const auto & coordinates () const
auto & coordinates ()
const auto & dataWord () const
auto & dataWord ()
index_t index () const
const ContainerNonConstcontainer () const
ContainerNonConstcontainer ()

Static Public Attributes

static constexpr bool isConst

Protected Member Functions

const ContainerNonConstcptr () const

Protected Attributes

ContainerPtr m_container
index_t m_index

Detailed Description

template<class T_RawDataContainer>
class PhaseII::RawDataProxyBase< T_RawDataContainer >

Base class for an RDO proxy.

The proxy objects provide an interface which provides on object like interface for the data stored in the base container. It provides access to hit coordinates of a single hit and an associated data word, but lacks the means to interpret the data word.

Definition at line 360 of file PhaseIIInDetRawDataContainer.h.

Member Typedef Documentation

◆ BASE

template<class T_RawDataContainer>
using PhaseII::RawDataProxyBase< T_RawDataContainer >::BASE = Utils::ElementProxyBase<T_RawDataContainer, unsigned int>

Definition at line 362 of file PhaseIIInDetRawDataContainer.h.

◆ ContainerNonConst

using Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::ContainerNonConst
inherited

Definition at line 116 of file ProxyContainer.h.

◆ ContainerPtr

using Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::ContainerPtr
inherited

Definition at line 117 of file ProxyContainer.h.

◆ index_t

using Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::index_t
inherited

Definition at line 115 of file ProxyContainer.h.

Member Function Documentation

◆ container() [1/2]

ContainerNonConst & Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::container ( )
inlineinherited
Returns
A non const pointer of the container which contains the elements this proxy refers to if the access policy permits read-write access

Definition at line 156 of file ProxyContainer.h.

◆ container() [2/2]

const ContainerNonConst & Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::container ( ) const
inlineinherited
Returns
A const pointer of the container which contains the elements this proxy refers to. The value returned by index identifies the element within this container.

Definition at line 152 of file ProxyContainer.h.

153 { assert( m_container != nullptr); return *m_container; }

◆ coordinates() [1/2]

template<class T_RawDataContainer>
auto & PhaseII::RawDataProxyBase< T_RawDataContainer >::coordinates ( )
inline

Definition at line 368 of file PhaseIIInDetRawDataContainer.h.

368 {
369 return this->container().coordinates(this->index());
370 }

◆ coordinates() [2/2]

template<class T_RawDataContainer>
const auto & PhaseII::RawDataProxyBase< T_RawDataContainer >::coordinates ( ) const
inline

Definition at line 365 of file PhaseIIInDetRawDataContainer.h.

365 {
366 return this->container().coordinates(this->index());
367 }

◆ cptr()

const ContainerNonConst * Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::cptr ( ) const
inlineprotectedinherited

Definition at line 159 of file ProxyContainer.h.

159 {
160 return &container();
161 }

◆ dataWord() [1/2]

template<class T_RawDataContainer>
auto & PhaseII::RawDataProxyBase< T_RawDataContainer >::dataWord ( )
inline

Definition at line 374 of file PhaseIIInDetRawDataContainer.h.

374 {
375 return this->container().dataWord(this->index());
376 }

◆ dataWord() [2/2]

template<class T_RawDataContainer>
const auto & PhaseII::RawDataProxyBase< T_RawDataContainer >::dataWord ( ) const
inline

Definition at line 371 of file PhaseIIInDetRawDataContainer.h.

371 {
372 return this->container().dataWord(this->index());
373 }

◆ index()

index_t Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::index ( ) const
inlineinherited
Parameters
Returnthe "index" which identifies the element this proxy refers to within the container returned by container. This may or may not be the index which was used to create this proxy from the parent proxy i.e. in auto child_proxy=parent_proxy[index] it may be that child_proxy.index() != index. To recover "index" use auto index_recover = ParentProxy::getOriginalElementIndex(child_proxy);

Definition at line 148 of file ProxyContainer.h.

148{ return m_index; }

Member Data Documentation

◆ isConst

bool Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::isConst
staticconstexprinherited

Definition at line 114 of file ProxyContainer.h.

◆ m_container

ContainerPtr Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::m_container
protectedinherited

Definition at line 162 of file ProxyContainer.h.

◆ m_index

index_t Utils::ElementProxyBase< T_RawDataContainer, unsigned int >::m_index
protectedinherited

Definition at line 163 of file ProxyContainer.h.


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