src/SMDS/SMDS_MapOfMeshElement.cdl

   1 --  SMESH SMDS : implementaion of Salome mesh data structure
   2 --
   3 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 --
   6 --  This library is free software; you can redistribute it and/or
   7 --  modify it under the terms of the GNU Lesser General Public
   8 --  License as published by the Free Software Foundation; either
   9 --  version 2.1 of the License.
  10 --
  11 --  This library is distributed in the hope that it will be useful,
  12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 --  Lesser General Public License for more details.
  15 --
  16 --  You should have received a copy of the GNU Lesser General Public
  17 --  License along with this library; if not, write to the Free Software
  18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 --
  20 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 --
  22 --
  23 --
  24 --  File   : SMDS_MapOfMeshElement.cdl
  25 --  Author : Jean-Michel BOULCOURT
  26 --  Module : SMESH
  27
  28 class MapOfMeshElement from SMDS inherits ExtendedMap from SMDS
  29
  30         ---Purpose:  Redefinition/definition  of methods of Map from TCollection
  31
  32 uses
  33     MeshElement from SMDS
  34
  35 raises
  36     NoSuchObject from Standard
  37
  38 is
  39     Create(NbBuckets : Integer =1) returns MapOfMeshElement from SMDS;
  40    ---Purpose: Creates   a Map with  <NbBuckets> buckets. Without
  41    --          arguments the map is automatically dimensioned.
  42    ---C++: inline
  43
  44     Find(me; K : MeshElement) returns MeshElement
  45         ---Level: Public
  46         ---Purpose: Returns  the Item stored  with the Key  <K> in the Map.
  47         ---Trigger: An exception is raised when <K> is not in the map.
  48     raises NoSuchObject from Standard
  49         ---C++: alias operator()
  50         ---C++: return const &
  51     is static;
  52
  53     ChangeFind(me : in out; K : MeshElement) returns MeshElement
  54         ---Level: Public
  55         ---Purpose: Returns the  Item stored with  the Key  <K> in the
  56         -- Map. This Item can be   modified with  the  syntax
  57         -- aMap(K) = newItem;
  58         ---Trigger: An exception is raised when <K> is not in the map.
  59         ---C++: alias operator()
  60         ---C++: return &
  61     raises NoSuchObject from Standard
  62     is static;
  63
  64     FindID(me; ID : Integer) returns MeshElement
  65         ---Level: Public
  66         ---Purpose: Returns  the Item stored  with the ID in the Map.
  67         ---Trigger: An exception is raised when ID is not in the map.
  68     raises NoSuchObject from Standard
  69         ---C++: alias operator()
  70         ---C++: return const &
  71     is static;
  72
  73
  74     ContainsID(me; ID : Integer) returns Boolean
  75         ---Level: Public
  76         ---Purpose: Returns True  if the ID is stored  in the
  77         -- map <me>.
  78     is static;
  79
  80 end MapOfMeshElement;