xiiLocalAllocatorWrapper Struct Reference

#include <AllocatorWrapper.h>

Public Member Functions
	xiiLocalAllocatorWrapper (xiiAllocator *pAllocator)
void	Reset ()

Static Public Member Functions
static xiiAllocator *	GetAllocator ()

Detailed Description

Helper function to facilitate setting the allocator on member containers of a class Allocators can be either template arguments or a ctor parameter. Using the ctor parameter requires the class ctor to reference each member container in the initialization list. This can be very tedious. On the other hand, the template variant only support template parameter so you can't simply pass in a member allocator. This class solves this problem provided the following rules are followed:

1. The xiiAllocator must be the declared at the earliest in the class, before any container.
2. The xiiLocalAllocatorWrapper should be declared right afterwards.
3. Any container needs to be declared below these two and must include the xiiLocalAllocatorWrapper as a template argument to the allocator.
4. In the ctor initializer list, init the xiiAllocator first, then the xiiLocalAllocatorWrapper. With this approach all containers can be omitted.

   class MyClass
   {
     xiiAllocator m_SpecialAlloc;
     xiiLocalAllocatorWrapper m_Wrapper;
    
     xiiDynamicArray<int, xiiLocalAllocatorWrapper> m_Data;
    
     MyClass()
       : m_SpecialAlloc("MySpecialAlloc")
       , m_Wrapper(&m_SpecialAlloc)
     {
     }
   }

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Memory/AllocatorWrapper.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Memory/Implementation/AllocatorWrapper.cpp