src/NCollection/NCollection_DefineDataMap.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:     The DataMap is a Map to store keys with associated
  17 //              Items. See Map  from NCollection for  a discussion
  18 //              about the number of buckets.
  19 //              The DataMap can be seen as an extended array where
  20 //              the Keys  are the   indices.  For this reason  the
  21 //              operator () is defined on DataMap to fetch an Item
  22 //              from a Key. So the following syntax can be used :
  23 //              anItem = aMap(aKey);
  24 //              aMap(aKey) = anItem;
  25 //              This analogy has its  limit.   aMap(aKey) = anItem
  26 //              can  be done only  if aKey was previously bound to
  27 //              an item in the map.
  28
  29 #ifndef NCollection_DefineDataMap_HeaderFile
  30 #define NCollection_DefineDataMap_HeaderFile
  31
  32 #include <NCollection_DataMap.hxx>
  33
  34 // *********************************************** Class DataMap *************
  35
  36 #define DEFINE_DATAMAP(_ClassName_, _BaseCollection_, TheKeyType, TheItemType) \
  37 typedef NCollection_DataMap<TheKeyType, TheItemType > _ClassName_;
  38
  39 #endif