NCollection_BaseAllocator Class Reference

#include <NCollection_BaseAllocator.hxx>

Inheritance diagram for NCollection_BaseAllocator:

Public Member Functions
virtual void *	Allocate (const size_t theSize)
virtual void *	AllocateOptimal (const size_t theSize)
virtual void	Free (void *theAddress)
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static const Handle< NCollection_BaseAllocator > &	CommonBaseAllocator (void)
	CommonBaseAllocator This method is designed to have the only one BaseAllocator (to avoid useless copying of collections). However one can use operator new to create more BaseAllocators, but it is injurious.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions
	NCollection_BaseAllocator ()
	Constructor - prohibited.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Purpose: Basic class for memory allocation wizards. Defines the interface for devising different allocators firstly to be used by collections of NCollection, though it it is not deferred. It allocates/frees the memory through Standard procedures, thus it is unnecessary (and sometimes injurious) to have more than one such allocator. To avoid creation of multiple objects the constructors were maid inaccessible. To create the BaseAllocator use the method CommonBaseAllocator. Note that this object is managed by Handle.

Constructor & Destructor Documentation

NCollection_BaseAllocator()

NCollection_BaseAllocator::NCollection_BaseAllocator ( )

inlineprotected

Constructor - prohibited.

Member Function Documentation

Allocate()

virtual void * NCollection_BaseAllocator::Allocate ( const size_t  theSize )

virtual

Reimplemented in NCollection_IncAllocator, NCollection_AccAllocator, NCollection_AlignedAllocator, NCollection_HeapAllocator, and NCollection_WinHeapAllocator.

AllocateOptimal()

virtual void * NCollection_BaseAllocator::AllocateOptimal ( const size_t  theSize )

virtual

Reimplemented in NCollection_IncAllocator, NCollection_AccAllocator, NCollection_AlignedAllocator, NCollection_HeapAllocator, and NCollection_WinHeapAllocator.

CommonBaseAllocator()

static const Handle< NCollection_BaseAllocator > & NCollection_BaseAllocator::CommonBaseAllocator ( void  )

static

CommonBaseAllocator This method is designed to have the only one BaseAllocator (to avoid useless copying of collections). However one can use operator new to create more BaseAllocators, but it is injurious.

Free()

virtual void NCollection_BaseAllocator::Free ( void *  theAddress )

virtual

Reimplemented in NCollection_IncAllocator, NCollection_HeapAllocator, NCollection_AccAllocator, NCollection_WinHeapAllocator, and NCollection_AlignedAllocator.

---

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

• NCollection_BaseAllocator.hxx