Open CASCADE Technology  7.3.1.dev
Public Member Functions
NCollection_WinHeapAllocator Class Reference

This memory allocator creates dedicated heap for allocations. This technics available only on Windows platform (no alternative on Unix systems). It may be used to take control over memory fragmentation because on destruction ALL allocated memory will be released to the system. More...

#include <NCollection_WinHeapAllocator.hxx>

Inheritance diagram for NCollection_WinHeapAllocator:
Inheritance graph
[legend]

Public Member Functions

 NCollection_WinHeapAllocator (const size_t theInitSizeBytes=0x80000)
 Main constructor. More...
 
virtual ~NCollection_WinHeapAllocator ()
 Destructor. More...
 
virtual void * Allocate (const Standard_Size theSize) override
 Allocate memory. More...
 
virtual void Free (void *theAddress) override
 Release memory. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from NCollection_BaseAllocator
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. More...
 
static void StandardCallBack (const Standard_Boolean theIsAlloc, const Standard_Address theStorage, const Standard_Size theRoundSize, const Standard_Size theSize)
 Callback function to register alloc/free calls. More...
 
static void PrintMemUsageStatistics ()
 Prints memory usage statistics cumulated by StandardCallBack. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from NCollection_BaseAllocator
 NCollection_BaseAllocator (void)
 Constructor - prohibited. More...
 

Detailed Description

This memory allocator creates dedicated heap for allocations. This technics available only on Windows platform (no alternative on Unix systems). It may be used to take control over memory fragmentation because on destruction ALL allocated memory will be released to the system.

This allocator can also be created per each working thread hovewer it real multi-threading performance is dubious.

Notice that this also means that existing pointers will be broken and you shoould control that allocator is alive along all objects allocated with him.

Constructor & Destructor Documentation

◆ NCollection_WinHeapAllocator()

NCollection_WinHeapAllocator::NCollection_WinHeapAllocator ( const size_t  theInitSizeBytes = 0x80000)

Main constructor.

◆ ~NCollection_WinHeapAllocator()

virtual NCollection_WinHeapAllocator::~NCollection_WinHeapAllocator ( )
virtual

Destructor.

Member Function Documentation

◆ Allocate()

virtual void* NCollection_WinHeapAllocator::Allocate ( const Standard_Size  theSize)
overridevirtual

Allocate memory.

Reimplemented from NCollection_BaseAllocator.

◆ Free()

virtual void NCollection_WinHeapAllocator::Free ( void *  theAddress)
overridevirtual

Release memory.

Reimplemented from NCollection_BaseAllocator.


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