Base class for Handle classes, containing parts that are independent of how the Allocator gets created. More...

#include <ArenaHandleBaseT.h>

Inheritance diagram for SG::ArenaHandleBaseT< T, ALLOC >:

Collaboration diagram for SG::ArenaHandleBaseT< T, ALLOC >:

Classes
class	const_iterator
	Const iterator. More...

class	iterator
	Non-const iterator. More...

Public Types
typedef T *	pointer
	A pointer to the element type we're allocating. More...

typedef ArenaHandleBaseAllocT< ALLOC >	Base
	Shorthand for our base class. More...

typedef ALLOC	alloc_t
	The `Allocator` we use. More...

Public Member Functions
	ArenaHandleBaseT (ArenaHeader *header, size_t index)
	Constructor, passing in an index. More...

	ArenaHandleBaseT (ArenaHeader *header, const EventContext &ctx, size_t index)
	Constructor, passing in an index, for a specific event slot. More...

	ArenaHandleBaseT (ArenaBase *arena, size_t index)
	Constructor, passing in an index, for a specific Arena. More...

iterator	begin ()
	Starting iterator. More...

const_iterator	begin () const
	Starting const iterator. More...

iterator	end ()
	Ending iterator. More...

const_iterator	end () const
	Ending const iterator. More...

void	free (pointer p)
	Free an element. More...

void	resetTo (pointer p)
	Reset pool back to a previous state. More...

const ALLOC::Params &	params () const
	Return our Allocator's parameters. More...

void	reset ()
	Free all allocated elements (of this type in the current Arena). More...

void	erase ()
	Free all allocated elements and release memory back to the system (of this type in the current Arena). More...

void	reserve (size_t size)
	Set the total number of elements cached by the allocator (in the current Arena). More...

ArenaAllocatorBase::Stats	stats () const
	Return the statistics block for this allocator, for the current Arena. More...

Protected Member Functions
ALLOC *	allocator ()
	Return our current Allocator. More...

const ALLOC *	allocator () const
	Return our current Allocator. More...

ArenaAllocatorBase *	baseAllocator ()
	Return the current Allocator which we are referencing. More...

const ArenaAllocatorBase *	baseAllocator () const
	Return the current Allocator which we are referencing. More...

Static Protected Member Functions
template<class HANDLE , class DEFPARAMS >
static size_t	makeIndex (const typename ALLOC::Params *params)
	Find the index for creating an allocator. More...

Private Attributes
LockedAllocator	m_allocator
	The associated allocator object. More...

Detailed Description

template<class T, class ALLOC>
class SG::ArenaHandleBaseT< T, ALLOC >

Base class for Handle classes, containing parts that are independent of how the Allocator gets created.

See Arena.h for an overview of the arena-based memory allocators.

Definition at line 37 of file ArenaHandleBaseT.h.

Member Typedef Documentation

◆ alloc_t

template<typename ALLOC >

typedef ALLOC SG::ArenaHandleBaseAllocT< ALLOC >::alloc_t

inherited

The Allocator we use.

Definition at line 57 of file ArenaHandleBaseAllocT.h.

◆ Base

template<class T , class ALLOC >

typedef ArenaHandleBaseAllocT<ALLOC> SG::ArenaHandleBaseT< T, ALLOC >::Base

Shorthand for our base class.

Definition at line 45 of file ArenaHandleBaseT.h.

◆ pointer

template<class T , class ALLOC >

typedef T* SG::ArenaHandleBaseT< T, ALLOC >::pointer

A pointer to the element type we're allocating.

Definition at line 42 of file ArenaHandleBaseT.h.

Constructor & Destructor Documentation

◆ ArenaHandleBaseT() [1/3]

template<class T , class ALLOC >

SG::ArenaHandleBaseT< T, ALLOC >::ArenaHandleBaseT	(	ArenaHeader *	header,
		size_t	index
	)

Constructor, passing in an index.

Parameters

header	The group of Arenas which this Handle may reference. May be null to select the global default.
index	The index of this Handle's Allocator type.

◆ ArenaHandleBaseT() [2/3]

template<class T , class ALLOC >

SG::ArenaHandleBaseT< T, ALLOC >::ArenaHandleBaseT	(	ArenaHeader *	header,
		const EventContext &	ctx,
		size_t	index
	)

Constructor, passing in an index, for a specific event slot.

Parameters

header	The group of Arenas which this Handle may reference. May be null to select the global default.
ctx	Event context identifying the event slot.
index	The index of this Handle's Allocator type.

◆ ArenaHandleBaseT() [3/3]

template<class T , class ALLOC >

SG::ArenaHandleBaseT< T, ALLOC >::ArenaHandleBaseT	(	ArenaBase *	arena,
		size_t	index
	)

Constructor, passing in an index, for a specific Arena.

Parameters

arena	The Arena in which to find the allocator.
index	The index of this Handle's Allocator type.

Member Function Documentation

◆ allocator() [1/2]

template<typename ALLOC >

ALLOC* SG::ArenaHandleBaseAllocT< ALLOC >::allocator ( )

protectedinherited

Return our current Allocator.

◆ allocator() [2/2]

template<typename ALLOC >

const ALLOC* SG::ArenaHandleBaseAllocT< ALLOC >::allocator ( ) const

protectedinherited

Return our current Allocator.

◆ baseAllocator() [1/2]

ArenaAllocatorBase* SG::ArenaHandleBase::baseAllocator ( )

protectedinherited

Return the current Allocator which we are referencing.

This may cause a new Allocator to be created.

◆ baseAllocator() [2/2]

