DynamicContainerListHelper< T_Container > Struct Template Reference

Helper class which allows to dynamically grow the container list. More...

#include <ContainerList.h>

Collaboration diagram for DynamicContainerListHelper< T_Container >:

Classes
struct	ContainerPtr
	Helper which provides a pointer to a container and the index of the container in the container list. More...

Public Types
using	T_ContainerPtr = T_Container *

Public Member Functions
void	addLargerContainerList (unsigned int container_idx, ContainerList< T_Container > &container_list)
	If the specified entry does not exist in the container list create an extended copy which contains this entry.
ContainerPtr	getNewContainer (ContainerList< T_Container > &container_list)
	Get an unused container from the given container list.

Public Attributes
std::mutex	m_containerListMutex
std::atomic< unsigned int >	m_used {}

Detailed Description

template<typename T_Container>
struct DynamicContainerListHelper< T_Container >

Helper class which allows to dynamically grow the container list.

Definition at line 88 of file ContainerList.h.

Member Typedef Documentation

T_ContainerPtr

template<typename T_Container>

using DynamicContainerListHelper< T_Container >::T_ContainerPtr = T_Container *

Definition at line 89 of file ContainerList.h.

Member Function Documentation

addLargerContainerList()

template<typename T_Container>

void DynamicContainerListHelper< T_Container >::addLargerContainerList ( unsigned int container_idx, ContainerList< T_Container > & container_list )

inline

If the specified entry does not exist in the container list create an extended copy which contains this entry.

Parameters

container_idx	The index which specifies the container in the container list
container_list	the container list. If container_idx specifies a container beyond this list, the current list is copied and extended to contain the specified container. The operation is mutex protected.

Definition at line 123 of file ContainerList.h.

                                                                                                       {
      std::lock_guard<std::mutex> container_list_lock(m_containerListMutex);
      if (container_idx >= container_list.m_containerList.size()) {
         // create new container list with min_elements extra elements i.e. grow in chunks
         static constexpr std::size_t min_elments = (sizeof(T_ContainerPtr)>=32u ? 1ul : 64ul/sizeof(T_ContainerPtr)-1);
         const std::size_t new_size=(m_used+min_elments+1) & (~(min_elments));
         unsigned int n=new_size - container_list.m_containerList.size();
         // add a new container_list and add new empty containers
         container_list.m_container.emplace_back( n );
         container_list.m_containerListHistory.emplace_back( new_size );
         std::vector<T_ContainerPtr> &new_container_list = container_list.m_containerListHistory.back();
         std::vector<T_Container> &extra_container = container_list.m_container.back();
         assert(new_container_list.size()>=container_list.m_containerList.size());
         // copy pointers from original container list to new container list
         std::copy(container_list.m_containerList.begin(),container_list.m_containerList.end(),new_container_list.begin());
         // set pointers of new container_list
         container_list.m_containerList = ContainerList<T_Container>::fillContainerList(container_list.m_containerList.size(),
                                                                                        extra_container,
                                                                                        std::span(new_container_list) );
      }
   }

getNewContainer()

template<typename T_Container>

ContainerPtr DynamicContainerListHelper< T_Container >::getNewContainer ( ContainerList< T_Container > & container_list )

inline

Get an unused container from the given container list.

If the preallocated list of containers is exceeded. The container list will be extended.

Definition at line 147 of file ContainerList.h.

                                                                            {
      unsigned int container_idx = m_used++;
      if (container_idx >= container_list.m_containerList.size()) {
         addLargerContainerList(container_idx, container_list);
      }
      return ContainerPtr(container_list.m_containerList[container_idx],container_idx);
   }

Member Data Documentation

m_containerListMutex

template<typename T_Container>

std::mutex DynamicContainerListHelper< T_Container >::m_containerListMutex

Definition at line 155 of file ContainerList.h.

m_used

template<typename T_Container>

std::atomic<unsigned int> DynamicContainerListHelper< T_Container >::m_used {}

Definition at line 156 of file ContainerList.h.

{};

---

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

• ContainerList.h