src/NCollection/NCollection_DefineIndexedDataMap.hxx

   1 // Created on: 2002-04-24
   2 // Created by: Alexander KARTOMIN (akm)
   3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 // Purpose:     An indexed map is used  to store keys and to  bind
  17 //              an index to them.  Each  new key stored in the map
  18 //              gets an index.  Index are  incremented as keys are
  19 //              stored in the map. A key can be found by the index
  20 //              and an index by the key.  No  key but the last can
  21 //              be  removed so the  indices   are in the range 1..
  22 //              Extent.  An Item is stored with each key.
  23 //              This   class is   similar  to  IndexedMap     from
  24 //              NCollection  with the Item as  a new feature. Note
  25 //              the important difference on  the operator  ().  In
  26 //              the IndexedMap this operator returns  the Key.  In
  27 //              the IndexedDataMap this operator returns the Item.
  28 //              See  the  class   Map   from NCollection   for   a
  29 //              discussion about the number of buckets.
  30
  31 #ifndef NCollection_DefineIndexedDataMap_HeaderFile
  32 #define NCollection_DefineIndexedDataMap_HeaderFile
  33
  34 #include <NCollection_IndexedDataMap.hxx>
  35
  36 // *********************************************** Class IndexedDataMap ******
  37
  38 #define DEFINE_INDEXEDDATAMAP(_ClassName_, _BaseCollection_, TheKeyType, TheItemType) \
  39 typedef NCollection_IndexedDataMap <TheKeyType, TheItemType > _ClassName_;
  40
  41 #endif