const ArenaAllocatorBase* SG::ArenaHandleBase::baseAllocator ( ) const

protectedinherited

Return the current Allocator which we are referencing.

This may cause a new Allocator to be created.

◆ begin() [1/2]

template<class T , class ALLOC >

iterator SG::ArenaHandleBaseT< T, ALLOC >::begin ( )

Starting iterator.

This will iterate over all allocated elements (in unspecified order). It is at least a forward_iterator. This may only be instantiated if the underlying Allocator supports iterators.

◆ begin() [2/2]

template<class T , class ALLOC >

const_iterator SG::ArenaHandleBaseT< T, ALLOC >::begin ( ) const

Starting const iterator.

This will iterate over all allocated elements (in unspecified order). It is at least a forward_iterator. This may only be instantiated if the underlying Allocator supports iterators.

◆ end() [1/2]

template<class T , class ALLOC >

iterator SG::ArenaHandleBaseT< T, ALLOC >::end ( )

Ending iterator.

This may only be instantiated if the underlying Allocator supports iterators.

◆ end() [2/2]

template<class T , class ALLOC >

const_iterator SG::ArenaHandleBaseT< T, ALLOC >::end ( ) const

Ending const iterator.

This may only be instantiated if the underlying Allocator supports iterators.

◆ erase()

void SG::ArenaHandleBase::erase ( )

inherited

Free all allocated elements and release memory back to the system (of this type in the current Arena).

All elements allocated in the current Arena by our associated Allocator are freed, and all allocated blocks of memory are released back to the system. destructor should be called on them if it was provided (preceded by clear if provided and mustClear was set).

Definition at line 87 of file ArenaHandleBase.cxx.

 {
   return baseAllocator()->erase();
 }

◆ free()

template<class T , class ALLOC >

void SG::ArenaHandleBaseT< T, ALLOC >::free ( pointer p )

Free an element.

Parameters

p	The element to be freed.

clear() will be called on the element at this point, if it has been defined.

This may only be instantiated if it's supported by the underlying Allocator.

◆ makeIndex()

template<typename ALLOC >

template<class HANDLE , class DEFPARAMS >

static size_t SG::ArenaHandleBaseAllocT< ALLOC >::makeIndex ( const typename ALLOC::Params * params )

staticprotectedinherited

Find the index for creating an allocator.

Parameters

params Pointer to the supplied parameters. If null, use the result of DEFPARAMS().

We look up in the registry the Allocator name we get from params (if this is blank, a name is derived from ALLOC). If not found, then we register Allocator and return the new index.

◆ params()

template<typename ALLOC >

const ALLOC::Params& SG::ArenaHandleBaseAllocT< ALLOC >::params ( ) const

inherited

Return our Allocator's parameters.

◆ reserve()

void SG::ArenaHandleBase::reserve ( size_t size )

inherited

Set the total number of elements cached by the allocator (in the current Arena).

Parameters

size	The desired pool size.

This allows changing the number of elements that are currently free but cached. Any allocated elements are not affected by this call.

If size is greater than the total number of elements currently cached, then more will be allocated. This will preferably done with a single block, but that is not guaranteed; in addition, the allocator may allocate more elements than is requested.

If size is smaller than the total number of elements currently cached, as many blocks as possible will be released back to the system. It may not be possible to release the number of elements requested; this should be implemented on a best-effort basis.

Definition at line 111 of file ArenaHandleBase.cxx.

 {
   return baseAllocator()->reserve (size);
 }

◆ reset()

void SG::ArenaHandleBase::reset ( )

inherited

Free all allocated elements (of this type in the current Arena).

All elements allocated in the current Arena by our associated Allocator are returned to the free state. clear should be called on them if it was provided. The elements may continue to be cached internally, without returning to the system.

Definition at line 71 of file ArenaHandleBase.cxx.

 {
   return baseAllocator()->reset();
 }

◆ resetTo()

template<class T , class ALLOC >

void SG::ArenaHandleBaseT< T, ALLOC >::resetTo ( pointer p )

Reset pool back to a previous state.

Parameters

p	The pointer back to which to reset.

This will free (a la reset) the element p and all elements that have been allocated after it from this allocator.

This may only be instantiated if it's supported by the underlying Allocator.

◆ stats()

ArenaAllocatorBase::Stats SG::ArenaHandleBase::stats ( ) const

inherited

Return the statistics block for this allocator, for the current Arena.

Definition at line 121 of file ArenaHandleBase.cxx.

 {
   return baseAllocator()->stats();
 }

Member Data Documentation

◆ m_allocator

LockedAllocator SG::ArenaHandleBase::m_allocator

privateinherited

The associated allocator object.

Definition at line 160 of file ArenaHandleBase.h.

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

ArenaHandleBaseT.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

template<class T, class ALLOC> class SG::ArenaHandleBaseT< T, ALLOC >

Member Typedef Documentation

◆ alloc_t

◆ Base

◆ pointer

Constructor & Destructor Documentation

◆ ArenaHandleBaseT() [1/3]

◆ ArenaHandleBaseT() [2/3]

◆ ArenaHandleBaseT() [3/3]

Member Function Documentation

◆ allocator() [1/2]

◆ allocator() [2/2]

◆ baseAllocator() [1/2]

◆ baseAllocator() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ erase()

◆ free()

◆ makeIndex()

◆ params()

◆ reserve()

◆ reset()

◆ resetTo()

◆ stats()

Member Data Documentation

◆ m_allocator

template<class T, class ALLOC>
class SG::ArenaHandleBaseT< T, ALLOC >