0023024: Update headers of OCCT files
[occt.git] / src / NCollection / NCollection_HeapAllocator.hxx
1 // Created on: 2009-12-30
2 // Created by: Alexander GRIGORIEV
3 // Copyright (c) 2009-2012 OPEN CASCADE SAS
4 //
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
9 //
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 //
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
19
20
21
22 #ifndef NCollection_HeapAllocator_HeaderFile
23 #define NCollection_HeapAllocator_HeaderFile
24
25 #include <NCollection_BaseAllocator.hxx>
26
27 class Handle_NCollection_HeapAllocator;
28
29 /**
30  * Allocator that uses the global dynamic heap (malloc / free). 
31  */
32
33 class NCollection_HeapAllocator : public NCollection_BaseAllocator
34 {
35  public:
36   // ---------- PUBLIC METHODS ----------
37   Standard_EXPORT virtual void* Allocate (const Standard_Size theSize);
38   Standard_EXPORT virtual void  Free     (void * anAddress);
39
40   Standard_EXPORT static const Handle_NCollection_HeapAllocator&
41                                 GlobalHeapAllocator();
42
43  protected:
44   //! Constructor - prohibited
45   NCollection_HeapAllocator(void) {};
46
47  private:
48   //! Copy constructor - prohibited
49   NCollection_HeapAllocator(const NCollection_HeapAllocator&);
50
51  public:
52 // Declaration of CASCADE RTTI
53 DEFINE_STANDARD_RTTI (NCollection_HeapAllocator)
54 };
55
56 // Definition of HANDLE object using Standard_DefineHandle.hxx
57 DEFINE_STANDARD_HANDLE (NCollection_HeapAllocator, NCollection_BaseAllocator)
58
59 #endif