InPlaceClusterization::CellProxy< T_CellContainer > Class Template Reference

#include <CellContainerProxy.h>

Inheritance diagram for InPlaceClusterization::CellProxy< T_CellContainer >:

Collaboration diagram for InPlaceClusterization::CellProxy< T_CellContainer >:

Public Types
using	BASE = Utils::ElementProxyBase<T_CellContainer,unsigned int>
using	index_t
using	ContainerNonConst
using	ContainerPtr

Public Member Functions
auto	srcIndex () const
const auto &	coordinates () const
auto &	coordinates ()
index_t	index () const
const ContainerNonConst &	container () const
ContainerNonConst &	container ()

Static Public Attributes
static constexpr bool	isConst

Protected Member Functions
const ContainerNonConst *	cptr () const

Protected Attributes
ContainerPtr	m_container
index_t	m_index

Detailed Description

template<class T_CellContainer>
class InPlaceClusterization::CellProxy< T_CellContainer >

Definition at line 27 of file CellContainerProxy.h.

Member Typedef Documentation

BASE

template<class T_CellContainer>

using InPlaceClusterization::CellProxy< T_CellContainer >::BASE = Utils::ElementProxyBase<T_CellContainer,unsigned int>

Definition at line 30 of file CellContainerProxy.h.

ContainerNonConst

using Utils::ElementProxyBase< T_CellContainer, unsigned int >::ContainerNonConst

inherited

Definition at line 116 of file ProxyContainer.h.

ContainerPtr

using Utils::ElementProxyBase< T_CellContainer, unsigned int >::ContainerPtr

inherited

Definition at line 117 of file ProxyContainer.h.

index_t

using Utils::ElementProxyBase< T_CellContainer, unsigned int >::index_t

inherited

Definition at line 115 of file ProxyContainer.h.

Member Function Documentation

container() [1/2]

ContainerNonConst & Utils::ElementProxyBase< T_CellContainer, 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.

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

container() [2/2]

const ContainerNonConst & Utils::ElementProxyBase< T_CellContainer, 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.

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

coordinates() [1/2]

template<class T_CellContainer>

auto & InPlaceClusterization::CellProxy< T_CellContainer >::coordinates ( )

inline

Definition at line 41 of file CellContainerProxy.h.

                                                {
      assert(this->index() <  this->container().m_cells.size());
      return this->container().m_cells[this->index()].coordinates;
   }

coordinates() [2/2]

template<class T_CellContainer>

const auto & InPlaceClusterization::CellProxy< T_CellContainer >::coordinates ( ) const

inline

Definition at line 37 of file CellContainerProxy.h.

                                   {
      assert(this->index() <  this->container().m_cells.size());
      return this->container().m_cells[this->index()].coordinates;
   }

cptr()

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

inlineprotectedinherited

Definition at line 159 of file ProxyContainer.h.

                                         {
      return &container();
   }

index()

index_t Utils::ElementProxyBase< T_CellContainer, unsigned int >::index ( ) const

inlineinherited

Parameters

Return

the "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.

{ return m_index; }

srcIndex()

template<class T_CellContainer>

auto InPlaceClusterization::CellProxy< T_CellContainer >::srcIndex ( ) const

inline

Definition at line 33 of file CellContainerProxy.h.

                         {
      assert(this->index() <  this->container().m_cells.size());
      return this->container().m_cells[this->index()].srcIndex;
   }

Member Data Documentation

isConst

bool Utils::ElementProxyBase< T_CellContainer, unsigned int >::isConst

staticconstexprinherited

Definition at line 114 of file ProxyContainer.h.

m_container

ContainerPtr Utils::ElementProxyBase< T_CellContainer, unsigned int >::m_container

protectedinherited

Definition at line 162 of file ProxyContainer.h.

m_index

index_t Utils::ElementProxyBase< T_CellContainer, unsigned int >::m_index

protectedinherited

Definition at line 163 of file ProxyContainer.h.

---

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

• CellContainerProxy.h