src/TCollection/TCollection.hxx

   1 // Created on: 1992-10-13
   2 // Created by: Ramin BARRETO
   3 // Copyright (c) 1992-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _TCollection_HeaderFile
  18 #define _TCollection_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Integer.hxx>
  25 class TCollection_AsciiString;
  26 class TCollection_ExtendedString;
  27 class TCollection_HAsciiString;
  28 class TCollection_HExtendedString;
  29 class TCollection_Array1;
  30 class TCollection_HArray1;
  31 class TCollection_Array2;
  32 class TCollection_HArray2;
  33 class TCollection_List;
  34 class TCollection_ListNode;
  35 class TCollection_ListIterator;
  36 class TCollection_BaseSequence;
  37 class TCollection_SeqNode;
  38 class TCollection_Sequence;
  39 class TCollection_SequenceNode;
  40 class TCollection_HSequence;
  41 class TCollection_MapHasher;
  42 class TCollection_BasicMap;
  43 class TCollection_MapNode;
  44 class TCollection_BasicMapIterator;
  45 class TCollection_Map;
  46 class TCollection_MapIterator;
  47 class TCollection_StdMapNode;
  48 class TCollection_DataMap;
  49 class TCollection_DataMapIterator;
  50 class TCollection_DataMapNode;
  51 class TCollection_DoubleMap;
  52 class TCollection_DoubleMapIterator;
  53 class TCollection_DoubleMapNode;
  54 class TCollection_IndexedMap;
  55 class TCollection_IndexedMapNode;
  56 class TCollection_IndexedDataMap;
  57 class TCollection_IndexedDataMapNode;
  58
  59
  60 //! The package <TCollection> provides the services for the
  61 //! transient basic data structures.
  62 class TCollection
  63 {
  64 public:
  65
  66   DEFINE_STANDARD_ALLOC
  67
  68
  69   //! Returns a  prime number greater than  <I> suitable
  70   //! to dimension a Map.  When  <I> becomes great there
  71   //! is  a  limit on  the  result (today  the  limit is
  72   //! around 1 000 000). This is not a limit of the number of
  73   //! items but a limit in the number  of buckets.  i.e.
  74   //! there will be more collisions  in  the map.
  75   Standard_EXPORT static Standard_Integer NextPrimeForMap (const Standard_Integer I);
  76
  77
  78
  79
  80 protected:
  81
  82
  83
  84
  85
  86 private:
  87
  88
  89
  90
  91 friend class TCollection_AsciiString;
  92 friend class TCollection_ExtendedString;
  93 friend class TCollection_HAsciiString;
  94 friend class TCollection_HExtendedString;
  95 friend class TCollection_Array1;
  96 friend class TCollection_HArray1;
  97 friend class TCollection_Array2;
  98 friend class TCollection_HArray2;
  99 friend class TCollection_List;
 100 friend class TCollection_ListNode;
 101 friend class TCollection_ListIterator;
 102 friend class TCollection_BaseSequence;
 103 friend class TCollection_SeqNode;
 104 friend class TCollection_Sequence;
 105 friend class TCollection_SequenceNode;
 106 friend class TCollection_HSequence;
 107 friend class TCollection_MapHasher;
 108 friend class TCollection_BasicMap;
 109 friend class TCollection_MapNode;
 110 friend class TCollection_BasicMapIterator;
 111 friend class TCollection_Map;
 112 friend class TCollection_MapIterator;
 113 friend class TCollection_StdMapNode;
 114 friend class TCollection_DataMap;
 115 friend class TCollection_DataMapIterator;
 116 friend class TCollection_DataMapNode;
 117 friend class TCollection_DoubleMap;
 118 friend class TCollection_DoubleMapIterator;
 119 friend class TCollection_DoubleMapNode;
 120 friend class TCollection_IndexedMap;
 121 friend class TCollection_IndexedMapNode;
 122 friend class TCollection_IndexedDataMap;
 123 friend class TCollection_IndexedDataMapNode;
 124
 125 };
 126
 127
 128
 129
 130
 131
 132
 133 #endif // _TCollection_HeaderFile